根据标签查询证书列表 - ListCertResourceInstances
功能介绍
根据标签查询证书列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/private-certificates/resource-instances/filter
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token,参见:IAM token获取方法。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tags |
否 |
Array of DomainTags objects |
标签列表。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
|
limit |
否 |
Integer |
每页条目数量,取值如下: |
|
offset |
否 |
Integer |
索引位置,偏移量,从offset指定的下一条数据开始查询。 |
|
matches |
否 |
Array of ResourceTag objects |
搜索字段。 key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
总记录数。 |
|
resources |
Array of TagResource objects |
资源实例列表,详情请参见TagResource字段数据结构说明。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID。 |
|
resource_detail |
Object |
资源详情。 |
|
tags |
Array of ResourceTag objects |
标签列表,没有标签默认为空数组。 |
|
resource_name |
String |
资源名称,默认为空字符串。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ |
|
value |
String |
标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
请求示例
根据标签查询证书列表,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。
POST https://ccm.cn-north-4.myhuaweicloud.com/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" : "Huawei",
"organizational_unit" : "IT",
"common_name" : "Huawei 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 |
服务内部错误。 |
错误码
请参见错误码。