IP ACLに Assignmentを追加

Prev Next

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

IP ACLに Assignmentを追加します。

リクエスト

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

メソッド URI
POST /api/v1/ip-acls/{ipAclId}/assignments

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
ipAclId String Required IP ACL ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
consoleAccessAssignmentIds Array Conditional コンソールにアクセス可能な Assignment IDリスト
  • IP ACLの Assignmentリストの照会を参照
  • コンソールにアクセス可能な Assignmentを追加する場合、必ず入力
  • AssignmentのconsoleAccessAllowedは falseでconsoleAccessRestrictedが trueの場合にのみ設定可能
apiAccessAssignmentIds Array Conditional API Gatewayにアクセス可能な Assignment IDリスト
  • IP ACLの Assignmentリストの照会を参照
  • API Gatewayにアクセス可能な Assignmentを追加する場合、必ず入力
  • AssignmentのapiAccessAllowedは falseでapiAccessRestrictedがtrueの場合にのみ設定可能

リクエスト例

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/ip-acls/5bf4cad0-****-****-****-cd51bba3fe23/assignments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "consoleAccessAssignmentIds": [
        "2c15b16c-****-****-****-3e7207ff2bf6"
    ],
    "apiAccessAssignmentIds": [
        "2c15b16c-****-****-****-3e7207ff2bf6"
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
id String - IP ACL ID
nrn String - IP ACLに対する NAVERクラウドプラットフォームリソースの識別値
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successfalseの場合、表示

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

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

レスポンス例

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

{
    "id": "5bf4cad0-****-****-****-cd51bba3fe23",
    "nrn": "nrn:PUB:SSO::*******:IPACL/5bf4cad0-****-****-****-cd51bba3fe23",
    "success": true
}