Classic/VPC環境で利用できます。
Serverまたは Serviceロールに割り当てられた適用対象を削除します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
DELETE | /api/v1/roles/{roleNo}/entities |
リクエストヘッダ
Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
roleNo |
String | Required | ロール ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
entityIdList |
Array | Required | ロール適用対象リスト
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request DELETE 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/entities' \
--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' \
--data '{
"entityIdList": [
"100****57"
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
success |
Boolean | - | API呼び出しに成功したかどうか
|
id |
String | - | ロール適用対象の IDまたは名前 |
name |
String | - | アクションの種類 |
レスポンスステータスコード
Sub Account APIで共通して使用されるレスポンスステータスコードの詳細は、Sub Accountのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
[
{
"success": true,
"id": "100****57",
"name": "removeEntity"
}
]