getCloudDBBackupDetailList
    • PDF

    getCloudDBBackupDetailList

    • PDF

    Article summary

    Overview

    Import the backup details list in Cloud DB.

    Request

    Request header

    HeaderDescription
    x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-apigw-api-keyAPI key issued by API Gateway (not used in the API v2)
    x-ncp-apigw-api-key:{API Gateway API Key}
    x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Signature encrypted with your Access Key ID and Secret Key.
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeSet the request body content type to application/json.
    Content-Type: application/json

    Request body

    Field names in API requests are case sensitive.

    ParameterRequiredTypeLimitationsDescription
    regionNoNStringRegion number
    dbKindCodeYStringMYSQLDB type code
    cloudDBInstanceNoYStringCan be acquired through getCloudDBInstanceList
    responseFormatTypeNStringxml, jsonSets the results format of the response
    • regionNo

    • dbKindCode

      • Selects the type of Cloud DB to search. Only MySQL can be selected.
    • cloudDBInstanceNo

      • It is the instance number of the MySQL server that has been created. It can be acquired through getCloudDBInstanceList.
    • responseFormatType

      • Sets the response format of the API execution results. You can select between XML and JSON.

    Response

    FieldTypeDescriptionNote
    returnCodeIntegerResponse code
    returnMessageStringResponse message
    totalRowsIntegerNumber of response result rows
    cloudDBBackupDetailList[]StringBackup details listCloudDBBackupDetail
    • CloudDBBackupDetail
    FieldTypeDescriptionNote
    fileNameStringFile name
    startTimeDateStart date
    endTimeDateEnd date
    backupSizeLongBackup size

    Examples

    Request example

    curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBBackupDetailList?regionNo=1&dbKindCode=MYSQL&cloudDBInstanceNo=2090164&responseFormatType=json" 
    -H "accept: application/json" 
    -H "Content-Type: application/x-www-form-urlencoded" 
    -H "x-ncp-iam-access-key: UhO0EH9R8Gts7PoPPz27" 
    -H "x-ncp-apigw-timestamp: 1644485285737" 
    -H "x-ncp-apigw-signature-v2: WK2nam8/iO4WfG9WTyfInTQJ9vqYLJXBlyhPpaOcr5E=" 
    -H "cache-control: no-cache" 
    -H "pragma: no-cache"
    
    https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBBackupDetailList?regionNo=1&dbKindCode=MYSQL&cloudDBInstanceNo=2090164&responseFormatType=json
    

    Request sample

    • Get a list of MySQL instances
    {
      "regionNo": "1",
      "dbKindCode": "MYSQL",
      "cloudDBInstanceNo": "2090164",
      "responseFormatType": "json"
    }
    

    Response example

     connection: keep-alive 
     content-type: application/json;charset=UTF-8 
     date: Thu, 10 Feb 2022 09:28:06 GMT 
     server: nginx 
     transfer-encoding: chunked 
     x-ncp-apigw-response-origin: ENDPOINT 
     x-ncp-trace-id: 66cr470p68dhi3eo9lckom4cpn
    
    {
      "getCloudDBBackupDetailListResponse": {
        "requestId": "3c723f22-270d-4a32-adec-5774bf9b3b46",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "cloudDBBackupDetailList": [
          {
            "fileName": "20220210",
            "startTime": "2022-02-10T12:30:08+0900",
            "endTime": "2022-02-10T12:30:20+0900",
            "backupSize": 584942472
          }
        ]
      }
    }
    

    Error codes

    If a Cloud DB API request is invalid or an error occurs while processing the request, the API returns an HTTP status code representing success or failure with a detailed message in JSON.

    There are two types of error codes: “common error code” of the Cloud DB API and “API Gateway error code.”

    Error codeResponse messageDescription
    200Ok
    500Server Error

    Was this article helpful?

    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.