リクエスト

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

メソッド	URI
GET, POST	/getCloudMssqlBackupDetailList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlBackupDetailList
?regionCode=KR
&cloudMssqlInstanceNo=2517****
&pageNo=1
&pageSize=1
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormetType=jsonの場合

{
    "getCloudMssqlBackupDetailListResponse": {
        "totalRows":1,
        "cloudMssqlBackupDetailList": [
            {
                "backupSetId": 52,
                "databaseName": "msdb",
                "fileName": "msdb_20240701_02****.full",
                "fullFileName": "Z:\\cmssql_backup\\user_idx_276****\\cmssql_10-0-252-15_m-2517****-001\\msdb_20240701_02****.full",
                "fullBackupSize": 3249515,
                "logBackupCount": 0,
                "logBackupSize": 0,
                "startTime": "2024-07-01T02:00:02+0900",
                "endTime": "2024-07-01T02:00:02+0900"
            }
        ],
        "requestId": "93697d3d-****-****-****-953e20c67075",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlBackupDetailListResponse>
    <requestId>93697d3d-****-****-****-953e20c67075</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlBackupDetailList>
        <cloudMssqlBackupDetail>
            <backupSetId>52</backupSetId>
            <databaseName>msdb</databaseName>
            <fileName>msdb_20240701_02****.full</fileName>
            <fullFileName>Z:\cmssql_backup\user_idx_276****\cmssql_10-0-252-15_m-2517****-001\msdb_20240701_02****.full</fullFileName>
            <fullBackupSize>3249515</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2024-07-01T02:00:02+0900</startTime>
            <endTime>2024-07-01T02:00:02+0900</endTime>
        </cloudMssqlBackupDetail>
    </cloudMssqlBackupDetailList>
</getCloudMssqlBackupDetailListResponse>

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

リクエスト
レスポンス

タグ

Cloud DB for MSSQL