Credential

创建 Credential

在密钥库中创建密钥

POST

/api/v1/agentstudio/vaults/{vault_id}/credentials

cURL

curl --request POST \
  --url 'https://dashscope.aliyuncs.com/api/v1/agentstudio/vaults/{vault_id}/credentials' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "secret_value": "sk-xxxx",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  }
}
'

{
  "id": "cred_xxx",
  "type": "credential",
  "vault_id": "vlt_xxx",
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-10T08:00:00Z",
  "request_id": "req_xxx"
}

鉴权

string

header

必填

DashScope API Key

路径参数

string

必填

Vault ID，格式 vlt_xxx

请求体

application/json

object

必填

认证信息，固定为 environment_variable 类型。

显示子属性

enum<string>

必填

固定为 environment_variable

可选值：environment_variable

string

必填

环境变量名称，创建后不可修改

string

必填

环境变量值，仅写入时传入，响应中不返回

object

必填

网络策略，限制只有发往指定域名的请求才会被替换为真实密钥

显示子属性

string[]

必填

允许替换真实密钥的域名列表，支持 *.example.com 通配子域，最多 10 个。填 * 对全部域名生效

示例:

[
  "api.example.com",
  "*.example.com"
]

取值范围：items <= 10

object

必填

替换位置，标识密钥写入请求的位置。当前仅支持 Authorization 请求头，写入请求体暂不支持

显示子属性

boolean

是否写入 Authorization 请求头（Bearer 格式）

string

Credential 可读名称，最大 255 字符

object

业务自定义键值对元数据

响应

200-application/json

string

Credential ID，格式 cred_xxx

string

固定为 credential

string

所属 Vault ID

string

Credential 可读名称

object

认证信息，敏感值已脱敏（如 secret_value 不返回）。

显示子属性

enum<string>

认证类型，当前仅支持 environment_variable

可选值：environment_variable

string

环境变量名称

object

网络策略

显示子属性

string[]

允许替换真实密钥的域名列表

object

替换位置。当前仅支持 Authorization 请求头，写入请求体暂不支持

显示子属性

boolean

object

业务自定义键值对

string | null

归档时间，未归档时为 null

string

创建时间，ISO 8601

string

最近更新时间，ISO 8601

string

请求唯一标识

cURL

curl --request POST \
  --url 'https://dashscope.aliyuncs.com/api/v1/agentstudio/vaults/{vault_id}/credentials' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "secret_value": "sk-xxxx",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  }
}
'

{
  "id": "cred_xxx",
  "type": "credential",
  "vault_id": "vlt_xxx",
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-10T08:00:00Z",
  "request_id": "req_xxx"
}