CreateCloudGtmAddress - 创建地址

根据传入参数创建地址。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alidns:CreateCloudGtmAddress

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AcceptLanguage

string

返回值语言,取值:

  • zh-CN:中文。

  • en-US(默认):英文。

zh-CN

ClientToken

string

用户生成的请求 token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

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

Name

string

地址名称。

Address-1

Type

string

地址类型:

  • IPv4

  • IPv6

  • domain

IPv4

Address

string

IP 地址或者域名。

223.5.XX.XX

AttributeInfo

string

地址归属信息。

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

Remark

string

备注。

test

EnableStatus

string

表示该地址当前启用状态:

  • enable:启用状态

  • disable:禁用状态

enable

AvailableMode

string

地址探测异常切换方式:

  • auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。

  • manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。

auto

ManualAvailableStatus

string

当地址探测异常切换模式为 manual 时,地址设置的可用状态:

  • available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。

  • unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。

available

HealthJudgement

string

地址健康状态判定条件(HealthTasks 不为空时必填):

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

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

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

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

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

p50_ok

HealthTasks

array<object>

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

object

地址关联的健康探测模板。

Port

integer

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

80

TemplateId

string

地址关联的健康探测模板 ID。

mtp-89518052425100****

返回参数

名称

类型

描述

示例值

object

RequestId

string

唯一请求识别码。

46973D4C-E3E4-4ABA-9190-9A9DE406C7E

Success

boolean

创建地址操作是否成功:

  • true:操作成功

  • false:操作失败

true

AddressId

string

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

addr-8951821811436****

示例

正常返回示例

JSON格式

{
  "RequestId": "46973D4C-E3E4-4ABA-9190-9A9DE406C7E",
  "Success": true,
  "AddressId": "addr-8951821811436****"
}

错误码

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

变更历史

更多信息,参考变更详情