Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Host Monitoring/ Querying Table Skew or Dirty Page Rate Information
Updated on 2024-04-18 GMT+08:00

Querying Table Skew or Dirty Page Rate Information

Function

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

Call Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/dms/tables/statistic
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

rate_type

Yes

String

Type of information to be queried. This parameter is set to a fixed value.

  • skew: table skew rate.
  • dirtyPage: dirty page rate

offset

Yes

Integer

Offset from which the query starts, which is greater or equal to 0.

limit

Yes

Integer

Number of records displayed per page.

order_by

No

String

Sorting field This parameter is set to a fixed value.

  • table_size: table size.
  • rate: table skew rate or dirty page rate.

sort_by

No

String

Ascending or descending. This parameter is set to a fixed value.

  • ASC: ascending
  • DESC: descending

filter

No

String

Query condition. This parameter is set to a fixed value.

  • db_name: database name
  • schema_name: schema name
  • table_name: table name.
  • table_owner: table owner

value

No

String

Value of a query condition.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

collect_time

Long

Millisecond-level timestamp of the data collection time

data

Array of ListTablesStatisticDto objects

List of table skew rates or dirty page rates

count

Integer

Total list size

Table 4 ListTablesStatisticDto

Parameter

Type

Description

db_name

String

Database name

schema_name

String

Schema name

table_name

String

Table name

table_owner

String

Table owner

table_size

String

Table size

skew_rate

Double

Skew rate

dirty_page_rate

Double

Dirty page rate

Example Request

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 Response

Status code: 200

{
  "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
}

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListTablesStatisticSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTablesStatisticRequest request = new ListTablesStatisticRequest();
        request.withRateType("<rate_type>");
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withOrderBy("<order_by>");
        request.withSortBy("<sort_by>");
        request.withFilter("<filter>");
        request.withValue("<value>");
        try {
            ListTablesStatisticResponse response = client.listTablesStatistic(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTablesStatisticRequest()
        request.rate_type = "<rate_type>"
        request.offset = <offset>
        request.limit = <limit>
        request.order_by = "<order_by>"
        request.sort_by = "<sort_by>"
        request.filter = "<filter>"
        request.value = "<value>"
        response = client.list_tables_statistic(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTablesStatisticRequest{}
	request.RateType = "<rate_type>"
	request.Offset = int32(<offset>)
	request.Limit = int32(<limit>)
	orderByRequest:= "<order_by>"
	request.OrderBy = &orderByRequest
	sortByRequest:= "<sort_by>"
	request.SortBy = &sortByRequest
	filterRequest:= "<filter>"
	request.Filter = &filterRequest
	valueRequest:= "<value>"
	request.Value = &valueRequest
	response, err := client.ListTablesStatistic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The table skew rate/dirty page rate is queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.