指定された API キーの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ApiKey |
string |
必須 |
プレーンテキストの API キー。 |
6c4b1f0317cd4fd7a5b446d3503d** |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。有効な値: 30、50、100。 デフォルト値: 30。 |
30 |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
リクエストの ID。 |
F3322AFE-083E-4D77-A074-421301****** |
| Items |
array<object> |
消費者オブジェクトのリスト。 |
|
|
array<object> |
消費者オブジェクト。 |
||
| Consumer |
object |
消費者情報。 |
|
| ConsumerId |
string |
c-71qh3pscbd3i |
|
| GwClusterId |
string |
pg-2ze5n62ef4s165*** |
|
| Name |
string |
test |
|
| ConsumerGroupId |
string |
cg-bq6rcdjp02vt |
|
| ConsumerTag |
string |
test |
|
| ApiKey |
string |
*** |
|
| Status |
string |
Enabled |
|
| CreateTime |
string |
2021-07-18T07:32:30Z |
|
| ModifyTime |
string |
2026-04-10T01:48:25Z |
|
| UsageStatistics |
array<object> |
消費者の使用量統計。 |
|
|
object |
消費者の使用量統計。 |
||
| GwClusterId |
string |
pg-bp1ln7w98yrhzz7i2 |
|
| DimensionType |
string |
Consumer |
|
| DimensionRefId |
string |
c-xxxxxx |
|
| TotalInputToken |
string |
10 |
|
| TotalOutputToken |
string |
10 |
|
| TotalCacheToken |
string |
10 |
|
| TotalCostPoints |
string |
10 |
|
| MonthlyInputToken |
string |
10 |
|
| MonthlyOutputToken |
string |
10 |
|
| MonthlyCacheToken |
string |
10 |
|
| MonthlyCostPoints |
string |
10 |
|
| TotalToken |
string |
10 |
|
| MonthlyToken |
string |
10 |
例
成功レスポンス
JSONJSON
{
"RequestId": "F3322AFE-083E-4D77-A074-421301******",
"Items": [
{
"Consumer": {
"ConsumerId": "c-71qh3pscbd3i",
"GwClusterId": "pg-2ze5n62ef4s165***",
"Name": "test",
"ConsumerGroupId": "cg-bq6rcdjp02vt",
"ConsumerTag": "test",
"ApiKey": "***",
"Status": "Enabled",
"CreateTime": "2021-07-18T07:32:30Z",
"ModifyTime": "2026-04-10T01:48:25Z"
},
"UsageStatistics": [
{
"GwClusterId": "pg-bp1ln7w98yrhzz7i2",
"DimensionType": "Consumer\n\n",
"DimensionRefId": "c-xxxxxx",
"TotalInputToken": "10",
"TotalOutputToken": "10",
"TotalCacheToken": "10",
"TotalCostPoints": "10",
"MonthlyInputToken": "10",
"MonthlyOutputToken": "10",
"MonthlyCacheToken": "10",
"MonthlyCostPoints": "10",
"TotalToken": "10",
"MonthlyToken": "10"
}
]
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。