Classic/VPC環境で利用できます。
プロファイルリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/profiles |
リクエストヘッダ
Global Edge APIで共通して使用されるヘッダの詳細は、Global Edgeのリクエストヘッダをご参照ください。
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles' \
--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 |
Array | - | プロファイルリスト |
result
resultの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
id |
Integer | - | プロファイル ID |
customerId |
Integer | - | ユーザー識別番号 |
profileName |
String | - | プロファイル名 |
参考
customerIdは、レスポンス結果に表示される場合がありますが、サービス使用に影響を与えないフィールドです。
レスポンスステータスコード
Global Edge APIで共通して使用されるレスポンスステータスコードの詳細は、Global Edgeのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "0000",
"message": "Success",
"result": [
{
"id": 1599,
"customerId": 35,
"profileName": "myprofile"
},
{
"id": 1600,
"customerId": 35,
"profileName": "myprofile2"
}
]
}