DescCertificate - 查询域名关联证书--DDoS防护-火山引擎

文档中心

立即注册

导航

DescCertificate - 查询域名关联证书

最近更新时间：2024.05.29 11:03:22首次发布时间：2024.05.20 21:52:15

根据域名信息查询关联的证书详情，也可以查询账号下所有证书信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescCertificate&Version=2021-06-15

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescCertificate	要执行的操作，取值：DescCertificate。
Version	String	是	2021-06-15	API的版本，取值：2021-06-15。
Domain	String	否	www.test.com	防护域名，不填则查询所有防护域名关联的证书。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Count	Integer	10	查询到的证书数量。
RecommendCertList	Array of Cert	--	推荐证书列表，可防护当前选定域名的证书。
OtherCertList	Array of Cert	--	除推荐证书外的其他证书列表。

请求示例

GET /?Action=DescCertificate&Domain=www.test.com&Version=2021-06-15 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240513T135911Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240513/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240513215921119228217066AC****",
    "Action": "DescCertificate",
    "Version": "2021-06-15",
    "Service": "AdvDefence",
    "Region": "cn-beijing"
  },
  "Result": {
    "Count": 2,
    "RecommendCertList": [
      {
        "UserCertId": "cert-5ce57f81d29f420baa4348f6501f****",
        "Name": "cert1",
        "Hosts": [
          "www.test.com",
          "www.123.com"
        ]
      }
    ],
    "OtherCertList": [
      {
        "UserCertId": "cert-5ce57f81d29f420baa4348f6501f****",
        "Name": "cert2",
        "Hosts": [
          "www.abc.com",
          "www.321.com"
        ]
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	1	请求内容/参数错误，请检查请求内容/参数格式。	请求体校验失败。请求参数校验失败。
200	2	内部错误，请重试或联系服务提供者。	服务操作失败。
200	10	内部错误，请重试或联系服务提供者。	状态异常。