文档

API余量获取

更新时间:
一键部署

获取用户的API余量、总量、使用量等数据

注意: 该接口支持主账号和Ram子账号获取API余量、总量、使用量信息

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeApiMetering

系统规定参数。取值:DescribeApiMetering

productCode String cmapi0004****

商品code

type Integer 1

类型,1表示套餐包,2表示资源包

pageNum Integer 1

页码

返回数据

名称

类型

示例值

描述

RequestId String 62FC432C55A1A63534A6CB34

请求id

Code String 200

状态码

Result Array of result

返回值列表

AliyunPk Long 102277855749****

阿里云pk

ProductCode String cmapi0004****

商品code

ProductName String 身份证实名认证-身份证实名

商品名称

TotalQuota Long 98

余量

TotalUsage Long 220

使用量

Unit String

单位

PageNumber Long 1

页码

Success Boolean true

结果标识

Count Long 100

总数

PageSize Long 20

 每页个数

Message String "成功"

错误信息描述

Version String 1.0

版本

Fatal Boolean false

fatal

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeApiMetering
&productCode=cmapi0004****
&type=1
&pageNum=1
&公共请求参数

正常返回示例

XML格式

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

<DescribeApiMeteringResponse>
    <RequestId>62FC432C55A1A63534A6CB34</RequestId>
    <Code>200</Code>
    <Result>
        <ProductCode>cmapi0004****</ProductCode>
        <ProductName>身份证实名认证-身份证实名</ProductName>
        <TotalQuota>98</TotalQuota>
        <TotalUsage>220</TotalUsage>
        <Unit>次</Unit>
    </Result>
    <PageNumber>1</PageNumber>
    <Success>true</Success>
    <Count>100</Count>
    <PageSize>20</PageSize>
    <Message>"成功"</Message>
    <Version>1.0</Version>
    <Fatal>false</Fatal>
</DescribeApiMeteringResponse>

JSON格式

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

{
  "RequestId" : "62FC432C55A1A63534A6CB34",
  "Code" : "200",
  "Result" : [ {
    "ProductCode" : "cmapi0004****",
    "ProductName" : "身份证实名认证-身份证实名",
    "TotalQuota" : 98,
    "TotalUsage" : 220,
    "Unit" : "次"
  } ],
  "PageNumber" : 1,
  "Success" : true,
  "Count" : 100,
  "PageSize" : 20,
  "Message" : "\"成功\"",
  "Version" : "1.0",
  "Fatal" : false
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)