该接口用于查询物联网卡的流量信息。

限制说明

单个阿里云账号调用该接口的每秒请求数(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

接口返回码。

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

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

ErrorMessage String InstanceId cannot be empty.

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

Success Boolean true

是否调用成功。

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

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

Data Object

物联网卡的流量信息。

ListVendorDetail Array of VendorDetail

网络数据。

NetWorkDelay String 20

网络延迟,单位ms。

SignalStrength String 20

信号强度。

Vendor String CMCC

物联网卡的运营商。

  • CMCC:移动。
  • CUCC:联通。
  • CTCC:电信。
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"
    } ]
  }
}