文档中心

域名服务

获取信息模板详情

API 说明

API 名称：GetTemplate

API 域名：domain-openapi.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

请求示例

响应示例

错误码

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

最近更新时间：2026.10.28 19:05:47

这个页面对您有帮助吗？

有用

无用