getCloudMysqlBackupList

Prev Next

VPC環境で利用できます。

Cloud DB for MySQLインスタンスのバックアップリストを照会します。

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

メソッド URI
GET, POST /getCloudMysqlBackupList

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 照会対象の Cloud DB for MySQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlBackupList
?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}'
Curl

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

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

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

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

  • responseFormatType=jsonの場合
{
    "getCloudMysqlBackupListResponse": {
        "totalRows": 1,
        "cloudMysqlBackupList": [
            {
                "cloudMysqlInstanceNo": "****890",
                "cloudMysqlServiceName": "test-****",
                "backupFileRetentionPeriod": 10,
                "backupTime": "02:00",
                "backupSize": 597617308,
                "lastBackupDate": "2024-05-24T02:05:03+0900"
            }
        ],
        "requestId": "32a9946d-****-****-****-2390da20749c",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
JSON
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlBackupListResponse>
  <requestId>32a9946d-****-****-****-2390da20749c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudMysqlBackupList>
    <cloudMysqlBackup>
      <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
      <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
      <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
      <backupTime>02:00</backupTime>
      <backupSize>597617308</backupSize>
      <lastBackupDate>2024-05-24T02:05:03+0900</lastBackupDate>
    </cloudMysqlBackup>
  </cloudMysqlBackupList>
</getCloudMysqlBackupListResponse>
XML