该接口用于查询定向分组的访问地址列表。

使用说明

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

调试

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

请求参数

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

系统规定参数。取值:ListDirectionalAddress

PageSize Integer 10

每页的数量,支持10、15、25、40。

PageNo Integer 1

查询页数,需结合PageSize参数使用。

GroupId String 5

定向分组ID。

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

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码。

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

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

RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

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

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。
LocalizedMessage String InstanceId cannot be empty.

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

Data Object

返回的访问地址。

PageNo Integer 1

查询页数。

PageSize Integer 10

每页的数量。

PageCount Integer 9

列表总页数。

Total Integer 90

列表总数量。

List Array of UnityPayPool

访问地址。

Address String *.aliyun.com

定向访问地址。

AddressType String Domain

地址类型。

  • Ip:IP地址。
  • Domain:域名。
Source String user_defined

地址来源。

  • user_defined:用户配置。
  • aliyun_defined:阿里云预配。
GroupId String 5

定向分组ID。

State Integer 500

地址状态。

  • 100:新增处理中。
  • 200:删除处理中。
  • 300:新增失败。
  • 400:删除失败。
  • 500:新增成功。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=ListDirectionalAddress
&PageSize=10
&PageNo=1
&GroupId=5
&公共请求参数

正常返回示例

XML格式

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

<ListDirectionalAddressResponse>
    <Code>200</Code>
    <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
    <Data>
        <PageNo>1</PageNo>
        <PageSize>10</PageSize>
        <PageCount>9</PageCount>
        <Total>90</Total>
        <List>
            <Address>*.aliyun.com</Address>
            <AddressType>Domain</AddressType>
            <Source>user_defined</Source>
            <GroupId>5</GroupId>
            <State>500</State>
        </List>
    </Data>
</ListDirectionalAddressResponse>

JSON格式

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

{
  "Code" : "200",
  "ErrorMessage" : "InstanceId cannot be empty.",
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "LocalizedMessage" : "InstanceId cannot be empty.",
  "Data" : {
    "PageNo" : 1,
    "PageSize" : 10,
    "PageCount" : 9,
    "Total" : 90,
    "List" : [ {
      "Address" : "*.aliyun.com",
      "AddressType" : "Domain",
      "Source" : "user_defined",
      "GroupId" : "5",
      "State" : 500
    } ]
  }
}