コンシューマーグループの一覧を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| GwClusterId |
string |
必須 |
ゲートウェイインスタンスの ID です。 |
pg-xxxxxxx |
| ConsumerGroupId |
string |
任意 |
コンシューマーグループの ID です。 |
cg-xxxxxxxx |
| PageSize |
integer |
任意 |
1 ページあたりに返されるレコード数です。有効な値は以下のとおりです。
デフォルト値は 30 です。 |
30 |
| PageNumber |
integer |
任意 |
返されるページ番号です。デフォルト値は 1 です。 |
1 |
| RegionId |
string |
任意 |
リージョンの ID です。 |
cn-beijing |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクトです。 |
||
| RequestId |
string |
リクエスト ID です。 |
24A1990B-4F6E-482B-B8CB-75C612****** |
| TotalRecordCount |
integer |
レコードの総数です。 |
1 |
| PageRecordCount |
integer |
現在のページに含まれるレコード数です。 |
30 |
| PageNumber |
integer |
ページ番号です。 |
1 |
| PageSize |
integer |
1 ページあたりに返されるレコード数です。有効な値は 30、50、および 100 です。デフォルト値は 30 です。 |
30 |
| Items |
array<object> |
コンシューマーグループのリストです。 |
|
|
object |
コンシューマーグループオブジェクトです。 |
||
| IsDefault |
string |
コンシューマーグループがデフォルトグループかどうかを示します。有効な値は以下のとおりです。
|
0 |
| ConsumerGroupId |
string |
コンシューマーグループの ID です。 |
cg-xxxxxxxx |
| ConsumerGroupName |
string |
コンシューマーグループの名前です。 |
test |
| NickName |
string |
コンシューマーグループのニックネームです。 |
test |
| GmtCreated |
string |
作成時刻です。 |
2026-01-28T09:56:03+08:00 |
| GmtModified |
string |
更新時刻です。 |
2026-01-04T16:09:29+08:00 |
| AllowedModels |
string |
サポートされているモデルのリストです。 |
"[]" |
例
成功レスポンス
JSONJSON
{
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"TotalRecordCount": 1,
"PageRecordCount": 30,
"PageNumber": 1,
"PageSize": 30,
"Items": [
{
"IsDefault": "0",
"ConsumerGroupId": "cg-xxxxxxxx",
"ConsumerGroupName": "test",
"NickName": "test",
"GmtCreated": "2026-01-28T09:56:03+08:00",
"GmtModified": "2026-01-04T16:09:29+08:00",
"AllowedModels": "\"[]\""
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。