文档首页/ 视频直播 Live/ 云直播API参考/ HTTPS证书管理/ 修改指定域名的https证书配置
更新时间:2024-10-18 GMT+08:00

修改指定域名的https证书配置

功能介绍

修改指定域名的https证书配置

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/guard/https-cert

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

直播播放域名

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必填,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必填,携带项目ID信息。

表4 请求Body参数

参数

是否必选

参数类型

描述

certificate_format

String

证书格式,默认为PEM,当前只支持PEM格式

certificate

String

证书内容,若在tls_certificate有传值,则此字段无效

certificate_key

String

私钥内容,若在tls_certificate有传值,则此字段无效

force_redirect

Boolean

是否开启重定向,默认false

gm_certificate

GmCertificateInfo object

国密证书配置内容, 国际、国密需要至少配置一个证书

tls_certificate

TlsCertificateInfo object

国密证书配置内容。需要配置一个国际证书,或者一个国密证书,或者同时配置一个国密证书和一个国际证书。若配置了当前字段,则忽略外层国际证书的同级配置字段“certificate”和“certificate_key”。

表5 GmCertificateInfo

参数

是否必选

参数类型

描述

source

String

证书来源, 可选, scm: 云证书管理服务,user:默认,用户自有

cert_name

String

SCM证书名, 可选

cert_id

String

SCM证书ID, 证书来源为scm时必选

sign_certificate

String

国密签名证书内容

sign_certificate_key

String

国密签名私钥内容

enc_certificate

String

国密加密证书内容

enc_certificate_key

String

国密加密私钥内容

表6 TlsCertificateInfo

参数

是否必选

参数类型

描述

source

String

证书来源, 可选, scm: 云证书管理服务,user:默认,用户自有

cert_name

String

SCM证书名, 证书来源为scm时可选

cert_id

String

SCM证书ID, 证书来源为scm时必选

certificate

String

证书内容,证书来源为user时必选

certificate_key

String

私钥内容,证书来源为user时必选

响应参数

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

修改指定域名的https证书配置。

PUT https://{endpoint}/v1/{project_id}/guard/https-cert?domain=play.example.huawei.com

{
  "certificate_format" : "PEM",
  "certificate" : "your cert",
  "certificate_key" : "your cert key",
  "force_redirect" : true
}

响应示例

状态码: 400

参数校验不通过。如:传入domain为空、证书校验不通过。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

状态码: 401

未授权访问接口

{
  "error_code" : "LIVE.100011003",
  "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions"
}

状态码: 404

访问资源不存在,如:域名不存在。

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "The resource to access is not exists"
}

状态码: 500

服务内部错误

{
  "error_code" : "LIVE.100011005",
  "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve"
}

SDK代码示例

SDK代码示例如下。

修改指定域名的https证书配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class UpdateDomainHttpsCertSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateDomainHttpsCertRequest request = new UpdateDomainHttpsCertRequest();
        DomainHttpsCertInfo body = new DomainHttpsCertInfo();
        body.withForceRedirect(true);
        body.withCertificateKey("your cert key");
        body.withCertificate("your cert");
        body.withCertificateFormat(DomainHttpsCertInfo.CertificateFormatEnum.fromValue("PEM"));
        request.withBody(body);
        try {
            UpdateDomainHttpsCertResponse response = client.updateDomainHttpsCert(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

修改指定域名的https证书配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateDomainHttpsCertRequest()
        request.body = DomainHttpsCertInfo(
            force_redirect=True,
            certificate_key="your cert key",
            certificate="your cert",
            certificate_format="PEM"
        )
        response = client.update_domain_https_cert(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

修改指定域名的https证书配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateDomainHttpsCertRequest{}
	forceRedirectDomainHttpsCertInfo:= true
	certificateKeyDomainHttpsCertInfo:= "your cert key"
	certificateDomainHttpsCertInfo:= "your cert"
	certificateFormatDomainHttpsCertInfo:= model.GetDomainHttpsCertInfoCertificateFormatEnum().PEM
	request.Body = &model.DomainHttpsCertInfo{
		ForceRedirect: &forceRedirectDomainHttpsCertInfo,
		CertificateKey: &certificateKeyDomainHttpsCertInfo,
		Certificate: &certificateDomainHttpsCertInfo,
		CertificateFormat: &certificateFormatDomainHttpsCertInfo,
	}
	response, err := client.UpdateDomainHttpsCert(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新成功

400

参数校验不通过。如:传入domain为空、证书校验不通过。

401

未授权访问接口

404

访问资源不存在,如:域名不存在。

500

服务内部错误

错误码

请参见错误码