You need to enable JavaScript to run this app.
导航
获取域名验证要求
最近更新时间:2024.04.19 16:37:27首次发布时间:2023.10.19 10:52:38

API说明

API名称:CertificateGetDcvParam
API域名:open.volcengineapi.com
API描述:调用本接口获取完成域名所有权验证的具体要求。这些要求指导您完成必要的配置,以此证明您能够管理证书颁发给的域名。

请求方法

GET

使用限制

QPS 限制:同一个租户每秒最多允许请求20次。

公共参数

下方表格中的公共参数必须包含在请求头(header)中。

参数名称

数据类型

是否必选

参数说明

Region

String

服务地区。该参数的取值是cn-north-1

ServiceName

String

服务名称。该参数的取值是certificate_service

下方表格中的公共参数必须包含在查询字符串(query string)中。

参数名称

数据类型

是否必选

参数说明

Action

String

API名称。该参数的取值是CertificateGetDcvParam

Version

String

API版本。该参数的取值是2021-06-01

请求参数

下方表格中参数的类型是查询参数。

参数名称

数据类型

是否必选

参数说明

示例

instance_id

String

指定证书实例的ID。

您可以调用CertificateGetInstance接口获取所有证书实例的ID。

cert-46d8415d27374dfc8ea6caab0141****

响应正文

参数名称
参数类型
参数说明
示例
validation_type
String
域名所有权的验证方式。该参数有以下取值:
  • dns_cname:DNS验证(基于CNAME记录)。
  • dns_txt:DNS验证(基于TXT记录)。
  • https:文件验证(基于HTTPS请求)。
  • http:文件验证(基于HTTP请求)。
dns_txt
domains_to_be_validated
Array
验证的具体要求。

示例

请求示例

GET https://open.volcengineapi.com/?Action=CertificateGetDcvParam&Version=2021-06-01&instance_id=cert-46d8415d27374dfc8ea6caab0141****&<其他公共请求参数>

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202310121412187CC4CCCF38F87E984021",
        "Action": "CertificateGetDcvParam",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": {
        "validation_type": "dns_txt",
        "domains_to_be_validated": [
            {
                "validation_domain": "_dnsauth.exmple.com",
                "value": "20kk20xx9ny66cw6qr82nqd4f1m388b3"
            }
        ]
    }
}

错误代码

如果响应正文的ResponseMetadata字段中包含Error字段,则表示API请求失败。关于更多错误码的信息,参见错误码说明