文档首页/ 云证书管理服务 CCM/ API参考/ API说明/ 管理私有证书/ 标签管理/ 根据标签查询证书列表
更新时间：2024-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据标签查询证书列表

功能介绍

根据标签查询证书列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/private-certificates/resource-instances/filter

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：32

最大长度：2097152
表2 请求Body参数

参数

是否必选

参数类型

描述

tags

否

Array of DomainTags objects

标签列表。 最多包含20个key，每个key下面的value最多20个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。

数组长度：1 - 20

limit

否

Integer

每页条目数量，取值如下：

  • 10：每页显示10条资源信息。
  • 20：每页显示20条资源信息。
  • 50：每页显示50条资源信息。

最小值：10

最大值：50

缺省值：10

offset

否

Integer

索引位置，偏移量，从offset指定的下一条数据开始查询。

最小值：0

缺省值：0

matches

否

Array of ResourceTag objects

搜索字段。 key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。

数组长度：0 - 20
表3 DomainTags

参数

是否必选

参数类型

描述

key

是

String

标签键。可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @

最小长度：1

最大长度：128

values

是

Array of strings

标签值列表。每个值可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @

最小长度：0

最大长度：255

数组长度：1 - 20
表4 ResourceTag

参数

是否必选

参数类型

描述

key

是

String

标签键。可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @

最小长度：1

最大长度：128

value

是

String

标签值。可用UTF-8格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : / = + - @

最小长度：0

最大长度：255

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

total_count

Integer

总记录数。

最小值：0

最大值：100

resources

Array of TagResource objects

资源实例列表，详情请参见TagResource字段数据结构说明。

数组长度：0 - 100
表6 TagResource

参数

参数类型

描述

resource_id

String

资源ID。

最小长度：0

最大长度：63

resource_detail

Object

资源详情。

tags

Array of ResourceTag objects

标签列表，没有标签默认为空数组。

数组长度：0 - 100

resource_name

String

资源名称，默认为空字符串。

最小长度：0

最大长度：63
表7 ResourceTag

参数

参数类型

描述

key

String

标签键。 可用 UTF-8 格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : = + - @

最小长度：1

最大长度：128

value

String

标签值。 可用 UTF-8 格式表示的字母（包含中文、西班牙语、葡语等）、数字和空格，以及以下字符： _ . : / = + - @

最小长度：0

最大长度：255

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

请求示例

根据标签查询证书列表，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。

POST https://{Endpoint}/v1/private-certificates/resource-instances/filter

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

响应示例

状态码： 200

请求已成功

{
  "total_count" : 1,
  "resources" : [ {
    "resource_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67"
  }, {
    "resource_name" : "test"
  }, {
    "resource_detail" : [ {
      "certificate_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67",
      "create_time" : 1681436805000,
      "delete_time" : null,
      "distinguished_name" : {
        "country" : "CN",
        "state" : "guangdong",
        "locality" : "shenzhen",
        "organization" : "TestA",
        "organizational_unit" : "IT",
        "common_name" : "TestA IT Root CA"
      },
      "enc_cert_info" : null,
      "enterprise_project_id" : "0",
      "freeze_flag" : 0,
      "gen_mode" : "GENERATE",
      "issuer_id" : "93fcdaf2-c094-4f39-9cbc-bcacd0baac48",
      "issuer_name" : "test",
      "key_algorithm" : "RSA2048",
      "not_before" : 1681436805000,
      "not_after" : 1713059205000,
      "path_length" : 7,
      "serial_number" : "202203070322544291829058",
      "signature_algorithm" : "SHA256",
      "status" : "ISSUED"
    } ]
  }, {
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  } ]
}

状态码： 400

请求参数有误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 401

被请求的页面需要鉴权。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 403

认证失败。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 404

资源不存在或资源未找到。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 500

服务内部错误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误。

401

被请求的页面需要鉴权。

403

认证失败。

404

资源不存在或资源未找到。

500

服务内部错误。

错误码

请参见错误码。

父主题： 标签管理

相关文档