该接口用于查询物联网卡所在的定向分组及访问地址列表。
使用说明
仅新版定向服务菜单支持定向分组,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见定向服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListDirectionalDetail |
系统规定参数。取值:ListDirectionalDetail。 |
Iccid | String | 是 | 89860321******15668 |
物联网卡的ICCID。 您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面,查看ICCID。 |
PageNo | Integer | 是 | 1 |
查询的页数,不能为0。 |
PageSize | Integer | 是 | 10 |
每页的数量,支持10、15、25、40。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 |
请求ID,阿里云为该请求生成的标识符。 |
Success | Boolean | true |
是否调用成功。
|
Code | String | 200 |
接口返回码。
|
ErrorMessage | String | InstanceId cannot be empty. |
调用失败时,返回的错误信息。 |
LocalizedMessage | String | InstanceId cannot be empty. |
根据当前所在地展示对应语言的错误提示。 |
Data | Object |
返回的分组信息及分组内的访问地址清单。 |
|
DirectionalGroupId | Long | 5 |
定向分组ID。 |
DirectionalName | String | 测试分组 |
定向分组名称。 |
PaginationResult | Object |
定向分组内的访问地址列表。 |
|
PageNo | Integer | 1 |
当前页数。 |
PageSize | Integer | 10 |
每页的数量。 |
Total | Integer | 90 |
列表总数量。 |
PageCount | Integer | 9 |
列表总页数。 |
List | Array of list | ||
GroupId | String | 5 |
定向分组ID。 |
Address | String | *.aliyun.com |
定向访问地址。 |
Source | String | user_defined |
地址来源。
|
AddressType | String | Domain |
地址类型。
|
State | String | 500 |
地址状态。
|
示例
请求示例
http(s)://linkcard.aliyuncs.com/?Action=ListDirectionalDetail
&Iccid=89860321******15668
&PageNo=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListDirectionalDetailResponse>
<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>
<DirectionalGroupId>5</DirectionalGroupId>
<DirectionalName>测试分组</DirectionalName>
<PaginationResult>
<PageNo>1</PageNo>
<PageSize>10</PageSize>
<Total>90</Total>
<PageCount>9</PageCount>
<List>
<GroupId>5</GroupId>
<Address>*.aliyun.com</Address>
<Source>user_defined</Source>
<AddressType>Domain</AddressType>
<State>500</State>
</List>
</PaginationResult>
</Data>
</ListDirectionalDetailResponse>
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" : {
"DirectionalGroupId" : 5,
"DirectionalName" : "测试分组",
"PaginationResult" : {
"PageNo" : 1,
"PageSize" : 10,
"Total" : 90,
"PageCount" : 9,
"List" : [ {
"GroupId" : "5",
"Address" : "*.aliyun.com",
"Source" : "user_defined",
"AddressType" : "Domain",
"State" : "500"
} ]
}
}
}