HTTPS 域名列表查询

最近更新时间:2018-12-25 10:48:14

接口描述

本接口( GetDsaHttpsHostList )用于查询账号下所有开启 HTTPS 加速功能的域名列表。
接口请求域名:dsa.api.qcloud.com

注意:

该接口调用频次上限为100次/分钟,超出上限则会返回错误,请勿高频调用。

输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为GetDsaHttpsHostList

参数 必选 类型 描述
offset Unsigned 偏移长度,默认0,表示不偏移
length Unsigned 最大长度,默认3000,表示最多返回3000个域名信息

注意:

  1. 该接口每次最多可查询3000个域名信息。
  2. 当查询的域名较多时,可以利用 offset 和 length 进行分页查询。

输出参数

参数 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详情请参见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关
codeDesc String 英文错误信息,或业务侧错误码
data Object 结果数据,详细说明见下文

data 字段说明

参数 类型 描述
hosts array 域名 HTTPS 配置信息,详情请参见下文 hosts 字段说明
total Unsigned 开启 HTTPS 加速功能的域名总数量

hosts 字段说明

参数 类型 描述
host_id Int 域名接入 DSA 后的标识 ID
host String 加速域名
Https Object HTTPS 配置信息,详情情参见下文 HTTPS 字段说明

HTTPS 字段说明

参数 类型 描述
type Unsigned HTTPS 开关
0:表示关闭
2:表示启用,并且采用 HTTP 回源
4:表示启用,并采用协议跟随回源
cert_id String 腾讯云托管证书 ID,当使用腾讯云托管证书时返回此参数
cn String 证书域名
expire String SSL 证书过期时间
message String 证书备注信息
http2 String HTTP 2.0开关
on:表示开启
off:表示关闭
redirection String HTTPS 强制跳转开关
on:表示开启
off:表示关闭

注意:

当开启 HTTPS 强制跳转功能时,DSA 加速节点会强迫客户端将 HTTP 请求重定向成 HTTPS 请求。

示例代码

配置需求示例

获取该账户下所有开启 HTTPS 加速功能的域名列表。

GET 请求

https://dsa.api.qcloud.com/v2/index.php?
Action=GetDsaHttpsHostList   
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX   
&Timestamp=1462440051   
&Nonce=123456789   
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX 

POST 请求

POST 请求时,参数填充在 HTTP Request-body 中,请求地址:

https://dsa.api.qcloud.com/v2/index.php  

参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:

array (
  'Action' => 'GetDsaHttpsHostList',
  'SecretId' => 'SecretId',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'Signature'
)

返回结果示例

查询成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "hosts": [{
                "host_id": "******",
                "host": "dsatest1.qcloud.com",
                "https": {
                    "type": "2",
                    "cert_id": "K9FAhubv",
                    "message": "",
                    "cn": "*.qcloud.com",
                    "expire": "2018-08-24 07:59:59"
                }
            },
            {
                "host_id": "******",
                "host": "dsatest2.qcloud.com",
                "https": {
                    "type": "4",
                    "cert_id": "K9FAhubv",
                    "message": "",
                    "cn": "*.qcloud.com",
                    "expire": "2018-08-24 07:59:59"
                }
            },
            {
                "host_id": "******",
                "host": "dsatest3.elliotxing.com",
                "https": {
                    "type": "4",
                    "message": "",
                    "cn": "*.elliotxing.com",
                    "expire": "2018-08-24 07:59:59"
                }
            }
        ],
        "total": 3
    }
}

查询失败

{
    "code": 4100,
    "message": "鉴权失败,请参考文档中鉴权部分。",
    "codeDesc": "AuthFailure"
}