查询所有绑定HTTPS证书的域名信息
功能介绍
查询账号中已配置HTTPS证书的域名及证书信息。
-
单租户调用频率:15次/s。
调用方法
请参见如何调用API。
URI
GET /v1.0/cdn/domains/https-certificate-info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_size |
否 |
Integer |
参数解释: 分页查询时每页的数量 约束限制: 不涉及 取值范围: 1-10000 默认取值: 不涉及 30 |
page_number |
否 |
Integer |
参数解释: 分页查询时的页码 约束限制: 不涉及 取值范围: 1-65535 默认取值: 1 |
domain_name |
否 |
String |
参数解释: 加速域名 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_domain_id |
否 |
String |
参数解释: 域名所属用户的账号ID,可前往CDN接口文档附录获取账号ID章节查看如何获取该参数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
enterprise_project_id |
否 |
String |
参数解释: 企业项目id。您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id 约束限制: 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户鉴权Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
查询结果总数 |
https |
Array of HttpsDetail objects |
https配置。 |
参数 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
域名id。 |
domain_name |
String |
绑定该证书的域名。 |
cert_name |
String |
证书名字。 |
certificate |
String |
证书内容。 |
private_key |
String |
私钥内容。 |
certificate_type |
Integer |
证书类型,0:自有证书,1:云托管证书,2:SCM证书。 |
expiration_time |
Long |
证书过期时间。 |
https_status |
Integer |
HTTPS证书是否启用,取值0:不启用;1:启用HTTPS加速并协议跟随回源;2:启用HTTPS加速并HTTP回源。 |
force_redirect_https |
Integer |
客户端请求是否强制重定向。1是,0否。(如果为2,表示强制跳转HTTP) |
force_redirect_config |
ForceRedirect object |
参数解释: 强制客户端使用HTTPS协议访问CDN节点 约束限制: 不涉及 |
http2 |
Integer |
是否使用HTTP2.0。(1是,0否。) |
请求示例
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains/https-certificate-info?domain_name=www.example.com&page_size=10&page_number=1
响应示例
状态码:200
OK
{ "total" : 1, "https" : [ { "https_status" : 1, "force_redirect_https" : 2, "force_redirect_config" : { "redirect_type" : "http", "switch" : 1 }, "http2" : 0, "cert_name" : "cdn_test", "certificate" : "-----BEGIN CERTIFICATE-----XX-----END CERTIFICATE-----", "private_key" : null, "certificate_type" : 0, "expiration_time" : 1606187416000, "domain_id" : "3e****************************63", "domain_name" : "www.example.com" } ] }
SDK代码示例
SDK代码示例如下。
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cdn.v2.region.CdnRegion; import com.huaweicloud.sdk.cdn.v2.*; import com.huaweicloud.sdk.cdn.v2.model.*; public class ShowCertificatesHttpsInfoSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CdnClient client = CdnClient.newBuilder() .withCredential(auth) .withRegion(CdnRegion.valueOf("<YOUR REGION>")) .build(); ShowCertificatesHttpsInfoRequest request = new ShowCertificatesHttpsInfoRequest(); try { ShowCertificatesHttpsInfoResponse response = client.showCertificatesHttpsInfo(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdn.v2 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"] credentials = GlobalCredentials(ak, sk) client = CdnClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdnRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowCertificatesHttpsInfoRequest() response = client.show_certificates_https_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cdn.NewCdnClient( cdn.CdnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowCertificatesHttpsInfoRequest{} response, err := client.ShowCertificatesHttpsInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。