給定向分組添加訪問地址。

使用說明

僅新版定向服務菜單支持定向分組功能,如果您使用的是舊版定向服務菜單,無法使用該接口。更多信息,請參見定向服務

調試

您可以在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
}