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

文档中心

立即注册

导航

CertificateGetDcvParam - 获取域名验证要求

最近更新时间：2025.11.17 16:17:11首次发布时间：2025.11.14 17:19:20

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	CertificateGetDcvParam	要执行的操作，取值：CertificateGetDcvParam。
Version	String	是	2024-10-01	API的版本，取值：2024-10-01。

Body

参数	类型	是否必填	示例值	描述
InstanceId	String	是	cert-46d8415d27374dfc8ea6caab0141****	指定证书实例的ID。您可以调用CertificateGetInstanceList接口获取所有证书实例的ID。

返回参数

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

参数	类型	示例值	描述
ValidationType	String	dns_txt	域名所有权的验证方式。该参数有以下取值： `dns_cname`：DNS验证（基于CNAME记录）。 `dns_txt`：DNS验证（基于TXT记录）。 `https`：文件验证（基于HTTPS请求）。 `http`：文件验证（基于HTTP请求）。
DomainsToBeValidated	Array of Object	-	验证的具体要求。

请求示例

POST /?Action=CertificateGetDcvParam&Version=2024-10-01 HTTP/1.1
Host: certificate-service.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251114T090424Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251114/cn-beijing/certificate_service/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "InstanceId": "cert-46d8415d27374dfc8ea6caab0141****"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251114170428186047190023284C48",
    "Action": "CertificateGetDcvParam",
    "Version": "2024-10-01",
    "Service": "certificate_service",
    "Region": "cn-beijing"
  },
  "Result": {
    "ValidationType": "dns_txt",
    "DomainsToBeValidated": [
      {
        "ValidationDomain": "_dnsauth.example.com",
        "Value": "2024iabf9qriabfiadnaiowh"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	MalformedRequest	The request is malformed	请求参数格式不合法。
400	MissingParameter	The required parameter %s is missing.	缺少必填参数。
400	NotFound.CertificateInstance	The specified certificate was not found.	未找到指定的证书
500	InternalError	The request has failed due to an unknown error.	未知错误。