exportDbServerLogToObjectStorage
- Print
- PDF
exportDbServerLogToObjectStorage
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in Classic
Overview
Transfer Cloud DB database server log files to Object Storage.
Requests
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | It indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutesx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | Key value issued by APIGW; api-key is not used when using v2.x-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | Value of access key ID issued on NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request bodies
API field names in the request body are case sensitive.
| Parameter Name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionNo | N | String | Region number | |
| dbKindCode | Y | String | MYSQL | DB type code |
| fileName | Y | String | - Database server log file name - Can be acquired through the getDbServerLogList. | |
| bucketName | Y | String | - Object Storage bucket name - You can obtain bucketName through the ListBuckets action. | |
| cloudDBInstanceNo | Y | String | - Instance number of the created MySQL server - Value acquired through the getCloudDBInstanceList | |
| cloudDBServerInstanceNo | Y | String | - Cloud DB for MySQL server instance number - Can be acquired through the getCloudDBInstanceList. | |
| logType | Y | String | BINARY, ERROR, SLOW, GENERAL | Database server log file type |
| responseFormatType | N | String | xml, json | Format type of the response result Default : xml |
- regionNo
- It can be acquired through the getRegionList, which is the Server API.
- dbKindCode
- Selects the type of CloudDB to search. Only MySQL may be entered.
- fileName
- It can be acquired through the getDbServerLogList.
- bucketName
- Enter the name of the bucket created in the console.
- cloudDBInstanceNo
- Instance number of the created MySQL server. It can be obtained through the getCloudDBInstanceList.
- cloudDBServerInstanceNo
- Instance number of the created MySQL server. It can be obtained through the getCloudDBInstanceList.
- LogType
- Determine the database server log file type. You can select among BINARY, ERROR, SLOW, and GENERAL.
- responseFormatType
- Determines the format to receive API execution results as a response. You may select from xml and json.
Responses
| Field name | Type | Description | Remarks |
|---|---|---|---|
| requestId | String | Request ID value | |
| returnCode | Integer | Response code value | |
| returnMessage | String | Response message |
Examples
Request Examples
GET {API_URL}/exportDbServerLogToObjectStorage
?regionNo=1
&dbKindCode=MYSQL
&fileName=20221209
&bucketName=temp-bucket
&cloudDBInstanceNo=15064241
&cloudDBServerInstanceNo=15064245
&logType=BINARY
&responseFormatType=XML
Request sample
{
"regionNo": "1",
"dbKindCode": "MYSQL",
"fileName": "20221209",
"bucketName": "temp-bucket",
"cloudDBInstanceNo": "15064241",
"cloudDBServerInstanceNo": "15064245",
"logType": "BINARY",
"responseFormatType": "xml"
}
Response examples
connection: keep-alive
content-type: application/xml;charset=UTF-8
date: Fri, 09 Dec 2022 06:51:39 GMT
server: nginx
transfer-encoding: chunked
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 3ce9h6sqm2cpi6cdj460s6copg
<exportDbServerLogToObjectStorageResponse>
<requestId>e2cbeac2-1583-479a-a8a3-ed72b3c899a0</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</exportDbServerLogToObjectStorageResponse>
Errors
If the Cloud DB API request fails or an error has occurred while processing, a success or failure is returned with the HTTP status code and a detailed message is returned in JSON format.
The errors are divided into two, "common error code" of the Cloud DB API and "API Gateway error code."
| Errors | Response message | Description |
|---|---|---|
| 200 | Ok | |
| 500 | Server Error |
Was this article helpful?