通过GTM实例ID修改实例配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alidns:UpdateDnsGtmInstanceGlobalConfig | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 部分返回参数语言。默认值:en。取值范围:en、zh、ja。 | en |
InstanceId | string | 是 | GTM 实例 ID。 | gtm-cn-wwo3a3hbz** |
InstanceName | string | 否 | 实例名称:首次更新必填,再次更新则非必填。 | test-1 |
Ttl | integer | 否 | 全局 TTL。 | 60 |
PublicCnameMode | string | 否 | 公网域名接入方式:
| CUSTOM |
PublicUserDomainName | string | 否 | 业务域名(公网)。 | example.com |
PublicZoneName | string | 否 | CNAME 接入域名(公网):主域名,且当为自定义接入时为必填。 说明
此处应填入主域名,不包含 PublicRr 参数内容
| gtm-003.com |
AlertGroup | string | 否 | 报警组(List | ["test1","test2"] |
CnameType | string | 否 | CNAME 接入域名类型:
| PUBLIC |
AlertConfig | array<object> | 否 | 报警配置列表。 | |
object | 否 | |||
SmsNotice | boolean | 否 | 是否配置短信通知:
| true |
NoticeType | string | 否 | 报警事件类型:
| ADDR_ALERT |
EmailNotice | boolean | 否 | 是否配置邮件通知:
| true |
DingtalkNotice | boolean | 否 | 是否需要钉钉报警:
| true |
PublicRr | string | 否 | CNAME 接入域名(公网):主机名 | test.rr |
ForceUpdate | boolean | 否 | 是否强制更新。
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF559**"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | DnsGtmInstance.PublicRrDuplicate.OtherUserInstance | |
400 | GtmInstance.CnameModeDeny | |
400 | DnsGtmInstance.CnameModeDeny | |
400 | DnsGtmSystemBusyness |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-21 | OpenAPI 错误码发生变更 | 查看变更详情 |