ListResourceGroups - - Centro de documentación de Alibaba Cloud

Consulta los resource groups de un tipo especificado.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListResourceGroups	La operación que desea ejecutar. Establezca el valor en ListResourceGroups.
ResourceGroupType	Integer	Sí	3	El tipo de resource groups que desea consultar. Valores válidos: 0: DataWorks 1: programación 2: MaxCompute 3: Platform for AI (PAI) 4: Data Integration 7: resource group exclusivo para programación (se genera un ID para el recurso adquirido cuando compra un resource group exclusivo para programación). 9: DataService Studio Valor predeterminado: 1 Si el valor indica un motor de cómputo, los resource groups consultados son aquellos creados al adquirir dicho motor.
Keyword	String	No	abc	Palabra clave utilizada para la coincidencia aproximada por nombre e identificador del resource group.
BizExtKey	String	No	default	Categoría de los resource groups. Valores válidos: default: resource group compartido single: resource group exclusivo Valor predeterminado: default
ResourceManagerResourceGroupId	String	No	rg-acfmzbn7pti3zfa	ID del resource group.
Tags	Array	No		Etiquetas.
Key	String	No	Env	Clave de la etiqueta.
Value	String	No	Test	Valor de la etiqueta.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	Código de estado HTTP devuelto.
RequestId	String	0bc1411515937635973****	ID de la solicitud. Puede usar este ID para localizar registros y solucionar problemas.
Success	Boolean	true	Indica si la solicitud se completó correctamente.
Data	Array of Data		Resource groups.
Status	Integer	0	Estado del resource group. Valores válidos: 0: NORMAL, indica que el resource group está en ejecución o en servicio. 1: STOP, indica que el resource group ha caducado y está congelado. 2: DELETED, indica que el resource group se liberó o destruyó. 3: CREATING, indica que el resource group se está creando o iniciando. 4: CREATE_FAILED, indica que hubo un error al crear o iniciar el resource group. 5: UPDATING, indica que el resource group se está escalando horizontalmente o actualizando. 6: UPDATE_FAILED, indica que hubo un error al escalar horizontalmente o actualizar el resource group. 7: DELETING, indica que el resource group se está liberando o destruyendo. 8: DELETE_FAILED, indica que hubo un error al liberar o destruir el resource group. 9: TIMEOUT, indica que la operación realizada en el resource group agotó el tiempo de espera. Todas las operaciones pueden agotar el tiempo de espera. Este valor solo está disponible temporalmente para DataService Studio.
UpdateTime	String	Jul 9, 2018 2:43:37 PM	Hora de la última actualización del resource group.
IsDefault	Boolean	true	Indica si el resource group es el predeterminado. Valores válidos: true: Es el resource group predeterminado. false: No es el resource group predeterminado.
Cluster	String	AY18G	Nombre del clúster. Este parámetro solo se devuelve si el tipo de resource group es MaxCompute o PAI.
EnableKp	Boolean	false	Indica si se utiliza el UID de una cuenta de Alibaba Cloud para el acceso. Valores válidos: true: El motor de cómputo de MaxCompute utiliza el UID de la cuenta de Alibaba Cloud como nombre para mostrar de la cuenta de acceso. false: El motor de cómputo de MaxCompute utiliza el nombre de la cuenta de Alibaba Cloud como nombre para mostrar de la cuenta de acceso. Los valores restantes no son útiles. Este parámetro solo se devuelve si el tipo de resource group es MaxCompute.
ResourceGroupType	String	3	Tipo de resource group. Valores válidos: 0: DataWorks 2: MaxCompute 3: PAI 4: Data Integration 7: programación 9: DataService Studio
CreateTime	String	Jul 9, 2018 2:43:37 PM	Hora de creación del clúster. Ejemplo: Jul 9, 2018 02:43:37 PM.
Identifier	String	e1815577-2f4e-4c5e-b29****	Identificador del resource group.
Mode	String	SHARE	Modo del resource group. Valores válidos: ISOLATE: resource group exclusivo con método de facturación por suscripción SHARE: resource group compartido con método de facturación pay-as-you-go DEVELOP: resource group para desarrolladores
BizExtKey	String	default	Categoría del resource group. Valores válidos: default: resource group compartido single: resource group exclusivo
Sequence	Integer	300	Número de secuencia del resource group. Los resource groups creados se ordenan de forma ascendente según su número de secuencia.
Specs	Map		Detalles del resource group. El contenido entre llaves {} corresponde a dichos detalles.
Name	String	abc	Nombre del resource group.
Id	Long	1234567	ID del resource group.
TenantId	Long	1234567	ID del inquilino.
ResourceManagerResourceGroupId	String	rg-acfmzbn7pti3zfa	ID de su resource group de Alibaba Cloud.
Tags	Array of Tag		Etiquetas.
Key	String	Env	Clave de la etiqueta.
Value	String	Test	Valor de la etiqueta.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListResourceGroups
&ResourceGroupType=3
&Keyword=abc
&BizExtKey=default
&ResourceManagerResourceGroupId=rg-acfmzbn7pti3zfa
&Tags=[{"Key":"Env","Value":"Test"}]
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListResourceGroupsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0bc1411515937635973****</RequestId>
    <Success>true</Success>
    <Data>
        <Status>0</Status>
        <UpdateTime>Jul 9, 2018 2:43:37 PM</UpdateTime>
        <IsDefault>true</IsDefault>
        <Cluster>AY18G</Cluster>
        <EnableKp>false</EnableKp>
        <ResourceGroupType>3</ResourceGroupType>
        <CreateTime>Jul 9, 2018 2:43:37 PM</CreateTime>
        <Identifier>e1815577-2f4e-4c5e-b29****</Identifier>
        <Mode>SHARE</Mode>
        <BizExtKey>default</BizExtKey>
        <Sequence>300</Sequence>
        <Name>abc</Name>
        <Id>1234567</Id>
        <TenantId>1234567</TenantId>
        <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>
        <Tags>
            <Key>Env</Key>
            <Value>Test</Value>
        </Tags>
    </Data>
</ListResourceGroupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "0bc1411515937635973****",
  "Success" : true,
  "Data" : [ {
    "Status" : 0,
    "UpdateTime" : "Jul 9, 2018 2:43:37 PM",
    "IsDefault" : true,
    "Cluster" : "AY18G",
    "EnableKp" : false,
    "ResourceGroupType" : "3",
    "CreateTime" : "Jul 9, 2018 2:43:37 PM",
    "Identifier" : "e1815577-2f4e-4c5e-b29****",
    "Mode" : "SHARE",
    "BizExtKey" : "default",
    "Sequence" : 300,
    "Name" : "abc",
    "Id" : 1234567,
    "TenantId" : 1234567,
    "ResourceManagerResourceGroupId" : "rg-acfmzbn7pti3zfa",
    "Tags" : [ {
      "Key" : "Env",
      "Value" : "Test"
    } ]
  } ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	El origen de datos especificado no existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	El espacio de trabajo especificado no existe.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	El usuario no está agregado al espacio de trabajo.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	El usuario no es propietario ni administrador del espacio de trabajo.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	El usuario no pertenece al inquilino.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.