GetResources - Cloud Control API - Centro de documentación de Alibaba Cloud

Descripción de la operación

Puede ir al OpenAPI Explorer para ver la documentación de recursos y probar la API de Cloud Control.

Esta API proporciona operaciones Get y List para recursos que puede invocar mediante diferentes URI de solicitud.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
requestPath	string	No	La URL de la solicitud. La URL de la solicitud determina si se llama a la operación List o Get. List: `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}` Get: `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}` La URL de la solicitud contiene las siguientes variables: provider: El proveedor de servicios en la nube. Actualmente, solo se admite `Aliyun`. product: El código del producto. resourceType: El tipo de recurso. Si existe un recurso principal, el formato es `{código de tipo de recurso principal}/{ID de recurso principal}/{código de tipo de recurso}`. resourceId: El ID del recurso.	List (sin recurso principal): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance List (con recurso principal): /api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo**/Account Get (sin recurso principal): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo Get (con recurso principal): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo/Account/user**

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
regionId	string	No	El ID de la región. Este parámetro es obligatorio si el producto en la nube es específico de una región.	cn-beijing
filter	object	No	Las condiciones de filtro para los recursos. Especifique múltiples pares clave-valor en formato JSON para filtrar recursos. Si una operación List o Get para un producto en la nube admite el filtrado por propiedades específicas, puede usar esas propiedades como condiciones de filtro para este parámetro. Nota Los campos de filtro admitidos pueden variar según los diferentes tipos de recursos. Para obtener más información sobre los campos admitidos, consulte la documentación de OpenAPI del recurso específico. Por ejemplo, los recursos DBInstance admiten el filtrado por los campos `EditionType` y `PaymentType`.	{ "EditionType": "Community", "PaymentType": "PostPaid" }
nextToken	string	No	El token de paginación. No necesita especificar este parámetro para la primera consulta. El sistema devuelve datos de la primera página. Para consultas posteriores, establezca este parámetro en el valor nextToken devuelto por la llamada anterior. Nota Si este parámetro contiene solo dígitos, la API de Cloud Control lo trata como el `PageNumber` para la paginación.	AAAAAdDWBF2****
maxResults	integer	No	El número máximo de registros que se devolverán en cada página para una consulta paginada. Valor máximo: 100.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de la respuesta.
maxResults	integer	El número máximo de registros devueltos para la solicitud actual. Este parámetro es devuelto por la operación List.	10
nextToken	string	La posición donde finalizó la lectura de la llamada actual. Un valor vacío indica que se han leído todos los datos. Este parámetro es devuelto por la operación List.	AAAAAdDWBF2****
requestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resource	object	El recurso especificado. Este parámetro es devuelto por la operación Get.
resourceAttributes	object	Las propiedades del recurso en formato JSON.	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	El ID del recurso.	cctest
resources	array<object>	Una lista de recursos. Este parámetro es devuelto por la operación List.
	array<object>	Un recurso.
resourceAttributes	object	Las propiedades del recurso en formato JSON.	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	El ID del recurso.	cctest
totalCount	integer	El número total de entradas que coinciden con las condiciones de consulta. Este parámetro es devuelto por la operación List.	20

Ejemplos

Respuesta exitosa

JSON Formato

{
  "maxResults": 10,
  "nextToken": "AAAAAdDWBF2****",
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "resource": {
    "resourceAttributes": {
      "Status": "Available",
      "Description": "",
      "AccountPrivilege": "RoleReadWrite",
      "InstanceId": "r-2ze8v41uei31lo****",
      "RegionId": "cn-zhangjiakou",
      "AccountType": "Normal",
      "TypeInfo": {},
      "AccountName": "cctest"
    },
    "resourceId": "cctest"
  },
  "resources": [
    {
      "resourceAttributes": {
        "Status": "Available",
        "Description": "",
        "AccountPrivilege": "RoleReadWrite",
        "InstanceId": "r-2ze8v41uei31lo****",
        "RegionId": "cn-zhangjiakou",
        "AccountType": "Normal",
        "TypeInfo": {},
        "AccountName": "cctest"
      },
      "resourceId": "cctest"
    }
  ],
  "totalCount": 20
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.