APIアクセスルールの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

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

リクエスト

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

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

リクエストヘッダ

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/api' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`useApiAllowSource`	Boolean	-	APIにアクセス可能なソースを制限するかどうか `true` \| `false` `true`: 指定のソースからのみアクセス可能 `false`: すべてのソースからアクセス可能
`apiAllowSources`	Array	-	APIにアクセス可能なソースリスト

`apiAllowSources`

apiAllowSourcesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	-	アクセスソースのタイプ `IP` \| `VPC` \| `VPC_SERVER` `IP`: サーバの単一 IPアドレスまたはサブネットを含む IPアドレス帯域 `VPC`: 使用中の VPC `VPC_SERVER`: 使用中の VPC環境のサーバ
`source`	String	-	アクセス可能なソース情報

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

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

レスポンス例

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

{
    "useApiAllowSource": true,
    "apiAllowSources": [
        {
            "type": "IP",
            "source": "***.***.***.***"
        }
    ]
}

この記事は役に立ちましたか?

What's Next

APIアクセスルールの更新

リクエスト
レスポンス

タグ

Sub Account