Skip to main content

归档 Credential

归档指定 Credential。该接口是百炼扩展,没有恢复接口。

接口

POST /vaults/{vault_id}/credentials/{credential_id}/archive 路径相对 Base URL。每个请求携带 Authorization: Bearer $DASHSCOPE_API_KEY,认证方式见认证。

路径参数

vault_id string (必选)父 Vault ID,按不透明 ID 使用credential_id string (必选)Credential ID,按不透明 ID 使用本接口没有请求体。

请求示例

curl -sS -X POST "$BASE_URL/vaults/vlt_xxx/credentials/vcrd_xxx/archive" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

响应字段

200,返回归档后的 Credential:id stringCredential IDobject stringCredential 对象类型,固定为 vault.credentialvault_id string所属 Vault IDname string显示名称created_at integer创建时间,Unix 秒updated_at integer最近更新时间,Unix 秒metadata object元数据,字符串键值对;未设置时为 {}
type string认证类型,固定为 environment_variablesecret_name string环境变量名
type string网络访问类型,limited 或 unrestrictedallowed_hosts array允许的目标域名或 IPv4,仅 limited 时返回
响应不返回 archived_at、status、secret_value、密钥标识或 injection_location。归档后 Credential 仍可获取,默认列表同时包含 active 和 archived。没有恢复接口。归档 Vault 会级联归档其下 Credential。

响应示例

{
  "id": "vcrd_xxx",
  "object": "vault.credential",
  "vault_id": "vlt_xxx",
  "name": "crm-token",
  "created_at": 1793941200,
  "updated_at": 1793944800,
  "metadata": {"team": "support"},
  "auth": {
    "type": "environment_variable",
    "secret_name": "CRM_TOKEN",
    "networking": {
      "type": "limited",
      "allowed_hosts": ["api.example.com"]
    }
  }
}

错误码

错误响应结构见错误码。
HTTP 状态码错误类型 / 错误码解决方案
401authentication_error / invalid_api_key在请求头携带有效的 Authorization: Bearer $DASHSCOPE_API_KEY
404not_found_error / not_found_errorCredential 不存在、已删除、父归属不符或不属于当前工作空间
500server_error / server_error稍后重试;持续失败时提交工单并提供 x-request-id