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 parameters

Parameter Type Required Example Description
Action String Required ListResourceGroups

The operation that you want to perform.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

ResourceGroupType Integer Yes 3

The type of the resource group. Valid values: 0(DataWorks), 2(MaxCompute), 3(PAI), 4 (data integration), 7 (schedule), and 8(AppStudio).

Keyword String No abc

The keyword to specify.

Response parameters

Parameter Type Example Description
Data Array of Data

The list of resource groups.

BizExtKey String default

The extended field for the resource group.

Cluster String AY18G

The name of the cluster.

CreateTime String Jul 9, 2018 2:43:37 PM

The time when the cluster was created.

EnableKp Boolean false

Specifies whether to use Kp for access.

Id Long 1234567

The ID of the resource group.

Identifier String e1815577-2f4e-4c5e-b29****

The name of a resource group.

IsDefault Boolean true

Indicates whether the resource group is the default resource group.

Mode String SHARE

The type of the resource group. Valid values: ISOLATE (pre-payment exclusive), SHARE (shared), and DEVELOP (developer version).

Name String abc

The alias of a resource group.

ResourceGroupType String PAI

The type of the resource group.

Sequence Integer 300

Sequence.

Specs Map {}

The details of the exclusive resource group.

Status Integer 0

The status of the exclusive resource group.

TenantId Long 1234567

The ID of the tenant.

UpdateTime String Jul 9, 2018 2:43:37 PM

The last update time.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0bc1411515937635973****

The ID of the request.

Success Boolean true

Indicates whether the request is successful. A value of true indicates that the request is successful. A value of false indicates that the request has failed.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListResourceGroups
&RegionId=cn-shanghai
&ResourceGroupType=3
&<Common request parameters>

Sample success responses

XML format

<RequestId>0bc1411515937635973****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <IsDefault>true</IsDefault>
    <Status>0</Status>
    <Mode>SHARE</Mode>
    <CreateTime>Jul 9, 2018 2:43:37 PM</CreateTime>
    <Cluster>AY18G</Cluster>
    <Sequence>300</Sequence>
    <ResourceGroupType>PAI</ResourceGroupType>
    <Name>abc</Name>
    <TenantId>1234567</TenantId>
    <Identifier>e1815577-2f4e-4c5e-b29****</Identifier>
    <EnableKp>false</EnableKp>
    <BizExtKey>default</BizExtKey>
    <UpdateTime>Jul 9, 2018 2:43:37 PM</UpdateTime>
    <Id>1234567</Id>
    <Specs>{}</Specs>
</Data>
<Success>true</Success>

JSON format

{
    "RequestId": "0bc1411515937635973****",
    "HttpStatusCode": 200,
    "Data": {
        "IsDefault": true,
        "Status": 0,
        "Mode": "SHARE",
        "CreateTime": "Jul 9, 2018 2:43:37 PM",
        "Cluster": "AY18G",
        "Sequence": 300,
        "ResourceGroupType": "PAI",
        "Name": "abc",
        "TenantId": 1234567,
        "Identifier": "e1815577-2f4e-4c5e-b29****",
        "EnableKp": false,
        "BizExtKey": "default",
        "UpdateTime": "Jul 9, 2018 2:43:37 PM",
        "Id": 1234567,
        "Specs": "{}"
    },
    "Success": true
}

Error codes

HttpCode Error code Error message Description
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The data source does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The error message returned because the specified project does not exist.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The user is not the project owner or project administrator.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The user is not in the project.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. User is not in tenant.

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