該接口用于查詢物聯網卡所在的定向分組及訪問地址列表。

使用說明

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

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 ListDirectionalDetail

系統規(guī)定參數。取值：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

是否調用成功。

  • true：調用成功。
  • false：調用失敗。
Code String 200

接口返回碼。

  • 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

地址來源。

  • user_defined：用戶配置。
  • aliyun_defined：阿里云預配。
AddressType String Domain

地址類型。

  • Ip：IP地址。
  • Domain：域名。
State String 500

地址狀態(tài)。

  • 100：新增處理中。
  • 200：刪除處理中。
  • 300：新增失敗。
  • 400：刪除失敗。
  • 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"
      } ]
    }
  }
}