DescribeDataSharePerformance-阿里云帮助中心

Queries the performance metrics of data sharing.

Operation description

Only serverless instances support the data sharing feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:DescribeDataSharePerformance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	This parameter is deprecated.	null
Key	string	Yes	The name of the performance metric. To specify multiple metrics, separate the metric names with a comma (,). Valid values: adbpg_datashare_topic_count: the number of shared topics. adbpg_datashare_data_size_mb: the size of shared data in MB.	adbpg_datashare_topic_count
StartTime	string	No	The start of the time range to query. The time must be in UTC and in the yyyy-MM-ddTHH:mmZ format.	2022-08-03T15:00Z
EndTime	string	No	The end of the time range to query. The time must be later than the start time, in UTC, and in the y**dTHH:mmZ format.	2022-08-03T15:10Z
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the available region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the queried time range.	2022-08-03T15:10Z
RequestId	string	The request ID.	BBE00C04-A3E8-4114-881D-0480A72CB92E
StartTime	string	The start of the queried time range.	2022-08-03T15:00Z
DBClusterId	string	The instance ID.	gp-bp12ga6v69h86****
PerformanceKeys	array<object>	The list of performance metrics.
	array<object>	The details of a performance metric.
Name	string	The name of the performance metric.	adbpg_datashare_topic_count
Unit	string	The unit of the performance metric.	int
Series	array<object>	The details of the time series data for the metric.
	array<object>	A time series.
Values	array<object>	The data points of the time series.
	object	A data point.
Point	array	An array that contains the timestamp and the corresponding metric value.
	string	A string that contains a timestamp and its corresponding metric value, separated by a comma.	2022-08-03T07:01:00+08:00, 5.00
Name	string	The name of the performance metric.	adbpg_datashare_topic_count

Examples

Success response

JSON format

{
  "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	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.