文档

AddDnsGtmAddressPool - 新增地址池

新增地址池。

调试

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

授权信息

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

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

请求参数

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

部分返回参数语言。默认值:en。取值范围:en、zh、ja。

en
InstanceIdstring

实例 Id。

gtm-cn-cs02xyk4a**
Namestring

地址池名称。

test
Typestring

地址池类型:

  • IPV4:ipv4 地址
  • IPV6: ipv6 地址
  • DOMAIN:域名
IPV4
LbaStrategystring

负载均衡状态:

  • ALL_RR:返回全部地址
  • RATIO:按权重返回地址
ALL_RR
MonitorStatusstring

健康检查开启状态(默认 CLOSE),若 OPEN 则校验健康检查配置,否则抛弃

  • OPEN:开启
  • CLOSE:关闭
OPEN
ProtocolTypestring

检查协议:

  • HTTP
  • HTTPS
  • PING
  • TCP
TCP
Intervalinteger

检查间隔,单位秒。

60
EvaluationCountinteger

连续失败次数。

2
Timeoutinteger

超时时间,单位毫秒。

2000
MonitorExtendInfostring

扩展信息,各协议检查所需参数:

  • HTTP(S):

    • port:检查端口
    • host:Host 设置
    • path:URL 路径
    • code:返回码大于
    • failureRate:失败比例
    • sni:是否开启 sni,仅在 HTTPS 协议时使用。
      • true-开启
      • 其他-未开启
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
  • PING:

    • failureRate:失败比例
    • packetNum:ping 包数目
    • packetLossRate:丢包率
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
  • TCP:

    • port:检查端口
    • failureRate:失败比例
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
{"failureRate":50,"port":80}
Addrobject []

地址池列表。

AttributeInfostring

地址归属信息, JSON 字符串格式。

  • lineCode:归属线路 Code
  • lineCodeRectifyType:归属线路订正类型,默认:自动订正
    • NO_NEED 不订正
    • RECTIFIED 已订正
    • AUTO 自动订正
{"lineCodeRectifyType":"AUTO", "lineCode":[]}
Remarkstring

备注。

test
LbaWeightinteger

权重。

1
Addrstring

地址。

223.5.XX.XX
Modestring

模式:

  • SMART:智能返回
  • ONLINE:永远在线
  • OFFLINE:永远离线
SMART
IspCityNodeobject []

监控城市节点列表。

CityCodestring

城市 Code。

具体取值可参考:DescribeGtmMonitorAvailableConfig 接口返回数据。

503
IspCodestring
  • 具体取值可参考:DescribeGtmMonitorAvailableConfig 接口返回数据。
  • GroupType 为 BGP 或 Overseas 时,IspCityNode.N.IspCode 为非必传值,默认为 465。
  • GroupType 为非 BGP 或 Overseas 时,IspCityNode.N.IspCode 为必传值。并与 IspCityNode.N.CityCode 匹配使用。
465

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD5799335**B
AddrPoolIdstring

地址池 id。

hrbv**
MonitorConfigIdstring

健康检查配置 id。

hra**a

示例

正常返回示例

JSON格式

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD5799335**B",
  "AddrPoolId": "hrbv**",
  "MonitorConfigId": "hra**a"
}

错误码

HTTP status code错误码错误信息
400DnsGtmSystemBusyness

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

变更历史

变更时间变更内容概要操作
2023-03-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
  • 本页导读 (0)
文档反馈