GetResourceGroupStatistics-阿里云帮助中心

A resource group provides a set of dedicated machine resources for Platform for AI (PAI). These resources run your PAI computing tasks and Data Science Workshop (DSW) instances. This operation retrieves statistics about the current and historical statuses of DSW instances in a specified resource group, such as the number of succeeded, failed, and stopped instances. These statistics help you understand your task history and optimize resource usage.

Operation description

You can specify workspace IDs, a resource group ID, and a time range to retrieve statistics about the running status of DSW instances in the specified workspaces and resource group.

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

paidsw:GetResourceGroupStatistics

get

*All Resource

*

None

Request syntax

GET /api/v2/resourcegroupstatistics HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceIds	string	Yes	The IDs of workspaces. Separate multiple IDs with a comma (,). For more information about how to obtain a workspace ID, see ListWorkspaces.	27218,34956
ResourceId	string	Yes	The ID of the resource group (machine group).	rg-123456789
StartTime	string	Yes	The start of the time range for the statistics.	2020-11-08T15:00:00Z
EndTime	string	Yes	The end of the time range for the statistics.	2020-11-08T15:00:00Z

Response elements

Element	Type	Description	Example
	object	The statistics of the resource group.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The returned message.	"XXX"
Code	string	The status code. Valid values: InternalError: An internal error occurred. All errors other than parameter validation errors are classified as internal errors. ValidationError: A parameter is invalid.	InternalError
HttpStatusCode	integer	The HTTP status code. Valid values: 400 404	400
Statistics	object	The statistics.
	object	Running: 3: Three DSW instances are running. Stopped: 4: Four DSW instances are stopped.
	integer	The value of the statistic.	5

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "InternalError",
  "HttpStatusCode": 400,
  "Statistics": {
    "key": {
      "key": 5
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.