ListVirtualResource - Platform For AI - Alibaba Cloud Documentation Center

Queries the virtual resource groups for the current user.

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

eas:ListVirtualResource

list

*VirtualResource

acs:eas:{#regionId}:{#accountId}:virtualresource/*

None

Request syntax

GET /api/v2/virtualresources HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number for the list of virtual resource groups. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of virtual resource groups to display on each page. The default value is 100.	20
VirtualResourceId	string	No	The ID of the virtual resource group.	eas-vr-npovr28onap1xxxxxx
VirtualResourceName	string	No	The name of the virtual resource group.	MyVirtualResource
Sort	string	No	The field that is used to sort the results. By default, the results are sorted by timestamp in descending order. Valid values: VirtualResourceName : The name of the virtual resource. CreateTime : The time when the resource was created. UpdateTime : The time when the resource was last updated.	CreateTime
Order	string	No	The sorting order. Valid values: Desc: Descending order. Asc: Ascending order. Valid values: Asc : Ascending order. Desc : Descending order.	Desc

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	40325405-579C-4D82****
PageNumber	integer	The page number of the returned list of virtual resource groups.	1
PageSize	integer	The number of virtual resource groups returned on each page.	20
TotalCount	integer	The total number of virtual resource groups.	100
VirtualResources	array<object>	The list of virtual resource groups.
	object	The details of a virtual resource group.
VirtualResourceName	string	The name of the virtual resource group.	MyVirtualResource
VirtualResourceId	string	The ID of the virtual resource group.	eas-vr-npovr28onap1xxxxxx
CreateTime	string	The time when the virtual resource group was created.	2024-10-16T17:52:49Z
UpdateTime	string	The time when the virtual resource group was last updated.	2024-10-16T19:52:49Z
ServiceCount	integer	The number of deployed services.	1

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 100,
  "VirtualResources": [
    {
      "VirtualResourceName": "MyVirtualResource",
      "VirtualResourceId": "eas-vr-npovr28onap1xxxxxx\n",
      "CreateTime": "2024-10-16T17:52:49Z\n",
      "UpdateTime": "2024-10-16T19:52:49Z\n",
      "ServiceCount": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.