获取信息模板详情--域名服务-火山引擎

文档中心

立即注册

导航

获取信息模板详情

最近更新时间：2023.06.25 18:12:16首次发布时间：2023.05.22 22:30:38

API 说明

API 名称：GetTemplate
API 域名：open.volcengineapi.com
API 描述：获取一个信息模板的详情。

请求方法

GET

使用限制

节流限制：您每秒最多可以发送 50 个请求。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。

公共参数

在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下两个查询参数的取值说明如下：

参数名称	数据类型	必选	参数说明
Action	string	是	表示 API 的名称。该参数的取值是 `GetTemplate`。
Version	string	是	表示 API 的版本。该参数的取值是 `2022-12-12`。

请求参数

该 API 的请求参数的类型是查询参数。

参数名称	数据类型	必选	参数说明	示例
tag	string	是	表示您需要查询的一个模板的 tag。您可以调用 ListTemplates 获取模板列表。列表中包含了每个模板的 tag。	`G0zM6RUUWLPxsIuVPF7obA==`

响应正文

以下列表仅显示了此 API 返回信息模板参数中的一部分。关于不在该列表中的那些信息模板参数的说明，参见 CreateTemplate。

参数名称	数据类型	参数说明	示例
country_code	string	表示该模板的 `city_zh` 字段所对应的国家代码。当前，该字段的值是 `CN`。	`CN`
created_at	int64	表示该模板的创建时间。时间格式是 Unix 时间戳，精度是秒。	`1674366362`
status	string	表示该模板的状态。该参数有以下取值： `not_validation`：表示该模板还未启动实名认证流程。 `pending_validation`：表示该模板正在实名认证的流程中。 `verification_success`：表示该模板已实名认证。 `verification_failed`：表示该模板未通过实名认证。	`verification_success`
status_notice	string	表示如果该模板未通过实名认证，认证失败所对应的消息。以下是几个消息示例：身份信息与证件不符模板审核失败	`模板审核失败`
tag	string	表示该模板的 tag。	`G0zM6RUUWLPysIuVPF7obA==`
updated_at	int64	表示该模板最近的修改时间。时间格式是 Unix 时间戳，精度是秒。	`1679463962`

示例

请求示例

GET https://open.volcengineapi.com?Version=2022-12-12&Action=GetTemplate&tag=G0zM6RUUWLPysIuVPF7obA==

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023052215340818A1CD8153B8E97E34DE",
        "Action": "GetTemplate",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "status": "not_validation",
        "status_notice": "",
        "tag": "G0zM6RUUWLPysIuVPF7obA==",
        "registration_type": "P",
        "country_code": "CN",
        "post_code": "163000",
        "email": "aaa@example.com",
        "registrant_fn": "San",
        "registrant_ln": "Zhang",
        "address": "My Address",
        "city": "Shanghai",
        "state": "Shanghai",
        "registrant": "San Zhang",
        "registrant_fn_zh": "三",
        "registrant_ln_zh": "李",
        "address_zh": "我的地址",
        "city_zh": "上海",
        "state_zh": "上海",
        "registrant_zh": "张三",
        "tel_country_code": "86",
        "tel_area_code": "",
        "tel_number": "12345678963",
        "tel_extension": "",
        "id_type": "",
        "id_code": "",
        "created_at": 1684740543,
        "updated_at": 1684740543
    }
}

错误码

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