該接口用于查詢指定條件下的物聯網卡列表。
使用說明
該接口的請求參數您可以在物聯網SIM服務控制臺查看并獲取,或者調用接口GetCardDetail在返回參數中查看并獲取(后者更為推薦)。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ListCardInfo | 系統規定參數。取值:ListCardInfo。 |
ActiveTimeEnd | String | 否 | 2022-05-25 23:59:59 | 物聯網卡的激活時間區間:結束時間。 格式為: |
PageSize | Integer | 是 | 10 | 每頁的數量,支持10、15、25、40。 |
Iccid | String | 否 | 89860321******15668 | 物聯網卡的ICCID。 您可在物聯網卡上查看ICCID,或者在物聯網SIM服務控制臺的卡管理頁面查看ICCID。 |
CredentialNo | String | 否 | CM-***-*-2-**M | 套餐憑證。 |
Vendor | String | 否 | CMCC | 運營商。
|
PageNo | Integer | 是 | 1 | 查詢頁數,需結合PageSize參數組合使用。 |
Msisdn | String | 否 | 1440993****** | 物聯網卡的MSISDN。 |
AliyunOrderId | String | 否 | 211519634****** | 物聯網卡關聯的訂單編號。 |
AliFee | String | 否 | ali_2 | 資費版本。 |
Period | String | 否 | 1101 | 套餐結算周期。
|
DataType | String | 否 | sameflowcard | 流量類型。
|
ActiveTimeStart | String | 否 | 2022-05-25 23:59:59 | 物聯網卡的激活時間區間:開始時間。 格式為: |
SimType | String | 否 | nano | SIM卡類型。
|
ExpireTimeEnd | String | 否 | 2022-05-25 23:59:59 | 物聯網卡的套餐結束時間。 格式為: |
IsAutoRecharge | Boolean | 否 | true | 套餐是否自動續費。
|
ExpireTimeStart | String | 否 | 2022-05-25 23:59:59 | 物聯網卡的套餐開始時間。 格式為: |
OsStatus | String | 否 | 300 | 物聯網卡的具體狀態。
|
NotifyId | String | 否 | 11111 | 自動化規則的通知ID。 |
DataLevel | String | 否 | 30MB | 流量包檔位。 |
Status | String | 否 | 35 | 物聯網卡的狀態。
|
TagName | String | 否 | 測試標簽 | 標簽名稱。 |
CertifyType | String | 否 | enterprise | 認證方式。 僅支持enterprise:企業認證。 |
DirectionalGroupId | String | 否 | 22 | 定向分組ID。 |
ApnName | String | 否 | cmiot | APN名稱。 |
Imsi | String | 否 | 460081937****** | 物聯網卡的IMSI。 |
PoolId | String | 否 | test1 | 池編號。 |
MinFlow | String | 否 | 20 | 周期用量區間篩選:最小用量(單位MB)。 |
MaxFlow | String | 否 | 30 | 周期用量區間篩選:最大用量(單位MB)。 |
MaxRestFlowPercentage | double | 否 | 0.2 | 單卡周期流量剩余比例,僅支持如下三個參數。 0.1:剩余10% 0.2:剩余20% 0.3:剩余30% |
NetworkType | String | 否 | 4G | 網絡制式:4G,5G。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | 200 | 接口返回碼。
|
ErrorMessage | String | InstanceId cannot be empty. | 調用失敗時,返回的錯誤信息。 |
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 請求ID,阿里云為該請求生成的標識符。 |
Success | Boolean | true | 是否調用成功。
|
LocalizedMessage | String | InstanceId cannot be empty. | 根據當前所在地展示對應語言的錯誤提示。 |
Data | Object | 返回頁面信息。 |
|
PageNo | Integer | 1 | 查詢頁數。 |
PageSize | Integer | 10 | 每頁顯示的數量。 |
PageCount | Integer | 20 | 總頁數。 |
Total | Integer | 199 | 符合條件的物聯網卡總數。 |
List | Array of CardDTO | 卡列表。 |
|
Status | String | 35 | 卡的狀態。
|
DataType | String | sameflowcard | 流量類型。
|
DirectionalGroupName | String | 測試分組 | 定向分組名稱。 |
PeriodRestFlow | String | 130.00MB | 周期剩余流量。 |
CredentialType | String | unityPayPool | 套餐憑證類型。 |
PeriodAddFlow | String | 0KB | 周期累計流量。 |
PeriodSmsUse | String | 0 | 周期短信用量。 |
DataLevel | String | 30MB | 流量包檔位。 |
OsStatus | String | 300 | 物聯網卡的具體狀態。
|
NotifyId | String | 11111 | 自動化規則的通知ID。 |
AliFee | String | ali_2 | 資費版本。 |
AliyunOrderId | String | 211519634****** | 物聯網卡關聯的訂單編號。 |
ActiveType | String | first_data_record | 物聯網卡的激活方式。
|
IsAutoRecharge | Boolean | true | 套餐是否自動續費。
|
CredentialInstanceId | String | 2622*** | 憑證實例ID。 |
ExpireTime | String | 2022-04-30 23:59:59 | 套餐到期時間。 |
ApnName | String | cmiot | APN名稱。 |
ActiveTime | String | 2021-11-16 16:35:50 | 激活時間。 |
Iccid | String | 89860321******15668 | 物聯網卡的ICCID。 |
Vendor | String | CMCC | 運營商。
|
Period | String | 1101 | 套餐結算周期。
|
CertifyType | String | enterprise | 認證方式。 enterprise:企業認證。 |
PrivateNetworkSegment | String | 1.*.3.* | 私網網段(定向卡)。 |
OpenAccountTime | String | 2021-11-29 16:12:14 | 開戶時間。 |
SimType | String | nano | SIM卡類型。
|
VsimInstanceId | Long | 123456 | 物聯網卡的InstanceId值。 |
CredentialNo | String | CM-***-*-2-**M | 套餐憑證。 |
TagList | Array of TagList | 物聯網卡的標簽。 |
|
TagName | String | 測試標簽 | 標簽名稱。 |
Id | Long | 24 | 標簽ID。 |
Imsi | Array of String | 460081937****** | 物聯網卡的IMSI。 |
Msisdn | Array of String | 1440993****** | 物聯網卡的MSISDN。 |
Remark | String | 備注信息 | 備注信息。 |
DirectionalGroupId | Long | 55 | 定向分組ID。 |
NetworkType | String | 4G | 網絡制式:4G,5G。 |
FlowLatestModifiedTime | String | 2023-08-15 18:20:11 | 用量更新時間 |
示例
請求示例
http(s)://linkcard.aliyuncs.com/?Action=ListCardInfo
&ActiveTimeEnd=2022-05-25 23:59:59
&PageSize=10
&Iccid=89860321******15668
&CredentialNo=CM-***-*-2-**M
&Vendor=CMCC
&PageNo=1
&Msisdn=1440993******
&AliyunOrderId=211519634******
&AliFee=ali_2
&Period=1101
&DataType=sameflowcard
&ActiveTimeStart=2022-05-25 23:59:59
&SimType=nano
&ExpireTimeEnd=2022-05-25 23:59:59
&IsAutoRecharge=true
&ExpireTimeStart=2022-05-25 23:59:59
&OsStatus=300
&NotifyId=11111
&DataLevel=30MB
&Status=35
&TagName=測試標簽
&CertifyType=enterprise
&DirectionalGroupId=22
&ApnName=cmiot
&Imsi=460081937******
&PoolId=test1
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListCardInfoResponse>
<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>20</PageCount>
<Total>199</Total>
<List>
<Status>35</Status>
<DataType>sameflowcard</DataType>
<DirectionalGroupName>測試分組</DirectionalGroupName>
<PeriodRestFlow>130.00MB</PeriodRestFlow>
<CredentialType>unityPayPool</CredentialType>
<PeriodAddFlow>0KB</PeriodAddFlow>
<PeriodSmsUse>0</PeriodSmsUse>
<DataLevel>30MB</DataLevel>
<OsStatus>300</OsStatus>
<NotifyId>11111</NotifyId>
<AliFee>ali_2</AliFee>
<AliyunOrderId>211519634******</AliyunOrderId>
<ActiveType>first_data_record</ActiveType>
<IsAutoRecharge>true</IsAutoRecharge>
<CredentialInstanceId>2622***</CredentialInstanceId>
<ExpireTime>2022-04-30 23:59:59</ExpireTime>
<ApnName>cmiot</ApnName>
<ActiveTime>2021-11-16 16:35:50</ActiveTime>
<Iccid>89860321******15668</Iccid>
<Vendor>CMCC</Vendor>
<Period>1101</Period>
<CertifyType>enterprise</CertifyType>
<PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>
<OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>
<SimType>nano</SimType>
<VsimInstanceId>123456</VsimInstanceId>
<CredentialNo>CM-***-*-2-**M</CredentialNo>
<TagList>
<TagName>測試標簽</TagName>
<Id>24</Id>
</TagList>
<Imsi>460081937******</Imsi>
<Msisdn>1440993******</Msisdn>
<Remark>備注信息</Remark>
<DirectionalGroupId>55</DirectionalGroupId>
</List>
</Data>
</ListCardInfoResponse>
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" : 20,
"Total" : 199,
"List" : [ {
"Status" : "35",
"DataType" : "sameflowcard",
"DirectionalGroupName" : "測試分組",
"PeriodRestFlow" : "130.00MB",
"CredentialType" : "unityPayPool",
"PeriodAddFlow" : "0KB",
"PeriodSmsUse" : "0",
"DataLevel" : "30MB",
"OsStatus" : "300",
"NotifyId" : "11111",
"AliFee" : "ali_2",
"AliyunOrderId" : "211519634******",
"ActiveType" : "first_data_record",
"IsAutoRecharge" : true,
"CredentialInstanceId" : "2622***",
"ExpireTime" : "2022-04-30 23:59:59",
"ApnName" : "cmiot",
"ActiveTime" : "2021-11-16 16:35:50",
"Iccid" : "89860321******15668",
"Vendor" : "CMCC",
"Period" : "1101",
"CertifyType" : "enterprise",
"PrivateNetworkSegment" : "1.*.3.*",
"OpenAccountTime" : "2021-11-29 16:12:14",
"SimType" : "nano",
"VsimInstanceId" : 123456,
"CredentialNo" : "CM-***-*-2-**M",
"TagList" : [ {
"TagName" : "測試標簽",
"Id" : 24
} ],
"Imsi" : [ "460081937******" ],
"Msisdn" : [ "1440993******" ],
"Remark" : "備注信息",
"DirectionalGroupId" : 55
} ]
}
}