You need to enable JavaScript to run this app.
导航
更新信息模板
最近更新时间:2024.06.26 13:18:24首次发布时间:2023.06.06 22:21:03

API 说明

API 名称:UpdateTemplate
API 域名:open.volcengineapi.com
API 描述:更新一个信息模板中的字段值。

请求方法

POST

使用限制

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

请求鉴权

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

公共参数

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

参数名称数据类型必选参数说明
Actionstring表示 API 的名称。该参数的取值是 UpdateTemplate
Versionstring表示 API 的版本。该参数的取值是 2022-12-12

请求参数

该 API 的请求参数的类型是请求正文参数。

在您调用该 API 更新一个信息模板时,您指定的字段内容会覆盖这些字段的当前值。如果您没有指定某个字段,表示将该字段的值设置为空。

您可以使用 GetTemplate 获取当前该信息模板中各字段的值。

参数名称数据类型必选参数说明示例

tag

string

表示需要更新的信息模板的 tag。

G0zM6RUUWLPysIuVPF7obA==

post_codestring表示域名所有者地址的邮编。该参数只能包含数字,长度是 6 个字符。163000
emailstring表示域名所有者的邮件地址。abc@example.com
registrant_fnstring表示联系人的英文姓名中的名,只能包含字母和数字,并且至少包含一个字母。Meng

registrant_ln

string

表示联系人的英文姓名中的姓,只能包含字母和数字,并且至少包含一个字母。

Li

address

string

表示域名所有者的英文地址。英文地址至少包含一个字母,长度不能超过 128 个字符。

Hei Long Jiang Sheng Da Qing Shi Sa Er Tu Qu Yong Jun Da Jie 3-10 Hao 5 Men 2 Shi

citystring表示域名所有者所在的城市的英文名称。城市的英文名称至少包含一个字母,长度不能超过 64 个字符。beijingshi
statestring表示域名所有者所在的省份的英文名称。省份的英文名称至少包含一个字母,长度不能超过 64 个字符。heilongjiangsheng
registrant_fn_zhstring表示联系人中文姓名中的名。名可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。
registrant_ln_zhstring表示联系人中文姓名的姓。姓可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。

address_zh

string

表示域名所有者的中文地址。地址可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。地址长度不能超过 128 个字符。

注意

地址必须包含完整的省份名称和城市名称。例如:辽宁省沈阳市 不能写成 辽宁沈阳,否则模板将审核失败。

黑龙江省大庆市萨尔图区拥军大街3-10号5门2室

city_zh

string

表示域名所有者的中文城市。城市可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。城市长度不能超过 64 个字符。

北京市

state_zhstring表示域名所有者的中文省份。省份可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。省份长度不能超过 64 个字符。黑龙江省
tel_country_codestring表示联系人电话号码中的国家码。当前,国家码只能是 86。86 表示中国的国家码。86

tel_area_code

string

表示联系人电话号码中的区号。该参数的说明如下:

  • 如果 tel_number 表示的是一个座机号码,该参数为必填。该参数只能包含数字,长度为 3 个或 4 个字符。

  • 如果 tel_number 表示的是一个手机号码,您无需填写该参数。

注意

区号必须匹配 address_zh 中的地区。

010

tel_number

string

表示联系人电话号码。电话号码只能包含数字,长度不超过 11 个字符。
手机号码的长度是 11 位数字,座机号码的长度是 7-8 位数字。

12345678912

tel_extension

string

表示联系人电话号码的分机。该参数的说明如下:

  • 如果 tel_number 表示的是一个座机号码,该参数是可选的。该参数只能包含数字,长度为 1-4 个字符。

  • 如果 tel_number 表示的是一个手机号码,您无需填写该参数。

1234

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-12-12&Action=UpdateTemplate
{
    "tag":"G0zM6RUUWLPysIuVPF7obA==",
    "post_code":"163000",
    "email": "aaa@example.com",
    "registrant_fn":"San",
    "registrant_ln":"Zhang",
    "address":"My Address",
    "city":"Shanghai",
    "state":"Shanghai",
    "registrant_fn_zh":"三",
    "registrant_ln_zh":"李",
    "address_zh":"我的地址",
    "city_zh": "上海",
    "state_zh": "上海",
    "tel_country_code": "86",
    "tel_number":"12345678963"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230522152902BF8AE46450333517309F",
        "Action": "UpdateTemplate",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    }
}

错误码

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