Configuring HTTPS

Function

Configures HTTPS certificates for domain names.

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:modifyHttpsSetting

Write

-

-

-

scm:cert:export

scm:cert:get

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vod:domain:modifyHttpsSetting	Write	-	-	-	scm:cert:export scm:cert:get

URI

PUT /v1.0/{project_id}/asset/domain/https

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
source	No	String	Source. The value can be user (uploaded by the user) or scm (SCM certificate). The default value is user.
domain	Yes	String	Acceleration domain name, which is restricted by the domain name length of Huawei Cloud CDN.
cert_name	No	String	Certificate name. This parameter is optional for SCM certificates. If it is left blank, the certificate name on SCM is used by default. If it is specified, the name must contain at least three characters.
cert_id	No	String	SCM certificate ID. This parameter is mandatory for SCM certificates. The ID contains 16 characters.
https_status	No	Integer	HTTPS configuration. The value 0 indicates that HTTPS is disabled, and the value 1 indicates that HTTPS is enabled. The default value is 0.
certificate	No	String	Certificate content. This parameter is mandatory if the certificate source is set to user. This parameter is optional if the certificate source is set to scm.
private_key	No	String	Private key. This parameter is mandatory if the certificate source is set to user. This parameter is optional if the certificate source is set to scm.
force_redirect_https	No	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. If this parameter is not specified, the default value 0 is used.
http2	No	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. If this parameter is not specified, the default value 0 is used.

Response Parameters

Status code: 200

Returned when the request succeeded.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

PUT https://{endpoint}/v1.0/{project_id}/asset/domain/https

{
  "domain" : "vodtest203.cn-north-7.transcodeonline.com",
  "cert_name" : "203-0601test",
  "https_status" : 1,
  "private_key" : "xxx",
  "certificate" : "xxxx"
}