API認証キーの設定

Prev Next

VPC環境で利用できます。

Object Storageサービスにアクセスできるように API認証キーを設定します。

リクエスト

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

メソッド URI
POST /api/v2/snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} (韓国リージョン)
POST /api/sgn-v2/snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} (シンガポールリージョン)
POST /api/jpn-v2/snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
accessKeyId String Required NAVERクラウドプラットフォームから発行された Access Key
secretKey String Required NAVERクラウドプラットフォームから発行された Secret Key

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/updateAPIAuthenticationKey/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "accessKeyId": "{Access Key}",
    "secretKey": "{Secret Key}"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "c1637182-****-****-****-f83000f29695"
}