グループの作成

Classic/VPC環境で利用できます。

グループを作成します。

参考

グループは最大300個まで作成できます。
サブアカウントごとに所属可能なグループは最大10個です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/groups

リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`groupName`	String	Required	グループ名ハングル、英字の大文字・小文字、日本語、記号。「_ -」を使用して3~30文字先頭文字はハングル、英字の大文字・小文字、日本語
`tags`	Map	Optional	グループのタグリソースごとに最大20個 key、value: 英数字、記号の「(」、「-」、「_」、「)」を組み合わせて128文字以内で入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://subaccount.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 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "groupName": "group000",
    "tags": {
        "env": "dev",
        "team": "a"
    }
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API呼び出しは成功したか `true` \| `false` `true`: 成功 `false`: 失敗
`id`	String	-	グループ ID

レスポンスステータスコード

Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、Sub Accountのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "success": true,
    "id": "bd8864a0-****-****-****-005056a79baa"
}