getCloudRedisBackupList
    • PDF

    getCloudRedisBackupList

    • PDF

    記事の要約

    VPC環境で利用できます。

    Cloud DB for Redisシステムバックアップリストを照会します。

    リクエスト

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

    メソッドURI
    GET, POST/getCloudRedisBackupList

    リクエストヘッダ

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

    リクエストパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptional照会対象の Cloud DB for Redisシステムバックアップリストのリージョンコード
    • getRegionListを通じて確認
    • getRegionList照会結果の最初のリージョン(デフォルト)
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisBackupList
    ?regionCode=KR'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

    レスポンスボディの詳細は、CloudRedisBackupListをご参照ください。

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

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

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

    • responseFormatType=jsonの場合
    {
        "getCloudRedisBackupListResponse": {
            "totalRows": 1,
            "cloudRedisBackupList": [
                {
                    "cloudRedisInstanceNo": "****511",
                    "cloudRedisServiceName": "test-****",
                    "backupFileRetentionPeriod": 7,
                    "backupTime": "00:15",
                    "backupSize": 525,
                    "lastBackupDate": "2024-07-02T00:00:00+0900",
                    "backupType": {
                        "code": "CLUSTER",
                        "codeName": "CLOUD REDIS(VPC) Cluster Backup Type"
                    },
                    "shardCount": 3
                }
            ],
            "requestId": "ac8cf68a-****-****-****-8788236f4c26",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • responseFormatType=xml(デフォルト)の場合
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisBackupListResponse>
        <requestId>ac8cf68a-****-****-****-8788236f4c26</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisBackupList>
            <cloudRedisBackup>
                <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
                <cloudRedisServiceName>test-****</cloudRedisServiceName>
                <backupFileRetentionPeriod>7</backupFileRetentionPeriod>
                <backupTime>00:15</backupTime>
                <backupSize>525</backupSize>
                <backupType>
                    <code>CLUSTER</code>
                    <codeName>CLOUD REDIS(VPC) Cluster Backup Type</codeName>
                </backupType>
                <shardCount>3</shardCount>
            </cloudRedisBackup>
        </cloudRedisBackupList>
    </getCloudRedisBackupListResponse>
    

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

    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.