MENU
      getDbServerLogList

        getDbServerLogList


        Article summary

        Available in Classic.

        Overview

        Search the list of Cloud DB database server logs.

        Requests

        Request headers

        HeaderDescription
        x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC, and if the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-apigw-api-keyKey value issued by Gateway; api-key is not used when using v2
        x-ncp-apigw-api-key:{API Gateway API Key}
        x-ncp-iam-access-keyAccess Key ID value issued by the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeThe request body content type is specified as application/json
        Content-Type: application/json

        Request bodies

        API field names in the request body are case sensitive.

        ParametersRequirement statusTypeRestrictionsDescription
        regionNoNStringRegion number
        dbKindCodeYStringMYSQLDB type code
        cloudDBInstanceNoYString- Instance number of the created MySQL server
        - You can obtain it through getCloudDBInstanceList
        cloudDBServerInstanceNoYString- Instance number of the Cloud DB for MySQL
        - You can obtain it through getCloudDBInstanceList
        logTypeYStringBINARY, ERROR, SLOW, GENERALDatabase server log file type
        responseFormatTypeNStringxml, jsonFormat type of the response result
        Default: xml
        • regionNo
        • dbKindCode
          • Selects the type of CloudDB to search. You can only select MySQL.
        • cloudDBInstanceNo
        • cloudDBServerInstanceNo
        • LogType
          • Specifies the database server log file type. You can select from BINARY, ERROR, SLOW, and GENERAL.
        • responseFormatType
          • Determines the format to receive the API execution results as a response. You can select between xml and json.

        Responses

        FieldTypeDescriptionNote
        requestIdStringRequest ID value
        returnCodeIntegerResponse code value
        returnMessageStringResponse message
        totalRowsIntegerNumber of rows in response results
        cloudDBServerLogList[]StringDB server log listCloudDBServerLogList
        • CloudDBServerLog
        FieldTypeDescriptionNote
        fileNameStringFile name
        fileDateDateFile date
        fileSizeLongFile size

        Examples

        Request examples

        GET {API_URL}/getDbServerLogList
        ?regionNo=1
        &dbKindCode=MYSQL
        &cloudDBInstanceNo=15101399
        &cloudDBServerInstanceNo=15101410
        &logType=BINARY
        &responseFormatType=XML
        HTTP

        Request sample

        {
          "regionNo": "1",
          "dbKindCode": "MYSQL",
          "cloudDBInstanceNo": "15101399",
          "cloudDBServerInstanceNo": "15101410",
          "logType": "BINARY",
          "responseFormatType": "XML"
        }
        JSON

        Response examples

        connection: keep-alive
        content-type: application/xml;charset=UTF-8
        date: Mon, 12 Dec 2022 06:32:04 GMT
        server: nginx
        transfer-encoding: chunked
        x-ncp-apigw-response-origin: ENDPOINT
        x-ncp-trace-id: 6cp3664oj8cpl62phhclhjgdr4
        HTTP
        <getDbServerLogListResponse>
          <requestId>e604306e-7e5a-47ba-9e9f-be6f67e5946c</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <cloudDbServerLogList>
            <cloudDbServerLog>
             <fileName>mysql-bin.000001</fileName>
             <fileSize>8038</fileSize>
             <fileDate>2022-12-12T14:38:23+0900</fileDate>
            </cloudDbServerLog>
          </cloudDbServerLogList>
        </getDbServerLogListResponse>
        XML

        Error code

        If a wrong Cloud DB API request is sent, or an error occurs during its processing, then the success/failure result is returned as an HTTP status code. The detailed message is then returned in the form of JSON.

        There are two types or errors: Cloud DB API's "common errors" and "API Gateway errors."

        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.