API Keyの作成
- 印刷する
- PDF
API Keyの作成
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
API Gatewayに登録された APIにアクセスして使用できるように権限を付与するための API Keyを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /api-keys |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエスト構文
リクエスト構文は次の通りです。
{
"apiKeyDescription" : "apiKeyDescription",
"apiKeyName" : "apiKeyName"
}
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
apiKeyDescription | String | Optional | 作成する API Keyの説明
|
apiName | String | Required | 作成する API Keyの名前
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
"apiKeyDescription" : "apiKey-*** Description",
"apiKeyName" : "apiKey-***"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
構文は次の通りです。
{
"apiKey": {
"apiKeyId": "apiKeyId",
"tenantId": "tenantId",
"apiKeyName": "apiKeyName",
"apiKeyDescription": "apiKeyDescription",
"primaryKey": "primaryKey",
"secondaryKey": "secondaryKey",
"modifier": "modifier",
"isEnabled": true,
"modTime": "2024-05-07T07:08:12Z",
"domainCode": "domainCode"
}
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"apiKey": {
"apiKeyId": "*****vg079",
"tenantId": "*****02f55ae4436913a6e2c65bab47c",
"apiKeyName": "apiKey-***",
"apiKeyDescription": "apiKey-*** Description",
"primaryKey": "*****yVk37ZE39kJcZScH50cYsJiYf1EJUQ7haPj",
"secondaryKey": "*****WKmt1IVMAlXtg0yJ5jelwwiltuJBFKBDW9",
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"isEnabled": true,
"modTime": "2024-05-07T07:08:12Z",
"domainCode": "PUB"
}
}
この記事は役に立ちましたか?