GetGroupList
- 印刷する
- PDF
GetGroupList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
リソースグループリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/groups |
リクエストヘッダ
Resource Manager APIで共通して使用されるヘッダの詳細は、Resource Managerの共通ヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
groupName | String | Optional | リソースグループ名 |
pageIndex | Integer | Optional | ページ番号
|
pageSize | Integer | Optional | ページ出力数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://resourcemanager.apigw.ntruss.com/api/v1/groups' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
pageIndex | Integer | - | ページ番号 |
pageSize | Integer | - | ページ出力数 |
itemCount | Integer | - | レスポンス結果数 |
hasMore | Boolean | - | 追加ページが存在するかどうか
|
items | Array | - | レスポンス結果 |
error | Object | - | エラーコードとメッセージ
|
error.errorCode | Integer | - | エラーコード |
error.message | String | - | エラーメッセージ |
error.details | String | - | エラーメッセージの説明 |
items
items
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
groupId | String | - | リソースグループ ID |
groupName | String | - | リソースグループ名 |
groupDesc | String | - | リソースグループの説明 |
createTime | Integer | - | リソースグループの作成日時 |
updateTime | Integer | - | リソースグループの最終更新日時 |
レスポンスステータスコード
Resource Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Resource Managerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"pageIndex": 0,
"pageSize": 20,
"itemCount": 2,
"hasMore": false,
"items": [
{
"groupId": "821ad7869d494b298aa9a13b",
"groupName": "testgroup_01",
"groupDesc": "test",
"createTime": 1727441443000,
"updateTime": 1727441443000
},
{
"groupId": "64f077df093f6a0838604299",
"groupName": "testgroup_02",
"groupDesc": "",
"createTime": 1693480928000,
"updateTime": 1693480928000
}
]
}
この記事は役に立ちましたか?