DescribeVirtualResource - Platform For AI - Alibaba Cloud Documentation Center

Queries the details of a virtual 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

eas:DescribeVirtualResource

get

*VirtualResource

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

None

Request syntax

GET /api/v2/virtualresources/{ClusterId}/{VirtualResourceId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region where the virtual resource group is located.	cn-shanghai
VirtualResourceId	string	Yes	The ID of the virtual resource group.	eas-vr-npovr28onap1xxxxxx

Response elements

Element	Type	Description	Example
	object	The details of the virtual resource group.
RequestId	string	The request ID.	40325405-579C-4D82****
Resources	array<object>	The list of resources in the virtual resource group.
	object	The details of the resource.
Region	string	The region where the resource is located.	cn-hangzhou
Priority	integer	The scheduling priority of the resource. A larger value indicates a higher priority.	3
InstanceType	string	The instance type of the public resource group.	ecs.s6-c1m2.xlarge
QuotaId	string	The ID of the Lingjun resource quota.	quota185lqxxxxxx
SpotPriceLimit	number	The maximum price for a spot instance in the public resource group.	10.05
ResourceId	string	The ID of the dedicated resource group.	eas-r-g55ieatgg3buxxxxxx
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
VirtualResourceId	string	The ID of the virtual resource group.	eas-vr-npovr28onap1xxxxxx
VirtualResourceName	string	The name of the virtual resource group.	MyVirtualResource
ServiceCount	integer	The number of deployed services.	1
DisableSpotProtectionPeriod	boolean	Indicates whether the protection period for spot instances is disabled.	true
Features	array	The collection of features for the virtual resource group. This identifies the attributes that the resource group supports.
	string	The specific attributes that the virtual resource group supports. Currently, only GpuShare (GPU sharing) is supported.	GpuShare

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Resources": [
    {
      "Region": "cn-hangzhou",
      "Priority": 3,
      "InstanceType": "ecs.s6-c1m2.xlarge\n",
      "QuotaId": "quota185lqxxxxxx\n",
      "SpotPriceLimit": 10.05,
      "ResourceId": "eas-r-g55ieatgg3buxxxxxx\n"
    }
  ],
  "CreateTime": "2024-10-16T17:52:49Z\n",
  "UpdateTime": "2024-10-16T19:52:49Z\n",
  "VirtualResourceId": "eas-vr-npovr28onap1xxxxxx\n",
  "VirtualResourceName": "MyVirtualResource\n",
  "ServiceCount": 1,
  "DisableSpotProtectionPeriod": true,
  "Features": [
    "GpuShare"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.