Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ Monitoring Management/ Monitoring the Read/Write Ratio
Updated on 2022-08-17 GMT+08:00
View PDF
Share

Monitoring the Read/Write Ratio

Function

This API is used to query read and write times of a DDM instance in a specified time range.

Constraints

None

URI

GET /v2/{project_id}/instances/{instance_id}/read-write-ratio?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

DDM instance ID

curPage

Yes

String

Number of records displayed on each page. The start value cannot be less than 0.

perPage

Yes

String

Page size (number of records on each page).

startDate

Yes

String

Start time in UTC, accurate to milliseconds

endDate

Yes

String

End time in UTC, accurate to milliseconds

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

totalRecord

Integer

Respective number of reads and writes on DDM

readWriteRatioList

Array of ReadWriteRatioList objects

Information about reads and writes on DDM
Table 4 ReadWriteRatioList

Parameter

Type

Description

schema

String

Schema name

table

String

Logical table name

readCount

String

Number of reads on the DDM instance within the specified period of time

writeCount

String

Number of writes on the DDM instance within the specified period of time

relationTables

String

Associated tables

lastUpdated

String

Time when the read or write statement is last executed

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/read_write_ratio?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}

Example Response

Status code: 200

OK

{
    "totalRecord": 2,
    "readWriteRatioList": [
        {
            "schema": "xxxx",
            "table": "xxxx",
            "readCount": "215",
            "writeCount": "46",
            "relationTables": "xxxx",
            "lastUpdated": "1619404869724"
        }
    ]
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: Monitoring Management