# 查询指定域名的https证书配置 - ShowDomainHttpsCert #### 功能介绍 查询指定域名的https证书配置 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-live/live_03_0001.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-live/live_03_0013.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | live:domain:getCDNConfig | Read | - | - | - | - | #### URI GET /v1/{project_id}/guard/https-cert 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 是 | String | **参数解释**： 直播播放域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | #### 请求参数 表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信息。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | certificate_format | String | **参数解释**： 证书格式 **取值范围**： - PEM | | certificate | String | **参数解释**： 证书内容 **取值范围**： 不涉及 | | certificate_key | String | **参数解释**： 私钥内容 **取值范围**： 不涉及 | | force_redirect | Boolean | **参数解释**： 是否开启重定向 **取值范围**： - true: 开启 - false: 关闭 | | gm_certificate | [GmCertificateInfo] object | **参数解释**： 国密证书配置内容 | | tls_certificate | [TlsCertificateInfo] object | **参数解释**： 国密证书配置内容 | 表5GmCertificateInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source | String | **参数解释**： 证书来源 **取值范围**： - scm：云证书与管理服务CCM。 - user：用户自有证书，为默认值。 | | cert_name | String | **参数解释**： SCM证书名， 可选 **取值范围**： 字符长度为\[0,128\]位 | | cert_id | String | **参数解释**： SCM证书ID, 证书来源为scm时必选 **取值范围**： 字符长度为\[0,128\]位 | | sign_certificate | String | **参数解释**： 国密签名证书内容 **取值范围**： 字符长度为\[0,12288\]位 | | sign_certificate_key | String | **参数解释**： 国密签名私钥内容 **取值范围**： 字符长度为\[0,8096\]位 | | enc_certificate | String | **参数解释**： 国密加密证书内容 **取值范围**： 字符长度为\[0,12288\]位 | | enc_certificate_key | String | **参数解释**： 国密加密私钥内容 **取值范围**： 字符长度为\[0,8096\]位 | 表6TlsCertificateInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source | String | **参数解释**： 证书来源。 **取值范围**： - scm：云证书与管理服务CCM。 - user：用户自有证书，为默认值。 字符长度为\[0,128\]位 | | cert_name | String | **参数解释**： SCM证书名。 **取值范围**： 字符长度为\[0,128\]位 | | cert_id | String | **参数解释**： SCM证书ID。 **取值范围**： 字符长度为\[0,128\]位 | | certificate | String | **参数解释**： 证书内容。 **取值范围**： 字符长度为\[0,12288\]位 | | certificate_key | String | **参数解释**： 私钥内容。 **取值范围**： 字符长度为\[0,8096\]位 | **状态码：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证书配置。 ``` GET https://{endpoint}/v1/{project_id}/guard/https-cert?domain=play.example.huawei.com ``` #### 响应示例 **状态码：200** 查询成功。 注意：不返回certificate_key内容，其值为空 ``` { "certificate_format" : "PEM", "certificate" : "", "certificate_key" : "", "force_redirect" : false } ``` **状态码：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代码示例如下。 - [Java] ``` 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 ShowDomainHttpsCertSolution { 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("")) .build(); ShowDomainHttpsCertRequest request = new ShowDomainHttpsCertRequest(); try { ShowDomainHttpsCertResponse response = client.showDomainHttpsCert(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowDomainHttpsCertRequest() response = client.show_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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := live.LiveClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := live.NewLiveClient(hcClient) request := &model.ShowDomainHttpsCertRequest{} response, err := client.ShowDomainHttpsCert(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Live/sdk?api=ShowDomainHttpsCert)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 注意：不返回certificate_key内容，其值为空 | | 400 | 参数校验不通过。如：传入domain为空、证书校验不通过。 | | 401 | 未授权访问接口 | | 404 | 访问资源不存在，如：域名不存在。 | | 500 | 服务内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。