Queries resource groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request header. For more information, see Common request parameters.

Request syntax

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

Request parameters

No request parameters.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code.
Message String success

The returned message that indicates whether the request is successful.
RequestId String b197-40ab-9155-7ca7

The ID of the request.
ResourceGroupList Array of ResGroupEntity

For more information about how to define a resource group, see ResGroupEntity.
ResGroupEntity
AdminUserId String ****@aliyun.com

The unique ID of the user.
CreateTime Long 1557890594376

The time when the resource group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Description String QqLZDA3pBZ

The description of the resource group.
Id Long 8592

The ID of the resource group.
Name String TIa2LGixyD

The name of the resource group.
RegionId String cn-qingdao

The ID of the region.
SlbList Array of SlbEntity

The Server Load Balancer (SLB) instances.
SlbEntity
Address String 192.168.xxx.xx

The IP address of the SLB instance.
AddressType String Intranet

The type of the IP address of the SLB instance.

  • Internet: Users can connect to the SLB instance over the Internet.
  • Intranet: Users can connect to the SLB instance over the internal network.
Expired Boolean true

Indicates whether the SLB instance has expired.
GroupId Integer 641897243

The ID of the group to which the SLB instance belongs.
NetworkType String vpc

The network type of the SLB instance. Valid values:

  • Classic network
  • VPC
RegionId String cn-beijing

The ID of the region.
SlbId String lb-2zebf1fpbpkc7dnro****

The unique ID of the SLB instance.
SlbName String a9315af59b4cd11e9a18c00163e1****

The name of the SLB instance.
SlbStatus String active

The status of the SLB instance.
UserId String ****@aliyun.com

The unique ID of the user.
VpcId String vpc-m5e666n89m2bx8jar****

VPC ID
VswitchId String vsw-mxxxxkxxxx4xxxxwbionj

The ID of the vSwitch.
UpdateTime Long 1573281040827

The time when the resource group was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

ecsList Array of EcsEntity

The Elastic Compute Service (ECS) instances.
EcsEntity
Cpu Integer 2

The total number of CPUs.
Description String test

The description of the ECS instance.
EcuEntity Struct

The elastic compute unit (ECU) that corresponds to the ECS instance.
AvailableCpu Integer 1

The number of available CPUs.
AvailableMem Integer 200

The size of available memory.
Cpu Integer 2

The total number of CPUs.
CreateTime Long 1557890594376

The time when the ECS instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

DockerEnv Boolean true

Indicates whether Docker was installed. Valid values:

  • true: Docker was installed.
  • false: Docker was not installed.
EcuId String 0de2ebdb-9490-4fc4-be41***************

The unique ID of the ECU. To query the ID, you can run the dmidecode command on the ECS instance that corresponds to the ECU.

HeartbeatTime Long 1573281040819

The time when the last heartbeat detection was performed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

InstanceId String i-2zej4i2jdf*********

The ID of the ECS instance.
IpAddr String 192.168.xxx.xx

The internal IP address allocated to the ECU.
Mem Integer 200

The total size of memory. Unit: MB.

Name String test

The name of the ECU.
Online Boolean true

Indicates whether the ECU is online.

  • true: The ECU is online.
  • false: The ECU is offline.
RegionId String cn-beijing

The ID of the region.
UpdateTime Long 1573281040827

The time when the ECU was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

UserId String edas_****_test@aliyun-****.com

The ID of the user associated with the ECU.
VpcId String vpc-2ze1ram356umxs598****

The ID of the VPC.
ZoneId String cn-beijing-b

The ID of the zone.
Eip String 130.30.xx.xxx

The elastic IP address (EIP).
Expired Boolean true

Indicates whether the ECS instance has expired.

  • true: The ECS instance has expired.
  • false: The ECS instance has not expired.
GroupId String 0

The ID of the Enterprise Distributed Application Service (EDAS) resource group.
HostName String iZm5e853hvvrodnvqus****

The name of the host.
InnerIp String 192.168.xx.xxx

The internal IP address.
InstanceId String i-m5e853hvvrodnvqu****

The ID of the ECS instance.
InstanceId String i-m5e853hvvrodnvqu****

The ID of the ECS instance.
InstanceName String betabjmixcoud_01

The name of the ECS instance.
Mem Integer 1

The total size of memory for the ECS instance. Unit: MB.

PrivateIp String 192.168.xx.xxx

The private IP address of the ECS instance.
PublicIp String 130.30.xx.xxx

The public IP address of the ECS instance.
RegionId String ch-hangzhou

The ID of the region.
SerialNum String 98b480b8-458b-4ff3-84b9-cf7097c5****

The serial number of the ECS instance.
SgId String sg-m5eajgzn6b8sg9mv****

The ID of the security group to which the ECS instance belongs.
Status String Running

The status of the ECS instance. Valid values:

  • Pending
  • Running
  • Starting
  • Stopping
  • Stopped
UserId String ****_common_****@aliyun.com

The ID of the user.
VpcEntity Struct

The VPCs.
Cidrblock String 130.30

The IPv4 CIDR block of the vSwitch.
Description String ""

The description of the VPC.
EcsNum Integer 1

The number of ECS instances that runs in the VPC.
Expired Boolean true

Indicates whether the VPC has expired.
RegionId String cn-qingdao

The ID of the region.
Status String Running

The status of the instance.
UserId String ****_common_****@aliyun.com

The ID of the user.
VpcId String vpc-bp13evu4aayj2t1er****

The unique ID of the VPC.
VpcName String test

The name of the VPC.
VpcId String vpc-bp13evu4aayj2t1er****

The unique ID of the VPC.
ZoneId String cn-qingdao-h

The ID of the zone.

Examples

Sample requests

POST /pop/v5/resource/reg_group_list HTTP/1.1
Common request header

Sample success responses

XML format 

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

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.