VPC環境で利用できます。
シークレット自動ローテーション周期を更新します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /api/v1/secrets/{secretId}/rotation-period |
リクエストヘッダ
Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
secretId |
String | Required | シークレット ID |
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
rotationPeriod |
Integer | Required | 自動ローテーション周期(日) |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/rotation-period' \
--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 '{
"rotationPeriod": 730
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | - | レスポンスコード |
data |
Object | - | レスポンス結果 |
data.secretId |
String | - | シークレット ID |
data.autoRotationYN |
String | - | 自動ローテーションするか
|
data.autoRotationPeriod |
Integer | - | シークレット自動ローテーション周期(日) |
data.nextRotationDate |
Long | - | 次のローテーション予定日時(ミリ秒)
|
レスポンスステータスコード
Secret Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Secret Managerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "SUCCESS",
"data": {
"secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
"autoRotationYN": "Y",
"autoRotationPeriod": 730,
"nextRotationDate": 1816311600000
}
}