該接口用于查詢物聯網卡的流量信息。
限制說明
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為20。
說明 RAM用戶共享阿里云賬號配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetCardFlowInfo |
系統規定參數。取值:GetCardFlowInfo。 |
Iccid | String | 是 | 89860321******15668 |
物聯網卡的ICCID。 您可在物聯網卡上查看ICCID,或者在物聯網SIM服務控制臺的卡管理頁面查看ICCID。 |
DateList.N | String | 否 | ["202110","202111"] |
需要查詢的月份。 最多可以查詢6個月,如果為空則獲取最近兩個月的數據。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
接口返回碼。
|
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 |
請求ID,阿里云為該請求生成的標識符。 |
ErrorMessage | String | InstanceId cannot be empty. |
調用失敗時,返回的錯誤信息。 |
Success | Boolean | true |
是否調用成功。
|
LocalizedMessage | String | InstanceId cannot be empty. |
根據當前所在地展示對應語言的錯誤提示。 |
Data | Object |
物聯網卡的流量信息。 |
|
ListVendorDetail | Array of VendorDetail |
網絡數據。 |
|
NetWorkDelay | String | 20 |
網絡延遲,單位ms。 |
SignalStrength | String | 20 |
信號強度。 |
Vendor | String | CMCC |
物聯網卡的運營商。
|
UsedFlow | String | 100MB |
已用流量。 |
Ratio | String | 80% |
用量占比。 |
ListCardMonthFlow | Array of CardMonthFlow |
月用量詳情。 |
|
FlowCount | String | 200MB |
月總流量統計。 |
Month | String | 202112 |
流量月份。 |
ListDayFlow | Array of DayFlowDto |
每日用量。 |
|
Flow | String | 100MB |
日用量。 |
Day | String | 20211201 |
流量日期。 |
ListPackageDTO | Array of PackageDTO |
套餐包信息。 |
|
EffectiveTime | String | 2022-03-20 23:59:59 |
套餐生效時間。 |
Remark | String | 備注內容 |
備注。 |
PackageName | String | 移動-單卡通用流量-月包-30M |
套餐名稱。 |
ExpireTime | String | 2022-04-30 23:59:59 |
套餐到期時間。 |
示例
請求示例
http(s)://linkcard.aliyuncs.com/?Action=GetCardFlowInfo
&Iccid=89860321******15668
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetCardFlowInfoResponse>
<Code>200</Code>
<RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
<Success>true</Success>
<Data>
<ListVendorDetail>
<NetWorkDelay>20</NetWorkDelay>
<SignalStrength>20</SignalStrength>
<Vendor>CMCC</Vendor>
</ListVendorDetail>
<ListCardMonthFlow>
<FlowCount>200MB</FlowCount>
<Month>202112</Month>
<ListDayFlow>
<Flow>100MB</Flow>
<Day>20211201</Day>
</ListDayFlow>
</ListCardMonthFlow>
<ListPackageDTO>
<EffectiveTime>2022-03-20 23:59:59</EffectiveTime>
<Remark>備注內容</Remark>
<PackageName>移動-單卡通用流量-月包-30M</PackageName>
<ExpireTime>2022-04-30 23:59:59</ExpireTime>
</ListPackageDTO>
</Data>
</GetCardFlowInfoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "200",
"RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
"Success" : true,
"Data" : {
"ListVendorDetail" : [ {
"NetWorkDelay" : "20",
"SignalStrength" : "20",
"Vendor" : "CMCC"
} ],
"ListCardMonthFlow" : [ {
"FlowCount" : "200MB",
"Month" : "202112",
"ListDayFlow" : [ {
"Flow" : "100MB",
"Day" : "20211201"
} ]
} ],
"ListPackageDTO" : [ {
"EffectiveTime" : "2022-03-20 23:59:59",
"Remark" : "備注內容",
"PackageName" : "移動-單卡通用流量-月包-30M",
"ExpireTime" : "2022-04-30 23:59:59"
} ]
}
}