Querying HTTPS Configuration
Function
Queries the certificate configuration.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vod:domain:getHttpsSetting
Read
-
-
-
-
URI
GET /v1.0/{project_id}/asset/domain/https
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| domain | Yes | String | Domain name. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | No | String | User token. This parameter is mandatory when token authentication is used. 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. |
| Authorization | No | String | Authentication information. This parameter is mandatory for AK/SK authentication. |
| X-Sdk-Date | No | String | Time when a request is sent. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| source | String | Source. The value can be user (uploaded by the user) or scm (SCM certificate). |
| cert_name | String | Certificate name. |
| cert_id | String | Certificate ID. This parameter is available for SCM certificates. |
| https_status | Integer | HTTPS configuration. The value 0 indicates that HTTPS is disabled, and the value 1 indicates that HTTPS is enabled. |
| certificate | String | Certificate content. |
| force_redirect_https | Integer | Whether to enable forced redirection for client requests. The value 0 indicates that redirection is disabled, and the value 1 indicates that redirection is enabled. |
| http2 | Integer | Whether to use HTTP/2. The value 0 indicates that HTTP/2 is not used, and the value 1 indicates that HTTP/2 is used. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
None
Example Responses
Status code: 200
Returned when the request succeeded.
{
"source" : "scm",
"cert_name" : "scm-c50d95",
"cert_id" : "scs1773910301701",
"https_status" : 1,
"certificate" : "-----BEGIN CERTIFICATE-----xxxxxxxxxxxxxxxxx",
"force_redirect_https" : 0,
"http2" : 0
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Returned when the request succeeded. |
| 400 | Returned when the request failed. |
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