Querying Table Skew Rate or Dirty Page Rate

Function

This API is used to query the table skew rate or dirty page rate.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/dms/tables/statistic

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
rate_type	Yes	String	Definition Query type. The value is fixed. Constraints N/A Range skew: table skew rate dirtyPage: dirty page rate Default Value N/A
offset	Yes	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0
limit	Yes	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value No limit.
order_by	No	String	Definition Sorting field. The value is fixed. Constraints N/A Range table_size: table size rate: table skew rate or dirty page rate Default Value N/A
sort_by	No	String	Definition Whether the order is ascending or descending. The value is fixed. Constraints N/A Range ASC DESC Default Value N/A
filter	No	String	Definition Query criteria. The value is fixed. Constraints N/A Range db_name schema_name table_name table_owner Default Value N/A
value	No	String	Definition Value of a filter criterion. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
collect_time	Long	Definition Data collection timestamp, in ms. Range N/A
data	Array of ListTablesStatisticDto objects	Definition List of table skew rates or dirty page rates. Range N/A
count	Integer	Definition Total number of rows in the list. Range N/A

**Table 4** ListTablesStatisticDto
Parameter	Type	Description
db_name	String	Definition Database name. Range N/A
schema_name	String	Definition Schema name. Range N/A
table_name	String	Definition Table name. Range N/A
table_owner	String	Definition Table owner. Range N/A
table_size	String	Definition Table size. Range N/A
skew_rate	Double	Definition Skew rate. Range N/A
dirty_page_rate	Double	Definition Dirty page rate. Range N/A

Example Requests

https://{Endpoint}/v1/{project_id}/clusters/{cluster_id}/dms/tables/statistic?rate_type=dirtyPage&filter=&value=&offset=0&limit=1&order_by=&sort_by=ASC

Example Responses

Status code: 200

Query succeeded.

{
  "collect_time" : 0,
  "data" : [ {
    "db_name" : "postgres",
    "schema_name" : "pmk",
    "table_name" : "pmk_snapshot_coordinator_stat",
    "table_owner" : "Ruby",
    "table_size" : "224 KB",
    "skew_rate" : null,
    "dirty_page_rate" : 0.77
  } ],
  "count" : 3
}

Status Codes

Status Code	Description
200	Query succeeded.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.