该接口用于查询套餐的流量使用详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetCredentialPoolStatistics

系统规定参数。取值：GetCredentialPoolStatistics。
Date String 是 202108

要查询的套餐流量使用详情的月份。
CredentialNO String 是 CM-SF-M-2-12G

套餐凭证。获取方法如下：

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码。

  • 200：表示成功。
  • 其它：表示错误码。错误码详情，请参见错误码。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID，阿里云为该请求生成的标识符。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。
Data Object

套餐流量使用详情。
PoolUsed String 0KB

当月已用流量。
CredentialNO String CM-SF-M-2-12G

套餐凭证。
PoolOutUsed String 0KB

当月套餐外流量。
PoolGrandTotalUsed String 6.00GB

套餐流量使用总量，仅统付池套餐显示该参数。
CredentialType String CT-SC-M-1-30M

套餐凭证类型。

  • 单卡套餐示例：CT-SC-M-1-30M（运营商-套餐类型-套餐周期-资费版本-流量包档位）。
  • 同档位池套餐示例：CM-SF-M-3-100M（运营商-套餐类型-套餐周期-资费版本-流量包档位）。
  • 统付池套餐示例：CU-UPG-M-2-池编号（运营商-套餐类型-套餐周期-资费版本-池编号）。
CardTotalNum Long 20

套餐内总卡数。
PoolGrandTotal String 12.00GB

套餐总流量，仅统付池套餐显示该参数。
CardActiveNum Long 10

套餐内的生效卡数（已激活且未停机未销户）。
EffectiveTotalFlow String 12.00GB

套餐总流量，仅同档位池套餐显示该参数。
EffectiveAvailableFlow String 6.00GB

套餐内可用余量，仅同档位池套餐显示该参数。
PoolAvaiable String 6.00GB

套餐内可用余量，仅统付池套餐显示该参数。
MonthFeatureFee Long 100

月功能费份数，仅统付池套餐显示该参数。
CredentialInstanceId String 259****

凭证实例ID。
SmsUsed Long 0

短信用量。
MonthUsedAmount Long 3.00GB

月度流量使用总量。
MonthExceedFee Long 200

当月功能费超套份数。

大于0代表功能费已超套；等于0或null代表未超套。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=GetCredentialPoolStatistics
&CredentialNO=CM-SF-M-2-12G
&Date=202108
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetCredentialPoolStatisticsResponse>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <Data>
        <PoolUsed>0KB</PoolUsed>
        <CredentialNO>CM-SF-M-2-12G</CredentialNO>
        <PoolOutUsed>0KB</PoolOutUsed>
        <PoolGrandTotalUsed>6.00GB</PoolGrandTotalUsed>
        <CredentialType>CM-SF-M-2-12G</CredentialType>
        <CardTotalNum>20</CardTotalNum>
        <PoolGrandTotal>12.00GB</PoolGrandTotal>
        <CardActiveNum>10</CardActiveNum>
        <EffectiveTotalFlow>12.00GB</EffectiveTotalFlow>
        <EffectiveAvailableFlow>6.00GB</EffectiveAvailableFlow>
        <PoolAvaiable>6.00GB</PoolAvaiable>
        <MonthFeatureFee>100</MonthFeatureFee>
        <CredentialInstanceId>259****</CredentialInstanceId>
        <SmsUsed>0</SmsUsed>
    </Data>
</GetCredentialPoolStatisticsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "Data" : {
    "PoolUsed" : "0KB",
    "CredentialNO" : "CM-SF-M-2-12G",
    "PoolOutUsed" : "0KB",
    "PoolGrandTotalUsed" : "6.00GB",
    "CredentialType" : "CM-SF-M-2-12G",
    "CardTotalNum" : 20,
    "PoolGrandTotal" : "12.00GB",
    "CardActiveNum" : 10,
    "EffectiveTotalFlow" : "12.00GB",
    "EffectiveAvailableFlow" : "6.00GB",
    "PoolAvaiable" : "6.00GB",
    "MonthFeatureFee" : 100,
    "CredentialInstanceId" : "259****",
    "SmsUsed" : 0
  }
}