コンソールアクセスルールの照会

Prev Next

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

サブアカウントのコンソールアクセスルールを照会します。

リクエスト

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

メソッド URI
GET /api/v1/sub-accounts/{subAccountId}/access-rules/console

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/access-rules/console' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
subAccountId String - サブアカウント ID
useConsolePermitIp Boolean - コンソールにアクセス可能な IPアドレス帯域を制限するかどうか
  • true | false
    • true: 指定の IPアドレス帯域からのみアクセス可能
    • false: 制限なしでアクセス可能
consolePermitIps Array - コンソールにアクセスできるIP帯域リスト

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

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

レスポンス例

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

{
    "subAccountId": "2b141960-****-****-****-246e9659184c",
    "useConsolePermitIp": true,
    "consolePermitIps": [
        "10.0.0.0"
    ]
}