グループの追加

Prev Next

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

グループにサブアカウントを追加します。

リクエスト

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

メソッド URI
POST /api/v1/sub-accounts/{subAccountId}/groups

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
subAccountId String Required サブアカウント ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
groupIdList Array Required グループ IDリスト

リクエスト例

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

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/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 '{
    "groupIdList": [
        "50b77400-****-****-****-246e96591a38"
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - API呼び出しに成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗
id String - グループ ID
name String - アクションの種類

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

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

レスポンス例

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

[
    {
        "success": true,
        "id": "50b77400-****-****-****-246e96591a38",
        "name": "addGroup"
    }
]