配置HTTPS - UpdateHttpsConfig
功能介绍
点播提供给域名配置HTTPS证书的接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
vod:domain:modifyHttpsSetting
Write
-
-
-
- scm:cert:export
- scm:cert:get
URI
PUT /v1.0/{project_id}/asset/domain/https
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选,携带的鉴权信息。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选,请求的发生时间。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| source | 否 | String | 来源,user表示用户自己上传,scm表示scm证书,默认user |
| domain | 是 | String | 加速域名,受限于华为云CDN域名长度约束 |
| cert_name | 否 | String | 证书名称,若来源是scm则非必填,不填默认取scm上的证书名称,若不为空,最少长度为3字符 |
| cert_id | 否 | String | scm证书ID,若来源是scm则必填,scm的证书ID长度为16位字符 |
| https_status | 否 | Integer | https配置,0为关闭https配置,1为开启https配置,默认0 |
| certificate | 否 | String | 证书内容,若来源是user则需填写,来源是scm则非必填 |
| private_key | 否 | String | 私钥,若来源是user则需填写,来源是scm则非必填 |
| force_redirect_https | 否 | Integer | 客户端请求是否强制重定向,0表示不重定向,1表示重定向,不传取默认0 |
| http2 | 否 | Integer | 是否使用HTTP2.0,0表示不使用HTTP2.0,1表示使用,不传取默认0 |
响应参数
状态码:200
处理成功返回。
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
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"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 处理成功返回。 |
| 400 | 处理失败返回。 |
错误码
请参见错误码。