All Products
Search
Document Center

Platform For AI:ListVirtualResource

Last Updated:Nov 22, 2024

Queries a list of virtual resource groups for the current user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eas:ListVirtualResourceslist
*VirtualResource
acs:eas:{#regionId}:{#accountId}:virtualresource/*
    none
none

Request syntax

GET /api/v2/virtualresources HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 100.

20
VirtualResourceIdstringNo

The ID of the virtual resource group.

eas-vr-npovr28onap1xxxxxx
VirtualResourceNamestringNo

The name of the virtual resource group.

MyVirtualResource

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

40325405-579C-4D82****
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

100
VirtualResourcesarray<object>

The list of virtual resource groups.

VirtualResourcesobject

The details of the virtual resource group.

VirtualResourceNamestring

The name of the virtual resource group.

MyVirtualResource
VirtualResourceIdstring

The ID of the virtual resource group.

eas-vr-npovr28onap1xxxxxx
CreateTimestring

The time when the virtual resource group was created.

2024-10-16T17:52:49Z
UpdateTimestring

The time when the virtual resource group was last updated.

2024-10-16T19:52:49Z

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

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