文档

AddGtmAddressPool - 新增地址池(旧版)

更新时间:

新增地址池。

调试

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

授权信息

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

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

请求参数

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

用户语言。

en
InstanceIdstring

实例 ID。

gtm-cn-xxxxxxx
Namestring

地址池名称。

测试
Typestring

地址池类型。取值:

  • IP:IPv4 地址
  • DOMAIN:域名
IP
MinAvailableAddrNuminteger

最小可用地址数量。

1
MonitorStatusstring

健康检查开启状态。取值:

  • OPEN:开启
  • CLOSE(默认):关闭
OPEN
ProtocolTypestring

检查协议。取值:

  • HTTP
  • HTTPS
  • Ping
  • TCP
TCP
Intervalinteger

检查间隔,单位:秒,取值范围:60。

60
EvaluationCountinteger

连续失败次数。

2
Timeoutinteger

超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。

5000
MonitorExtendInfostring

扩展信息。根据不同协议,进行传参:

HTTP、HTTPS:

  • port:检查端口
  • failureRate:失败比例
  • code:返回码(大于此值会被判定为异常)。取值:400、500。
  • host:Host 设置
  • path:URL 路径

PING:

  • packetNum:ping 包数目
  • packetLossRate:丢包率
  • failureRate:失败比例

TCP:

  • port:检查端口
  • failureRate:失败比例
{"host":"aliyun.com","port":80}
Addrobject []

地址池列表。

Valuestring

地址池地址。

1.1.XX.XX
LbaWeightinteger

地址池权重。

1
Modestring

地址池模式。取值:

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

监控城市节点列表。

CityCodestring

监控节点的城市 Code。具体取值请参考 DescribeGtmMonitorAvailableConfig 的返回值。

546
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-FD579933522B
AddrPoolIdstring

地址池 ID。

hraf3x
MonitorConfigIdstring

健康检查配置 ID。

hraf14

示例

正常返回示例

JSON格式

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "AddrPoolId": "hraf3x",
  "MonitorConfigId": "hraf14"
}

错误码

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

  • 本页导读 (0)