exportDbServerLogsToObjectStorage

Prev Next

Available in VPC

Send Cloud DB for MSSQL instance DB server log files to Object Storage.

Note

To send DB server log files to Object Storage, Object Storage buckets for storing and searching DB server log files must be created in advance. For more information, see the Object Storage Guide.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET, POST /exportDbServerLogsToObjectStorage

Request headers

For headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) request headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for MSSQL instance whose DB server log file you want to send to Object Storage
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
cloudMssqlInstanceNo String Required Cloud DB for MSSQL instance number
cloudMssqlServerInstanceNo String Required Cloud DB for MSSQL server instance number
bucketName String Required Name of the Object Storage bucket the DB server log file will be sent to
folderPath String Optional Object Storage bucket's folder path
cloudMssqlExportObjectList.N.fullObjectName List<String> Required List of log file names to be sent to Object Storage
  • Check through getCloudMssqlBucketList
  • <E.g.> cloudMssqlExportObjectList.1.fullObjectName=test1&cloudMssqlExportObjectList.2.fullObjectName=test2
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/exportDbServerLogsToObjectStorage
?regionCode=KR
&cloudMssqlInstanceNo=2517****
&cloudMssqlServerInstanceNo=2517****
&bucketName=bucket
&cloudMssqlObjectNameList.1=SQLAGENT.OUT
&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}'

Response

The following describes the response format.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

  • If responseFormetType=json

    {
    "exportDbServerLogsToObjectStorageResponse": {
        "requestId": "9d128334-****-****-****-1b9b703b1675",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • If responseFormetType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
<exportDbServerLogsToObjectStorageResponse>
    <requestId>9d128334-****-****-****-1b9b703b1675</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportDbServerLogsToObjectStorageResponse>