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 | 已使用量 |
TotalCapacity | Long | 318 | 總量 |
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>
<TotalCapacity>318</TotalCapacity>
<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,
"TotalCapacity" : 318,
"Unit" : "次"
} ],
"PageNumber" : 1,
"Success" : true,
"Count" : 100,
"PageSize" : 20,
"Message" : "\"成功\"",
"Version" : "1.0",
"Fatal" : false
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?