更新时间:2025-09-18 GMT+08:00
分享

查询凭据标签

功能介绍

查询凭据标签。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/csms/{secret_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

secret_id

String

凭据ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

tags

Array of TagItem objects

标签列表,key和value键值对的集合。

  • key:表示标签键,一个凭据下最多包含20个key,key不能为空,不能重复,同一个key中value不能重复。key最大长度为128个字符。

  • value:表示标签值。每个值最大长度255个字符,value之间为“与”的关系。

sys_tags

Array of SysTag objects

系统标签列表。

表4 TagItem

参数

参数类型

描述

key

String

标签的名称。

同一个凭据,一个标签键只能对应一个标签值;不同的凭据可以使用相同的标签键。

用户最多可以给单个凭据添加20个标签。

约束:取值范围为1到128个字符,满足正则匹配"^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$"

value

String

标签的值。

约束:取值范围不超过255个字符,满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"

表5 SysTag

参数

参数类型

描述

key

String

标签键。

value

String

标签值。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:401

表8 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:403

表10 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:404

表12 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表13 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:500

表14 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表15 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:502

表16 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表17 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码:504

表18 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表19 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

响应示例

状态码:200

请求已成功

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "sys_tags" : null
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在,资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码

相关文档