Consulta instâncias.
Depuração
Informações de autorização
Não há informações de autorização disponíveis para esta API.
Sintaxe da solicitação
GET /v2/openapi/listinstances HTTP/1.1
Parâmetros da solicitação
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| Status | string | Não | Status da instância. Valores válidos:
| normal |
| MaxResults | integer | Não | Número máximo de instâncias a retornar. Valores válidos: 0 a 200. Se você não definir este parâmetro ou defini-lo como 0, o valor padrão será 100. | 100 |
| NextToken | string | Não | Token que determina a posição inicial da consulta. Defina este parâmetro com o valor do parâmetro NextToken retornado na última chamada. As instâncias são retornadas em ordem lexicográfica a partir da posição especificada por este parâmetro. Na primeira chamada da operação, deixe este parâmetro vazio. | CAESCG15aC1xxxxx |
| InstanceName | string | Não | Nome da instância. A busca aproximada é compatível. | instance |
| ResourceGroupId | string | Não | ID do grupo de recursos. Consulte o ID na página Resource Group no console Resource Management. | rg-aek24upgom6p5ri |
| InstanceNameList | array | Não | Nomes das instâncias. Use este parâmetro para especificar várias instâncias a serem consultadas simultaneamente. | |
| string | Não | Nome da instância. A correspondência exata e completa é compatível. | instance-test | |
| Tag | array<object> | Não | Tags da instância. | |
| object | Não | Tag da instância. | ||
| Key | string | Não | Chave da tag. | Owner |
| Value | string | Não | Valor da tag. | Tester |
Parâmetros de resposta
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| object | Estrutura retornada. | ||
| RequestId | string | ID da solicitação. Use-o para solucionar problemas. | E734979F-5A44-5993-9CE5-C23103576923 |
| TotalCount | long | Número total de instâncias retornadas. | 2 |
| NextToken | string | Token que define a posição inicial da próxima consulta. Se este parâmetro estiver vazio, todas as instâncias consultadas foram retornadas. | CAESCG15aC1xxxxx |
| Instances | array<object> | Detalhes das instâncias. | |
| Instances | object | As instâncias. | |
| InstanceName | string | Nome da instância. Identifica a instância de forma única. | instance-test |
| ResourceGroupId | string | ID do grupo de recursos. | rg-acfmxh4em5jnbcd |
| RegionId | string | ID da região. | cn-huhehaote |
| SPInstanceId | string | ID da instância. | ots_standard_public_cn-g4t3igqjj002 |
| AliasName | string | Alias da instância. | instance-test |
| UserId | string | ID do usuário. | 13542356466 |
| InstanceDescription | string | Descrição da instância. | Description of the test instance. |
| InstanceSpecification | string | Tipo da instância.
| HYBRID |
| PaymentType | string | Método de faturamento.
| Subscription |
| StorageType | string | Tipo de armazenamento.
| HYBRID |
| VCUQuota | integer | Cota de VCU. | 3 |
| InstanceStatus | string | Status da instância.
| normal |
| CreateTime | string | Data e hora de criação da instância. | 2019-04-07T09:19:21Z |
| IsMultiAZ | boolean | Indica se o armazenamento redundante de zona (ZRS) está ativado para a instância.
| true |
Exemplos
Exemplos de respostas de sucesso
Formato JSON
{
"RequestId": "E734979F-5A44-5993-9CE5-C23103576923",
"TotalCount": 2,
"NextToken": "CAESCG15aC1xxxxx",
"Instances": [
{
"InstanceName": "instance-test",
"ResourceGroupId": "rg-acfmxh4em5jnbcd",
"RegionId": "cn-huhehaote",
"SPInstanceId": "ots_standard_public_cn-g4t3igqjj002",
"AliasName": "instance-test",
"UserId": "13542356466",
"InstanceDescription": "Description of the test instance.",
"InstanceSpecification": "HYBRID",
"PaymentType": "Subscription",
"StorageType": "HYBRID",
"VCUQuota": 3,
"InstanceStatus": "normal",
"CreateTime": "2019-04-07T09:19:21Z",
"IsMultiAZ": true
}
]
}
Códigos de erro
Para obter uma lista de códigos de erro, consulte os Códigos de erro do serviço.
Histórico de alterações
|
Data da alteração |
Resumo das alterações |
Operação |
|
2024-07-24 |
Os parâmetros de solicitação da API foram alterados |