リクエスト

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

メソッド	URI
GET	/api/v1/ip-acls/check-ip-acl-name

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`ipAclName`	String	Optional	IP ACL名英数字、記号の「-」、「_」を組み合わせて2~30文字以内で入力先頭文字は英字または数字のみ使用

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/ip-acls/check-ip-acl-name?ipAclName=ipacl000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`name`	String	-	IP ACL名
`success`	Boolean	-	IP ACL名チェックの結果 `true` \| `false` `true`: 使用可能な名前 `false`: 使用できない名前
`message`	String	-	使用できない理由 `success`が`false`の場合に表示

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

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

レスポンス例

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

チェックの結果、使用可能な名前の場合

チェックの結果、使用可能な名前の場合のレスポンスのサンプルコードは次の通りです。

{
    "name": "ipacl000",
    "success": true
}

チェックの結果、使用できない名前の場合

チェックの結果、使用できない名前の場合のレスポンスのサンプルコードは次の通りです。

IP ACL名が既に存在する場合

{
    "name": "ipacl000",
    "success": false,
    "message": "The IP ACL name already exists."
}

IP ACL名が有効でない場合

{
    "name": "^ipacl000",
    "success": false,
    "message": "Only English letters, numbers, and special characters (-_) are allowed, and it must start with an English letter or a number."
}

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

リクエスト
レスポンス