给定向分组添加访问地址。

使用说明

仅新版定向服务菜单支持定向分组功能,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见定向服务

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String BatchAddDirectionalAddress

系统规定参数。取值:BatchAddDirectionalAddress

GroupId Long 5

定向分组ID。

您可调用接口GetCardDetail在返回参数中查看定向分组ID(DirectionalGroupId)。

Source String user_defined

地址来源。

  • user_defined:用户配置。
  • aliyun_defined:阿里云预配。
AddressType String Domain

地址类型。

  • Ip:IP地址。
  • Domain:域名。
ListAddress.N String *.aliyun.com

具体地址,上限10个。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID,阿里云为该请求生成的标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。
Code String 200

接口返回码。

  • 200:调用成功。
  • 其他:调用失败。错误码详情,请参见错误码
ErrorMessage String InstanceId cannot be empty.

调用失败时,返回的错误信息。

LocalizedMessage String InstanceId cannot be empty.

根据当前所在地展示对应语言的错误提示。

Data Boolean true

地址是否添加成功。

  • true:添加成功。
  • false:添加失败。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=BatchAddDirectionalAddress
&GroupId=5
&Source=user_defined
&AddressType=Domain
&ListAddress=["*.aliyun.com"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<BatchAddDirectionalAddressResponse>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
    <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
    <Data>true</Data>
</BatchAddDirectionalAddressResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "Code" : "200",
  "ErrorMessage" : "InstanceId cannot be empty.",
  "LocalizedMessage" : "InstanceId cannot be empty.",
  "Data" : true
}