获取域名验证要求--证书中心-火山引擎

文档中心

立即注册

导航

获取域名验证要求

最近更新时间：2024.06.24 15:32:01首次发布时间：2023.10.19 10:52:38

调用本接口获取完成域名所有权验证的具体要求。这些要求指导您完成必要的配置，以此证明您能够管理证书颁发给的域名。

注意事项

请求频率：同一个租户每秒最多允许请求20次。

请求说明

接口名称：CertificateGetDcvParam
请求方式：GET
请求地址：open.volcengineapi.com

调试

暂不支持。

请求参数

下方表格中的参数包含在请求头（header）中。

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`certificate_service`。	`certificate_service`

Query

下方表格中的参数包含在查询字符串（query string）中。

参数类型是否必选描述示例值

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

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

参数	类型	是否必选	描述	示例值
Action	string	是	API名称。该参数的取值是`CertificateGetDcvParam`。	`CertificateGetDcvParam`
Version	string	是	API版本。该参数的取值是`2021-06-01`。	`2021-06-01`
instance_id	String	是	指定证书实例的ID。您可以调用CertificateGetInstance接口获取所有证书实例的ID。	`cert-46d8415d27374dfc8ea6caab0141****`

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请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心