UpdateCloudGtmAddress - 修改地址基础配置

调用UpdateCloudGtmAddress修改指定地址基础配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alidns:UpdateCloudGtmAddressupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AcceptLanguagestring

返回结果显示的语言。取值:

  • zh-CN:中文

  • en-US(默认):英文

en-US
ClientTokenstring

用户生成的请求 token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

1ae05db4-10e7-11ef-b126-00163e24****
AddressIdstring

地址的 ID,地址唯一标识码。

addr-89518218114368****
Namestring

修改后的地址名称。

Address-1
Addressstring

修改后的 IP 地址或者域名。

223.5.XX.XX
AttributeInfostring

地址归属信息。

当前版本不支持此参数,不需要传入此参数。
HealthJudgementstring

修改后的地址健康状态判定条件:

  • any_ok:所有探测模板至少一个探测正常。

  • p30_ok:所有探测模板至少 30%探测正常。

  • p50_ok:所有探测模板至少 50%探测正常。

  • p70_ok:所有探测模板至少 70%探测正常。

  • all_ok:所有探测模板全部探测正常。

p50_ok
HealthTasksarray<object>

健康探测任务列表。

HealthTaskobject

地址关联的健康探测任务列表。

Portinteger

健康检查探测的目标地址服务端口,当健康检查选择 Ping 协议时,不支持服务端口的配置。

  • 传入参数为空:删除当前已配置的端口号;

  • 传入参数不为空:根据传入参数更新端口号;

80
TemplateIdstring

地址关联的健康探测模板 ID。如果配置了健康检查的端口号,此参数必填。

  • 传入参数为空:删除当前已配置的探测模板;

  • 传入参数不为空:根据传入参数更新探测模板;

mtp-89518052425100****

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD579933522B
Successboolean

修改地址基础配置操作是否成功:

  • true:操作成功

  • false:操作失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Success": true
}

错误码

访问错误中心查看更多错误码。