ListResourceGroups - API参考| 阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListResourceGroups	要执行的操作。
RegionId	String	是	cn-shanghai	DataWorks工作空间所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
ResourceGroupType	Integer	是	3	需要查看的资源组类型。取值如下： 0（DataWorks） 1（调度） 2（MaxCompute） 3（PAI） 4（数据集成） 8（AppStudio） 9 （dataService）当取值表示引擎时，查看的资源组列表为购买该类型引擎时创建的资源组列表。
Keyword	String	否	abc	关键字。用于模糊查询资源组名称和资源组标识。
BizExtKey	String	否	default	资源组的类别。取值如下： default，公共资源组。 single，独享资源组。

返回数据


名称	类型	示例值	描述
Data	Array of Data		资源组列表。
BizExtKey	String	default	资源组的类别。取值如下： default，公共资源组。 single，独享资源组。
Cluster	String	AY18G	集群的名称。该参数仅对于MaxCompute和PAI资源组类型生效。
CreateTime	String	Jul 9, 2018 2:43:37 PM	创建集群的时间。格式示例为Jul 9, 2018 2:43:37 PM。
EnableKp	Boolean	false	是否使用Kp（关键人）访问。取值如下： true：表示MaxCompute引擎使用阿里云账号UID作为访问账户的显示名称。 false：表示MaxCompute引擎使用阿里云账号名称作为访问账户的显示名称。其余类型无意义。该参数仅对MaxCompute引擎生效。
Id	Long	1234567	资源组的ID。
Identifier	String	e1815577-2f4e-4c5e-b29****	资源组的标识。
IsDefault	Boolean	true	是否为默认资源组。取值如下： true：是默认资源组。 false：非默认资源组。
Mode	String	SHARE	资源组的类型。取值如下： ISOLATE：表示预付费的独享资源组。 SHARE：表示后付费的公共资源组。 DEVELOP：表示开发者版本。
Name	String	abc	资源组的名称。
ResourceGroupType	String	3	资源组的类型。取值如下： 0（DataWorks） 2（MaxCompute） 3（PAI） 4（数据集成） 7（调度） 8（AppStudio） 9 （dataService）
Sequence	Integer	300	序列字段。用于将已创建的资源组按照创建的序号从小到大升序排序。
Specs	Map	{}	资源组的详细信息。{}中显示的内容为资源组的详细信息。
Status	Integer	0	资源组的状态。取值如下： NORMAL(0)，表示资源组状态正常，处于运行中或服务中。 STOP(1)，表示资源组已到期，处于冻结状态。 DELETED(2)，表示资源组已被释放或销毁。 CREATING(3)，表示资源组正在创建或启动。 CREATE_FAILED(4)，表示资源组创建或启动失败。 UPDATING(5)，表示资源组正在扩容或升级。 UPDATE_FAILED(6)，表示资源组扩容或升级失败。 DELETING(7)，表示资源组正在被释放或销毁。 DELETE_FAILED(8)，表示资源组释放或销毁失败。 TIMEOUT(9)，表示对资源组执行的操作超时。所有变更操作均可能会超时，该枚举值暂时仅提供给数据服务使用。
TenantId	Long	1234567	租户ID。
UpdateTime	String	Jul 9, 2018 2:43:37 PM	最近一次更新资源组的时间。
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	0bc1411515937635973****	请求ID。用于定位日志，排查问题。
Success	Boolean	true	请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListResourceGroups
&RegionId=cn-shanghai
&ResourceGroupType=3
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0bc1411515937635973****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Status>0</Status>
    <IsDefault>true</IsDefault>
    <CreateTime>Jul 9, 2018 2:43:37 PM</CreateTime>
    <Mode>SHARE</Mode>
    <Cluster>AY18G</Cluster>
    <Sequence>300</Sequence>
    <ResourceGroupType>3</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格式

{
    "RequestId": "0bc1411515937635973****",
    "HttpStatusCode": 200,
    "Data": {
        "Status": 0,
        "IsDefault": true,
        "CreateTime": "Jul 9, 2018 2:43:37 PM",
        "Mode": "SHARE",
        "Cluster": "AY18G",
        "Sequence": 300,
        "ResourceGroupType": 3,
        "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
}

错误码


HttpCode	错误码	错误信息	描述
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	数据源不存在。
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	项目不存在。
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	用户不是项目负责人或者项目管理员。
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	用户不在项目中。
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	用户不在租户中。

访问错误中心查看更多错误码。