GetResources - Cloud Control API: Central de Documentação do Alibaba Cloud

Descrição da operação

Você pode acessar o OpenAPI Explorer para visualizar a documentação de recursos e testar a API Cloud Control.

Esta API fornece operações Get e List para recursos que você pode invocar usando diferentes URIs de solicitação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
requestPath	string	Não	A URL da solicitação. A URL da solicitação determina se a operação List ou Get é chamada. List: `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}` Get: `/api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId}` A URL da solicitação contém as seguintes variáveis: provider: O provedor de serviços em nuvem. Atualmente, apenas `Aliyun` é suportado. product: O código do produto. resourceType: O tipo de recurso. Se um recurso pai existir, o formato é `{código do tipo de recurso pai}/{ID do recurso pai}/{código do tipo de recurso}`. resourceId: O ID do recurso.	List (no parent resource): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance List (has parent resource): /api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo**/Account Get (no parent resource): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo Get (has parent resource): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo/Account/user**

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
regionId	string	Não	O ID da região. Este parâmetro é obrigatório se o produto em nuvem for específico de uma região.	cn-beijing
filter	object	Não	As condições de filtro para recursos. Especifique múltiplos pares chave-valor em formato JSON para filtrar recursos. Se uma operação List ou Get de um produto em nuvem suportar filtragem por propriedades específicas, você pode usar essas propriedades como condições de filtro para este parâmetro. Nota Os campos de filtro suportados podem variar para diferentes tipos de recursos. Para mais informações sobre os campos suportados, consulte a documentação OpenAPI do recurso específico. Por exemplo, recursos DBInstance suportam filtragem pelos campos `EditionType` e `PaymentType`.	{ "EditionType": "Community", "PaymentType": "PostPaid" }
nextToken	string	Não	O token de paginação. Você não precisa especificar este parâmetro para a primeira consulta. O sistema retorna dados da primeira página. Para consultas subsequentes, defina este parâmetro com o valor nextToken retornado da chamada anterior. Nota Se este parâmetro contiver apenas dígitos, a API Cloud Control o trata como o `PageNumber` para paginação.	AAAAAdDWBF2****
maxResults	integer	Não	O número máximo de registros a serem retornados em cada página para uma consulta paginada. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de resposta.
maxResults	integer	O número máximo de registros retornados para a solicitação atual. Este parâmetro é retornado pela operação List.	10
nextToken	string	A posição onde a chamada atual terminou a leitura. Um valor vazio indica que todos os dados foram lidos. Este parâmetro é retornado pela operação List.	AAAAAdDWBF2****
requestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
resource	object	O recurso especificado. Este parâmetro é retornado pela operação Get.
resourceAttributes	object	As propriedades do recurso em formato JSON.	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	O ID do recurso.	cctest
resources	array<object>	Uma lista de recursos. Este parâmetro é retornado pela operação List.
	array<object>	Um recurso.
resourceAttributes	object	As propriedades do recurso em formato JSON.	{"Status":"Available","Description":"","AccountPrivilege":"RoleReadWrite","InstanceId":"r-2ze8v41uei31lo****","RegionId":"cn-zhangjiakou","AccountType":"Normal","TypeInfo":{},"AccountName":"cctest"}
resourceId	string	O ID do recurso.	cctest
totalCount	integer	O número total de entradas que correspondem às condições de consulta. Este parâmetro é retornado pela operação List.	20

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.