ListResourceGroup - Query EDAS resource groups - Enterprise Distributed Application Service

Queries resource groups.

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.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

edas:ListResourceGroup

list

*All Resource

*

None

Request syntax

POST /pop/v5/resource/reg_group_list HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

No request parameters.

Response elements

Element	Type	Description	Example
	object	The response body.
Code	integer	The HTTP status code.	200
Message	string	Additional information.	success
RequestId	string	The ID of the request.	b197-40ab-9155-****
ResourceGroupList	object
ResGroupEntity	array<object>	The resource group definitions.
	array<object>	The resource group details.
UpdateTime	integer	The time when the resource group was last updated. UNIX timestamp, in milliseconds.	1573281040827
Description	string	The description of the resource group.	QqLZDA3pBZ
AdminUserId	string	The UID of the Alibaba Cloud account.	****@aliyun.com
CreateTime	integer	The time when the resource group was created. UNIX timestamp, in milliseconds.	1557890594376
Name	string	The name of the resource group.	TIa2LGixyD
Id	integer	The ID of the resource group.	8592
RegionId	string	The region ID of the resource group.	cn-qingdao
ecsList	object
EcsEntity	array<object>	The ECS instances.
	array<object>	The ECS instance details.
VpcId	string	The VPC ID.	vpc-bp13evu4aayj2t1er****
SgId	string	The ID of the security group.	sg-m5eajgzn6b8sg9mv****
Status	string	The status of the ECS instance. Valid values: Pending: The ECS instance is being created. Running: The ECS instance is running. Starting: The ECS instance is being started. Stopping: The ECS instance is being stopped. Stopped: The ECS instance is stopped.	Running
PrivateIp	string	The private IP address of the ECS instance.	192.168.xx.xxx
Expired	boolean	Whether the ECS instance has expired. Valid values: true: The ECS instance has expired. false: The ECS instance has not expired.	true
UserId	string	The ID of the user account.	**_common_**@aliyun.com
HostName	string	The hostname.	iZm5e853hvvrodnvqus****
InstanceId	string	The ID of the ECS instance.	i-m5e853hvvrodnvqu****
Mem	integer	The total size of memory. Unit: MB.	1
RegionId	string	The ID of the region.	ch-hangzhou
Cpu	integer	The total number of CPU cores.	2
InnerIp	string	The private IP address.	192.168.xx.xxx
GroupId	string	The EDAS resource group ID.	64189****
Eip	string	The EIP.	192.168.xxx.xx
Description	string	The description of the ECS instance.	test
InstanceName	string	The name of the ECS instance.	betabjmixcoud_01
ZoneId	string	The ID of the zone.	cn-qingdao-h
SerialNum	string	The serial number of the ECS instance.	98b480b8-458b-4ff3-84b9-cf7097c5****
PublicIp	string	The public IP address.	192.168.xx.xxx
EcuEntity	object	The ECU associated with the ECS instance.
VpcId	string	The ID of the VPC.	vpc-2ze1ram356umxs598****
UpdateTime	integer	The time when the ECU was last updated. UNIX timestamp, in milliseconds.	1573281040827
IpAddr	string	The private IP address of the ECU.	192.168.xxx.xx
AvailableCpu	integer	The number of available CPUs.	1
CreateTime	integer	The time when the ECU was created. UNIX timestamp, in milliseconds.	1557890594376
UserId	string	The ID of the user associated with the ECU.	edas_**_test@aliyun-**.com
InstanceId	string	The ID of the instance.	i-2zej4i2jdf*********
Mem	integer	The total size of memory. Unit: MB.	200
RegionId	string	The ID of the region.	cn-beijing
EcuId	string	The ECU ID. Run `dmidecode` on the ECS instance to query this value.	0de2ebdb-9490-4fc4-be41***************
Cpu	integer	The total number of CPU cores.	2
DockerEnv	boolean	Whether Docker is installed. Valid values: true: Docker is installed. false: Docker is not installed.	true
Online	boolean	Whether the ECU is online. Valid values: true: The ECU is online. false: The ECU is offline.	true
AvailableMem	integer	The size of the available memory.	200
ZoneId	string	The ID of the zone.	cn-beijing-b
Name	string	The name of the ECU.	test
HeartbeatTime	integer	The time of the last heartbeat. UNIX timestamp, in milliseconds.	1573281040819
VpcEntity	object	The VPCs.
Status	string	The status of the VPC.	Running
VpcName	string	The name of the VPC.	test
VpcId	string	The VPC ID.	vpc-bp13evu42t1er****
Description	string	The description of the VPC.	""
Expired	boolean	Whether the VPC has expired. Valid values: true: The VPC has expired. false: The VPC has not expired.	true
Cidrblock	string	The IPv4 CIDR block of the vSwitch.	192.168.xx.xxx
UserId	string	The ID of the user.	**_common_**@aliyun.com
EcsNum	integer	The number of ECS instances that run in the VPC.	1
RegionId	string	The ID of the region.	cn-qingdao
SlbList	object
SlbEntity	array<object>	The SLB instances.
	object	The SLB instance details.
SlbId	string	The SLB instance ID.	lb-2zebf1fpbpkc7dnro****
VpcId	string	The ID of the VPC.	vpc-m5e666n89m2bx8jar****
VswitchId	string	The ID of the vSwitch.	vsw-mktkxkhah14****
Expired	boolean	Whether the SLB instance has expired. Valid values: true: The SLB instance has expired. false: The SLB instance has not expired.	true
UserId	string	The UID of the Alibaba Cloud account.	****@aliyun.com
AddressType	string	The SLB address type. Valid values: Internet: Users can connect to the SLB instance over the Internet. Intranet: Users can connect to the SLB instance over the internal network.	Intranet
NetworkType	string	The SLB network type. Valid values: Classic network VPC	vpc
RegionId	string	The ID of the region.	cn-beijing
GroupId	integer	The resource group ID of the SLB instance.	64189****
Address	string	The IP address of the SLB instance.	192.168.xxx.xx
SlbName	string	The name of the SLB instance.	a9315af59b4cd11e9a18c00163e1****
SlbStatus	string	The status of the SLB instance.	active

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "ResourceGroupList": {
    "ResGroupEntity": [
      {
        "UpdateTime": 1573281040827,
        "Description": "QqLZDA3pBZ",
        "AdminUserId": "****@aliyun.com",
        "CreateTime": 1557890594376,
        "Name": "TIa2LGixyD",
        "Id": 8592,
        "RegionId": "cn-qingdao",
        "ecsList": {
          "EcsEntity": [
            {
              "VpcId": "vpc-bp13evu4aayj2t1er****",
              "SgId": "sg-m5eajgzn6b8sg9mv****",
              "Status": "Running",
              "PrivateIp": "192.168.xx.xxx",
              "Expired": true,
              "UserId": "****_common_****@aliyun.com",
              "HostName": "iZm5e853hvvrodnvqus****",
              "InstanceId": "i-m5e853hvvrodnvqu****",
              "Mem": 1,
              "RegionId": "ch-hangzhou",
              "Cpu": 2,
              "InnerIp": "192.168.xx.xxx",
              "GroupId": "64189****",
              "Eip": "192.168.xxx.xx",
              "Description": "test",
              "InstanceName": "betabjmixcoud_01",
              "ZoneId": "cn-qingdao-h",
              "SerialNum": "98b480b8-458b-4ff3-84b9-cf7097c5****",
              "PublicIp": "192.168.xx.xxx",
              "EcuEntity": {
                "VpcId": "vpc-2ze1ram356umxs598****",
                "UpdateTime": 1573281040827,
                "IpAddr": "192.168.xxx.xx",
                "AvailableCpu": 1,
                "CreateTime": 1557890594376,
                "UserId": "edas_****_test@aliyun-****.com",
                "InstanceId": "i-2zej4i2jdf*********",
                "Mem": 200,
                "RegionId": "cn-beijing ",
                "EcuId": "0de2ebdb-9490-4fc4-be41***************",
                "Cpu": 2,
                "DockerEnv": true,
                "Online": true,
                "AvailableMem": 200,
                "ZoneId": "cn-beijing-b",
                "Name": "test",
                "HeartbeatTime": 1573281040819
              },
              "VpcEntity": {
                "Status": "Running",
                "VpcName": "test",
                "VpcId": "vpc-bp13evu42t1er****",
                "Description": "\"\"",
                "Expired": true,
                "Cidrblock": "192.168.xx.xxx",
                "UserId": "****_common_****@aliyun.com",
                "EcsNum": 1,
                "RegionId": "cn-qingdao"
              }
            }
          ]
        },
        "SlbList": {
          "SlbEntity": [
            {
              "SlbId": "lb-2zebf1fpbpkc7dnro****",
              "VpcId": "vpc-m5e666n89m2bx8jar****",
              "VswitchId": "vsw-mktkxkhah14****",
              "Expired": true,
              "UserId": "****@aliyun.com",
              "AddressType": "Intranet",
              "NetworkType": "vpc",
              "RegionId": "cn-beijing",
              "GroupId": 0,
              "Address": "192.168.xxx.xx",
              "SlbName": "a9315af59b4cd11e9a18c00163e1****",
              "SlbStatus": "active"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.