exportDbServerLogToObjectStorage

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Send Cloud DB for MySQL instance DB server log files to Object Storage.
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	/exportDbServerLogToObjectStorage

Request headers

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

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code Region code of the Cloud DB for MySQL instance whose DB server log file you want to send to Object Storage Check through getRegionList Default: first Region of the `getRegionList` query result
`logType`	String	Required	DB server log file type `BINARY` \| `ERROR` \| `SLOW` \| `GENERAL` \| `AUDIT` `BINARY`: log all data changes that occurred on the master server `ERROR`: log errors encountered by DB server `SLOW`: log queries that run for more than a set amount of time and related information `GENERAL`: log all executed SQL queries and related information `AUDIT`: log security-related events
`fileName`	String	Required	DB server log file name Check through getCloudMysqlBackupDetailList
`bucketName`	String	Required	Name of the Object Storage bucket the DB server log file will be sent to Check through ListBuckets
`folderPath`	String	Optional	Folder path where DB server log files will be sent
`cloudMysqlServerInstanceNo`	String	Required	Server instance number of Cloud DB for MySQL Check through getCloudMysqlInstanceList
`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/vmysql/v2/exportDbServerLogToObjectStorage
?regionCode=KR
&logType=BINARY
&fileName=mysql-bin.000001
&bucketName=mysql-bin-log
&folderPath=cloud-db-for-mysql/
&cloudMysqlServerInstanceNo=****891'
--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 responseFormatType=json

{
    "exportDbServerLogToObjectStorageResponse": {
        "requestId": "1cf902bb-****-****-****-28fc2494f20",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<exportDbServerLogToObjectStorageResponse>
    <requestId>1cf902bb-****-****-****-28fc2494f20c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportDbServerLogToObjectStorageResponse>

Was this article helpful?

What's Next

getCloudMysqlBackupDetailList

Table of contents

Request
Response