Querying the List of Certificates
Function
This API is used to query the list of certificates.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/waf/certificate
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range Enter 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
items |
Array of CertificateBody objects |
Certificates |
total |
Integer |
Total number of certificates |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Certificate ID. Range N/A |
name |
String |
Definition Certificate name. Range N/A |
expire_time |
Long |
Definition Timestamp when the certificate expires. Range N/A |
exp_status |
Integer |
Definition Certificate expiration status. Range |
timestamp |
Long |
Definition Certificate upload timestamp. Range 13-bit millisecond timestamp. |
bind_host |
Array of BindHost objects |
Domain name associated with the certificate |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Domain name ID. Constraints N/A Range N/A Default Value N/A |
hostname |
String |
Definition Domain name. Constraints N/A Range N/A Default Value N/A |
waf_type |
String |
Definition Domain name mode. The value can be cloud for cloud mode or premium for dedicated mode. Constraints N/A Range Default Value N/A |
mode |
String |
Definition This parameter is required only by the dedicated mode. Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Example Requests
The following example shows how to query the certificate list in a project. The project ID is specified by project_id.
GET https://{Endpoint}/v1/{project_id}/waf/certificate?enterprise_project_id=0
Example Responses
Status code: 200
OK
{ "total" : 1, "items" : [ { "id" : "dc443ca4f29c4f7e8d4adaf485be317b", "name" : "demo", "timestamp" : 1643181401751, "expire_time" : 1650794100000, "bind_host" : [ ], "exp_status" : 2 } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
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