プロファイル名のチェック

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

プロファイル名の有効性と重複チェックを行います。

リクエスト

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

メソッド	URI
GET	/api/v1/profiles/validation

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`name`	String	Required	プロファイル名英数字、記号の「-」、「_」を使用して3~35文字以内で入力

リクエスト例

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

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles/validation?name=profilename-test' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	レスポンスコード
`message`	String	-	レスポンスメッセージ
`result`	Boolean	-	プロファイル名チェックの結果 `true` \| `false` `true`: 使用できない名前 `false`: 使用可能な名前

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

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

レスポンス例

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

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

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

{
    "code": "0000",
    "message": "Success",
    "result": false
}

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

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

プロファイル名が既に存在する場合

{
    "code": "0000",
    "message": "Success",
    "result": true
}

プロファイル名が有効でない場合

{
    "traceId": "32ohg69i6aphn36d1lccr3adhk",
    "path": "/v1/external/profiles/validation",
    "timestamp": 1752547449310,
    "product": "Global Edge",
    "status": 400,
    "code": "0040",
    "message": "Field validation Error",
    "details": "existsProfileName.name=my : size must be between 3 and 35"
}