VPC環境で利用できます。
シークレットが実行中のローテーションジョブをキャンセルします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v1/secrets/{secretId}/cancel-rotation |
リクエストヘッダ
Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
secretId |
String | Required | シークレット ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/cancel-rotation' \
--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 |
String | - | レスポンス結果
|
レスポンスステータスコード
Secret Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Secret Managerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "SUCCESS",
"data": null
}