getCloudMysqlBackupDetailList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET, POST	/getCloudMysqlBackupDetailList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の Cloud DB for MySQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudMysqlInstanceNo`	String	Required	Cloud DB for MySQLインスタンス番号 getCloudMysqlInstanceListを通じて確認
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用してページング処理 0 (最小)
`pageSize`	Integer	Conditional	ページごとに表示する結果数 `pageNo`、`pageSize`を利用してページング処理 `pageNo`入力時、必須 1 (最小)
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlBackupDetailList
?regionCode=KR
&cloudMysqlInstanceNo=****890
&pageNo=0
&pageSize=30'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "getCloudMysqlBackupDetailListResponse": {
        "totalRows": 1,
        "cloudMysqlBackupDetailList": [
            {
                "fileName": "20240524",
                "startTime": "2024-06-12T09:00:00+0900",
                "endTime": "2024-06-12T09:00:13+0900",
                "backupSize": 597617308,
                "dataStorageSize": 10737418240
            }
        ],
        "requestId": "390769d7-****-****-****-05c7df3603f1",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlBackupDetailListResponse>
  <requestId>390769d7-****-****-****-05c7df3603f1</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <cloudMysqlBackupDetailList>
    <cloudMysqlBackupDetail>
      <fileName>20240524</fileName>
      <startTime>2024-05-24T02:05:03+0900</startTime>
      <endTime>2024-05-24T02:05:43+0900</endTime>
      <backupSize>597617308</backupSize>
      <dataStorageSize>10737418240</dataStorageSize>
    </cloudMysqlBackupDetail>
    <cloudMysqlBackupDetail>
      <fileName>20240523</fileName>
      <startTime>2024-05-23T11:41:16+0900</startTime>
      <endTime>2024-05-23T11:41:30+0900</endTime>
      <backupSize>597612256</backupSize>
      <dataStorageSize>10737418240</dataStorageSize>
    </cloudMysqlBackupDetail>
  </cloudMysqlBackupDetailList>
</getCloudMysqlBackupDetailListResponse>

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

What's Next

getCloudMysqlBackupList

リクエスト
レスポンス

タグ

Cloud DB for MySQL