Querying Domain Names of an SSL Certificate
Function
This API is used to query the domain names to which an SSL certificate has been bound.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/apigw/certificates/{certificate_id}/attached-domains
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a Project ID. |
certificate_id |
Yes |
String |
Certificate ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Long |
Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0 |
limit |
No |
Integer |
Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20 |
url_domain |
No |
String |
Independent domain name. |
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 a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
size |
Integer |
Length of the returned resource list. |
total |
Long |
Number of resources that match the query conditions. |
bound_domains |
Array of UrlDomainRefInfo objects |
Bound domain names. |
Parameter |
Type |
Description |
---|---|---|
url_domain |
String |
Custom domain name. |
id |
String |
Domain ID. |
status |
Integer |
CNAME resolution status.
|
min_ssl_version |
String |
Minimum SSL version supported. |
is_http_redirect_to_https |
Boolean |
Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false. Default: false |
verified_client_certificate_enabled |
Boolean |
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false |
ingress_http_port |
Integer |
Inbound HTTP port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 80. Other valid ports must be included in the HTTP inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 80 is used. If this parameter is set, https_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151 |
ingress_https_port |
Integer |
Inbound HTTPS port bound to the domain name. -1 indicates that no port is available and the protocol is not supported. In this case, you can use the default port 443. Other valid ports must be included in the HTTPS inbound ports of the gateway. The value ranges from 1024 to 49151. When creating a domain name, if this parameter is not set, the default port 443 is used. If this parameter is set, http_port must be set. If both http_port and https_port need to use the default port, leave both parameters blank. If this parameter is not specified when you modify the domain name, the port number remains unchanged. Minimum: -1 Maximum: 49151 |
ssl_id |
String |
Certificate ID. |
ssl_name |
String |
Certificate name. |
api_group_id |
String |
API group ID. |
api_group_name |
String |
API group name. |
instance_id |
String |
Gateway ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "total" : 1, "size" : 1, "bound_domains" : [ { "id" : "b9be707660c5406394f8973e087bae20", "url_domain" : "apigtest.example.com", "status" : 3, "min_ssl_version" : "TLSv1.1", "ssl_id" : "a27be832f2e9441c8127fe48e3b5ac67", "ssl_name" : "cert_demo", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "api_group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "api_group_name" : "default" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:dict_name. Please refer to the support documentation" }
Status code: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Status code: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
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