Start Rotation Job

Prev Next

VPC環境で利用できます。

シークレットローテーションジョブを開始します。ローテーションジョブの開始が Secret Managerに通知され、シークレットのローテーション中状態に変更されます。

リクエスト

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

メソッド URI
POST /action/v1/secrets/{secretId}/jobs/{jobToken}/start

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
secretId String Required シークレット ID
jobToken String Required ジョブトークン

リクエスト例

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

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/start' \
--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 - レスポンスコード
data Object - レスポンス結果
data.decryptedSecretChain Object - 復号化されたシークレットチェーン
data.decryptedSecretChain.previous String - ACTIVEステージの以前使用した復号化されたシークレット値(PREVIOUSステージ)
data.decryptedSecretChain.active String - 現在正常に使用されている復号化された有効なシークレット値(ACTIVEステージ)
data.decryptedSecretChain.pending String - ローテーションが新しく開始され、ローテーション完了待ちの復号化されたシークレット値(PENDINGステージ)
data.rotationTargets Array - ローテーション対象のシークレット値リスト

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "decryptedSecretChain": {
            "previous": "{\"abc\":\"cba\"}",
            "active": "{\"abc\":\"{cba\"}",
            "pending": "{\"abc\":\"{cba\"}"
        },
        "rotationTargets": [
            "abc"
        ]
    }
}