MENU
      Enable Key Version

        Enable Key Version


        記事の要約

        Classic/VPC環境で利用できます。

        キーのバージョンを有効化します。ただし、使用停止状態のキーのバージョンは有効化できません。

        リクエスト

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

        メソッドURI
        POST/keys/{keyTag}/versions/{version}/enable

        リクエストヘッダ

        Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダでアカウント認証方式をご参照ください。

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

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

        フィールドタイプ必須の有無説明
        keyTagStringRequiredキータグ
        • キー名から派生したキーの固有 ID
        • Get Key Listを通じて確認
        • REST APIで暗号化または復号化をリクエストする際に使用
        • キータグは機密情報として扱われない
        versionIntegerRequiredキーのバージョン
        • 1~100

        リクエスト例

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

        curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/*******/versions/*******/enable' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Shell

        レスポンス

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

        レスポンスボディ

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

        フィールドタイプ必須の有無説明
        codeString-成功したかどうか
        dataObject-レスポンス結果
        data.versionInteger-有効化したキーのバージョン
        data.statusString-キーバージョンの状態
        • ENABLE: 有効化
        data.statusDateLong-キーのバージョンを有効化状態に変更した日時(ミリ秒)
        • Unix Timestamp形式

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

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

        レスポンス例

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

        {
            "code": "SUCCESS",
            "data": {
                "version": 1,
                "status": "ENABLE",
                "statusDate": 1733460541703
            }
        }
        JSON

        この記事は役に立ちましたか?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.