--- title: "Secret Managerの概要" slug: "secretmanager-api-overview" updated: 2026-10-08T07:20:21Z published: 2026-10-08T07:20:21Z canonical: "api.ncloud-docs.com/secretmanager-api-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Secret Managerの概要 VPC環境で利用できます。 Secret Managerは、セキュリティパスワードを安全に保存、変更、管理する NAVERクラウドプラットフォームのサービスです。Secret Managerサービスは、セキュリティパスワードの作成、照会、ローテーション、削除管理関連の APIを RESTfulの形式で提供します。 ## Secret Manager共通設定 Secret Manager APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。 ### リクエスト 共通リクエスト形式を説明します。 #### API URL 韓国(KR)リージョンは、Secretが暗号化された Key Management Service(以下 KMS)キーの隔離タイプによって API URLが異なります。 | リージョン | KMS全域キー暗号化連携 Secret | KMS隔離キー暗号化連携 Secret | | --- | --- | --- | | 韓国(KR) | https://secretmanager.apigw.ntruss.com | https://ocapi-kr.ncloud.com/secretmanager | 日本リージョンは KMSのリージョン隔離キーのみ利用して暗号化することができます。API URLは次の通りです。 | リージョン | Secret Manager API | | --- | --- | | 日本(JPN) | https://ocapi-jp.ncloud.com/secretmanager | 注意 Key Management Service(KMS)のリージョン隔離キー機能がアップデートされ、Secret Managerでもリージョン隔離キーを連携できます。アップデート前に全域キーで連携されたシークレットはそのまま使用できますが、新規シークレット連携時に全域キーは選択できなくなりました。詳細は、[Key Management Serviceの概要](https://api.ncloud-docs.com/docs/ja/security-kms)をご参照ください。 ### リクエストヘッダ リクエストヘッダの説明は次の通りです。 | フィールド | 必須の有無 | 説明 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒) - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす - Unix Timestamp形式 | | `x-ncp-iam-access-key` | Required | NAVERクラウドプラットフォームから発行された Access Key - Access Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - サブアカウントの Access Key発行と確認: [サブアカウントの作成](https://guide.ncloud-docs.com/docs/ja/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1)を参照 | | `x-ncp-apigw-signature-v2` | Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 - Secret Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - 署名の作成: [シグネチャーの作成](/docs/ja/common-ncpapi)を参照 | | `Content-Type` | Optional | リクエストデータの形式 - `application/json` | ### レスポンス 共通レスポンス形式を説明します。 #### レスポンスボディ レスポンスボディの説明は次の通りです。 **responseError** responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `error` | Object | - | エラー情報 | | `error.errorCode` | String | - | エラーコード | | `error.message` | String | - | エラーメッセージ | | `error.details` | String | - | エラーの詳細情報 | #### レスポンスステータスコード レスポンスステータスコードの説明は次の通りです。 | HTTPステータスコード | コード | メッセージ | 説明 | | --- | --- | --- | --- | | 403 | FORBIDDEN | Forbidden | 認証完了または権限なしでリクエストを拒否 | | 500 | INTERNAL_SERVER_ERROR | Server internal error | サーバ内部エラー | | 422 | UNPROCESSABLE_ENTITY | Invalid status | リクエストは有効だが、ルール違反 | | 400 | INVALID_REQUEST | Invalid request | 無効なリクエスト | | 401 | UNAUTHORIZED | Unauthorized | 認証情報なし | | 404 | NOT_FOUND | Not found | リクエストリソースなし | | 409 | INVALID_STATUS | Invalid status | 無効な状態値 | 参考 NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud APIのレスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 #### レスポンス例 呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。 ``` { "error": { "errorCode": "string", "message": "string", "details": "string" } } ``` ## Secret Manager API Secret Managerサービスが提供する APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [Create Secret](/docs/ja/secretmanager-createsecret) | シークレットを作成 | | [Get Protection Key List](/docs/ja/secretmanager-getprotectionkeylist) | 保護キーリストを照会 | | [Get Secret Detail](/docs/ja/secretmanager-getsecretdetail) | シークレットの詳細情報を照会 | | [Get Secret List](/docs/ja/secretmanager-getsecretlist) | シークレットリストを照会 | | [Get Secret Logs](/docs/ja/secretmanager-getsecretlogs) | シークレット利用ログを照会 | | [Get Secret Stage Value](/docs/ja/secretmanager-getsecretstagevalue) | 特定のシークレットステージのシークレット値を照会 | | [Get Secret Value](/docs/ja/secretmanager-getsecretvalue) | シークレット値を照会 | | [Get Trigger List](/docs/ja/secretmanager-gettriggerlist) | トリガーリストを照会 | | [Cancel Rotation Job](/docs/ja/secretmanager-cancel-rotation-job) | 実行中のシークレットローテーションジョブをキャンセル | | [Cancel Secret Deletion](/docs/ja/secretmanager-cancelsecretdeletion) | シークレットの削除リクエストをキャンセル | | [Disable Auto Rotation](/docs/ja/secretmanager-disable-auto-rotation) | シークレット自動ローテーションを無効化 | | [Disable Secret](/docs/ja/secretmanager-disablesecret) | シークレットを無効化 | | [Enable Auto Rotation](/docs/ja/secretmanager-enable-auto-rotation) | シークレット自動ローテーションを有効化 | | [Enable Secret](/docs/ja/secretmanager-enablesecret) | シークレットを有効化 | | [Execute Rotation Job](/docs/ja/secretmanager-execute-rotation-job) | シークレットローテーションジョブを実行 | | [Request Secret Deletion](/docs/ja/secretmanager-requestsecretdeletion) | シークレット削除リクエストを作成 | | [Retry Rotation Job](/docs/ja/secretmanager-retry-rotation-job) | シークレットローテーションジョブを再試行 | | [Rollback Rotation Job](/docs/ja/secretmanager-rollback-rotation-job) | シークレットローテーションジョブをロールバック | | [Update Protection Key](/docs/ja/secretmanager-updateprotectionkey) | 保護キーを変更 | | [Update Rotation Period](/docs/ja/secretmanager-update-rotation-period) | シークレットローテーション周期を変更 | | [Update Rotation Trigger](/docs/ja/secretmanager-update-rotation-trigger) | シークレットローテーショントリガーを変更 | | [Update Secret Memo](/docs/ja/secretmanager-updatesecretmemo) | シークレットの説明を更新 | | [Update Secret Stage Value](/docs/ja/secretmanager-update-secret-stage-value) | 特定のシークレットステージのシークレット値を更新 | | [Update Secret Value](/docs/ja/secretmanager-updatesecretvalue) | シークレットステージ全体のシークレット値を変更 | | [Delete Rotation Trigger](/docs/ja/secretmanager-delete-rotation-trigger) | シークレットローテーショントリガーを削除 | | [Delete Secret](/docs/ja/secretmanager-deletesecret) | シークレットを削除 | ### Secret Rotate Process Control Secret Rotate Process Control関連の APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [Add Pending Stage](/docs/ja/secretmanager-add-pending-stage) | Pendingステージを作成 | | [Generate Random Secret](/docs/ja/secretmanager-generate-random-secret) | 任意のシークレット文字列を作成 | | [Complete Rotation Job](/docs/ja/secretmanager-complete-rotation-job) | シークレットローテーションジョブ完了を通知 | | [Fail Rotation Job](/docs/ja/secretmanager-fail-rotation-job) | シークレットローテーションジョブ失敗を通知 | | [Start Rotation Job](/docs/ja/secretmanager-start-rotation-job) | シークレットローテーションジョブを開始 | | [Update Pending Stage](/docs/ja/secretmanager-update-pending-stage) | Pendingステージのシークレット値を更新 | ## Secret Manager関連リソース Secret Manager APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。 - Secret Manager APIの使用方法 - [署名(シグネチャー)の作成](/docs/ja/common-ncpapi): リクエストヘッダに追加する署名の作成方法 - [Sub Accountご利用ガイド](https://guide.ncloud-docs.com/docs/ja/subaccount-overview): リクエストヘッダに追加する Access Keyの発行方法 - [Ncloudの共通レスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Secret Managerサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報 - Secret Managerサービスの使用方法 - [Secret Managerご利用ガイド](https://guide.ncloud-docs.com/docs/ja/secretmanager-overview): NAVERクラウドプラットフォームで Secret Managerを使用する方法 - [Ncloud利用環境ガイド](https://guide.ncloud-docs.com/docs/ja/environment-environment-1-1): VPC、Classicプラットフォームとサポートの有無に関するガイド - [料金の紹介、特長、詳細機能](https://www.ncloud.com/product/security/secretManager): Secret Managerの料金体系、特長と詳細機能のサマリー - [サービスの最新情報](https://www.ncloud.com/intro/news?categoryCode=SEC&serviceCode=SV_0257): Secret Managerに関する最新情報 - [よくある質問](https://www.ncloud.com/support/faq/prod?categoryCode2=SEC&categoryCode3=SV_0257&page=1): Secret Managerユーザーからよく寄せられる質問とその回答 - [サポート](https://www.ncloud.com/support/question/service): APIガイドだけでは不明な点が解消されない場合、直接問い合わせ