DescribeDataSharePerformance - AnalyticDB

Queries the information about data sharing performance metrics.

Operation description

You can call this operation to query the details of data sharing performance metrics for an AnalyticDB for PostgreSQL instance in Serverless mode, such as the number of shared topics and the amount of data shared.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDataSharePerformance	get	DBInstance acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	This parameter is no longer used.	rg-bp67acfmxazb4p****
Key	string	Yes	The name of the performance metric. Separate multiple values with commas (,). Valid values: adbpg_datashare_topic_count: the number of shared topics. adbpg_datashare_data_size_mb: the amount of data shared.	adbpg_datashare_topic_count
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2022-08-03T15:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2022-08-03T15:10Z
RegionId	string	Yes	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end time of the query.	2022-08-03T15:10Z
RequestId	string	The ID of the request.	BBE00C04-A3E8-4114-881D-0480A72CB92E
StartTime	string	The start time of the query.	2022-08-03T15:00Z
DBClusterId	string	The ID of the instance.	gp-bp12ga6v69h86****
PerformanceKeys	array<object>	Details of data sharing performance metrics.
PerformanceItem	object
Name	string	The name of the performance metric.	adbpg_datashare_topic_count
Unit	string	The unit of the performance metric.	int
Series	array<object>	Details of the performance metric.
SeriesItem	object
Values	array<object>	One or more values of the performance metric.
Values	object
Point	array	The value of the performance metric at a point in time.
Point	string		2022-08-03T07:01:00+08:00, 5.00
Name	string	The name of the performance metric.	adbpg_datashare_topic_count

Examples

Sample success responses

JSONformat

{
  "EndTime": "2022-08-03T15:10Z",
  "RequestId": "BBE00C04-A3E8-4114-881D-0480A72CB92E",
  "StartTime": "2022-08-03T15:00Z",
  "DBClusterId": "gp-bp12ga6v69h86****",
  "PerformanceKeys": [
    {
      "Name": "adbpg_datashare_topic_count",
      "Unit": "int",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "2022-08-03T07:01:00+08:00,  5.00"
              ]
            }
          ],
          "Name": "adbpg_datashare_topic_count"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history