检查域名验证配置--证书中心-火山引擎

文档中心

立即注册

导航

检查域名验证配置

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

调用本接口检查域名所有权验证的相关配置是否已完成。确认配置完成后，请耐心等待CA机构的审查。

使用说明

对于DV证书请求，一旦CA机构确认域名验证配置已完成，将在数小时内为您签发证书。
对于OV和EV证书请求，当CA机构确认域名验证配置完成后，将开始进行组织验证。组织验证过程中需要您的企业相关人员配合接听电话。如需了解更详细的信息，请参见组织验证。通常，OV和EV证书的签发需要3个工作日或更长时间。

注意事项

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

请求说明

接口名称：CertificateCheckInstanceDCVStatus
请求方式：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名称。该参数的取值是CertificateCheckInstanceDCVStatus。 CertificateCheckInstanceDCVStatus

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

参数	类型	是否必选	描述	示例值
Action	string	是	API名称。该参数的取值是`CertificateCheckInstanceDCVStatus`。	`CertificateCheckInstanceDCVStatus`
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****

返回参数

参数类型描述示例值

参数	类型	描述	示例值
Result	Boolean	域名所有权验证的相关配置是否已完成。该参数有以下取值： `true`：表示配置已完成。 `false`：表示系统未检测到相关配置。这可能出于以下两种情况：配置尚未完成或者配置存在错误。建议您检查所做的配置。更多信息，请参见域名验证。配置已完成且无误，但是并未立即生效。由于DNS查询结果会被本地计算机缓存，DNS设置修改后需要一段时间才能在所有DNS查询中生效。您可以稍后再试。	`true`

Result

Boolean

域名所有权验证的相关配置是否已完成。该参数有以下取值：

true：表示配置已完成。
false：表示系统未检测到相关配置。这可能出于以下两种情况：
- 配置尚未完成或者配置存在错误。建议您检查所做的配置。更多信息，请参见域名验证。
- 配置已完成且无误，但是并未立即生效。由于DNS查询结果会被本地计算机缓存，DNS设置修改后需要一段时间才能在所有DNS查询中生效。您可以稍后再试。

true

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023011818525862987CA4D7FB7503D0F7",
        "Action": "CertificateCheckInstanceDCVStatus",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": true
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心