Querying the Certificate List by Tag
Function
Query the certificate list by tag.
URI
POST /v3/scm/{resource_instances}/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_instances |
Yes |
String |
Resource instance. The value is resource_instances. Minimum: 18 Maximum: 18 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
without_any_tag |
No |
Boolean |
If this parameter is set to true, all resources without tags are queried. In this case, the tags, tags_any, not_tags, and not_tags_any fields are not required.
|
tags |
No |
Array of ScsTag objects |
The list of tags. The resources to be queried contain tags specified in this field. Each resource can contain a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each key must be unique, and each value for a key must be unique. The response returns resources containing all the specified tags. Keys are in the AND relationship and values in each key-value structure are in the OR relationship. If this parameter is not specified, all resources will be returned. Array Length: 1 - 20 |
tags_any |
No |
Array of ScsTag objects |
The list of tags. The instances to be queried contain any tag listed in tags_any. Each instance to be queried contains a maximum of 20 keys. Each tag key has a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each key must be unique, and each value for a key must be unique. The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no filtering condition is specified, full data is returned. Array Length: 1 - 20 |
not_tags |
No |
Array of ScsTag objects |
The list of tags. The instances to be queried do not contain any tag listed in not_tags. Each instance to be queried contains a maximum of 20 keys. Each tag key has a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Keys must be unique and values of a key must be unique. The response returns instances containing no tag in this list. Keys are in the AND relationship and values in each key-value structure is in the OR relationship. If this parameter is not specified, all resources will be returned. Array Length: 1 - 20 |
not_tags_any |
No |
Array of ScsTag objects |
The list of tags. The instances to be queried do not contain all tags listed in not_tags_any. Each instance to be queried contains a maximum of 20 keys. Each tag key has a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each key must be unique, and each value for a key must be unique. The response returns resources containing no tag in this list. Keys in this list are in the OR relationship and values in each key-value structure are also in the OR relationship. If no tag filtering criteria is specified, full data is returned. Array Length: 1 - 20 |
limit |
No |
Integer |
Number of certificate records on each page. The options are as follows:
Minimum: 10 Maximum: 50 Default: 10 |
offset |
No |
Integer |
Specifies the offset. The query starts from the next piece of data indexed by this parameter. Minimum: 0 Default: 0 |
action |
No |
String |
Operation type. Possible values are as follows:
Minimum: 5 Maximum: 6 |
matches |
No |
Array of ScsMatch objects |
Search field. key indicates the field to be matched, for example, resource_name. value indicates the matched value. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys. Array Length: 0 - 10 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Tag key. It can contain UTF-8 letters, digits, spaces, and the following characters: _ . : = + - @ Minimum: 1 Maximum: 128 |
values |
No |
Array of strings |
Tag values. It can contain UTF-8 letters, digits, spaces, and the following special characters: _ . : = + - @ Minimum: 0 Maximum: 255 Array Length: 1 - 20 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Tag key. It can contain UTF-8 letters, digits, spaces, and the following characters: _ . : = + - @ Minimum: 1 Maximum: 128 |
value |
No |
String |
Tag value. It can contain UTF-8 letters, digits, spaces, and the following characters: _ . : / = + - @ Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Total number of records Minimum: 0 Maximum: 100 |
resources |
Array of TagResource objects |
Resource instance list. For details, see the data structure description of the TagResource field. Array Length: 0 - 100 |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Whether the certificate can be unsubscribed. Minimum: 0 Maximum: 63 |
tags |
Array of ScsResourceTag objects |
Resource ID of the certificate. Array Length: 0 - 100 |
resource_name |
String |
Number of wildcard domain names. Minimum: 0 Maximum: 63 |
resource_detail |
resource_detail object |
Certificate resource details. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. Minimum: 0 Maximum: 128 |
value |
String |
Tag value. Minimum: 0 Maximum: 255 |
Parameter |
Type |
Description |
---|---|---|
cert_id |
String |
Certificate ID. Minimum: 16 Maximum: 16 |
cert_name |
String |
Certificate name. The value contains 3 to 63 characters. Minimum: 3 Maximum: 63 |
domain |
String |
Domain name bound to a certificate.
Example: www.example.com Minimum: 0 Maximum: 255 |
cert_type |
String |
Certificate type.
Minimum: 0 Maximum: 32 |
cert_brand |
String |
Certificate authority. GLOBALSIGN Minimum: 0 Maximum: 32 |
domain_type |
String |
Zone type.
Minimum: 0 Maximum: 32 |
purchase_period |
Integer |
Certificate validity period, in years. Minimum: 0 Maximum: 1000 |
expired_time |
String |
Certificate expiration time, which is a timestamp in milliseconds. Minimum: 0 Maximum: 32 |
order_status |
String |
Order status. Minimum: 0 Maximum: 32 |
domain_num |
Integer |
Number of domain names.
Minimum: 1 Maximum: 250 |
wildcard_number |
Integer |
Specifies the list of queried tags. If no tag is matched, an empty array is returned. Minimum: 1 Maximum: 100 |
sans |
String |
Resource name. This parameter is an empty string by default. Minimum: 0 Maximum: 4096 |
cert_des |
String |
Certificate description. Minimum: 0 Maximum: 32 |
signature_algorithm |
String |
Additional domain name associated with the certificate Minimum: 0 Maximum: 32 |
fail_reason |
String |
Failure cause. Minimum: 0 Maximum: 255 |
partner_order_id |
String |
Sequence number of an order. Minimum: 0 Maximum: 63 |
push_support |
Boolean |
Whether a certificate can be pushed. |
cert_issued_time |
String |
Time when a certificate is issued, in milliseconds. Minimum: 0 Maximum: 32 |
resource_id |
String |
Resource ID. Minimum: 0 Maximum: 63 |
unsubscribe_support |
Boolean |
Signature algorithm |
origin_cert_id |
String |
Initial certificate ID. Minimum: 0 Maximum: 63 |
renewal_cert_id |
String |
ID of the certificate to be renewed. Minimum: 0 Maximum: 63 |
auto_renew_status |
Integer |
Auto-renewal status. Minimum: 0 Maximum: 100 |
remain_cert_number |
Integer |
Number of remaining valid certificates. Minimum: 0 Maximum: 100 |
auto_deploy_support |
Boolean |
Whether the certificate supports automatic deployment. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Example Requests
{ "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
Example Responses
Status code: 200
Normal response.
{ "total_count" : 1, "resources" : [ { "resource_id" : "scs1664525717891" }, { "resource_detail" : [ { "cert_id" : "scs1664525717891", "cert_name" : "scm-e409cb", "auto_deploy_support" : false, "auto_renew_status" : 0, "cert_brand" : "CFCA", "cert_created_time" : null, "cert_des" : null, "cert_issued_time" : 1664528641000, "cert_type" : "OV_SSL_CERT", "domain" : "www.cfca.com", "domain_num" : 6, "domain_type" : "MULTI_DOMAIN", "enterprise_project_id" : "7c0b1c33-491f-4b87-914a-bb708815b51a", "expired_time" : 1696064641000, "fail_reason" : null, "multi_domain_type" : null, "order_status" : "ISSUED", "origin_cert_id" : null, "partner_order_id" : "TA1664528570549_0573", "purchase_period" : 1, "push_support" : false, "remain_cert_number" : 0, "renewal_cert_id" : null, "resource_id" : null, "sans" : "www.test.com;*.test1.com;*.test2.com;www.test3.com;www.test4.com", "signature_algorithm" : null, "unsubscribe_support" : false, "wildcard_number" : 2 } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] }, { "resource_name" : "scm-e409cb" } ] }
Status code: 401
Authentication failed.
{ "error_code" : "SCM.XXX", "error_msg" : "XXX" }
Status code: 403
Access denied.
{ "error_code" : "SCM.XXX", "error_msg" : "XXX" }
Status code: 500
Failed to complete the request because of an internal server error.
{ "error_code" : "SCM.XXX", "error_msg" : "XXX" }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
Access page not found. |
500 |
Failed to complete the request because of an internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot