Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Distributed Cache Service/ Referência de API/ API V2/ Gerenciamento de ciclo de vida/ Consulta de toda as instâncias de DCS

Atualizado em 2022-11-09 GMT+08:00

Ver PDF

Consulta de toda as instâncias de DCS

Função

Essa API é usada para consultar instâncias de DCS de um locatário e permite especificar critérios de consulta.

URI

GET /v2/{project_id}/instances

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
instance_id	Não	String	ID da instância.
include_failure	Não	String	Se retornar o número de instâncias que falham ao serem criadas. Se o valor for true, o número de instâncias que falharam ao serem criadas será retornado. Se o valor não for true, o número não será retornado.
include_delete	Não	String	Se retornar o número de instâncias que foram excluídas. Se o valor for true, o número de instâncias que foram excluídas será retornado. Se o valor não for true, o número não será retornado.
name	Não	String	Nome da instância.
offset	Não	Integer	Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0.
limit	Não	Integer	Número de registros exibidos em cada página. O valor mínimo é 1. O valor máximo é 1000*. Se esse parâmetro não for especificado, 10 registros serão exibidos em cada página por padrão.
status	Não	String	Status da instância. Para obter detalhes, consulte Status da instância do DCS.
name_equal	Não	String	Se deve procurar a instância que corresponde precisamente a um nome de instância especificado. O valor padrão é false, indicando que uma pesquisa difusa é executada com base em um nome de instância especificado. Se o valor for true*, a instância que corresponde precisamente a um nome de instância especificado será consultada.
tags	Não	String	A consulta é baseada na chave e no valor da tag da instância. {key} indica a chave da tag e {value} indica o valor da tag. Para consultar instâncias com várias chaves e valores de tag, separe os pares chave-valor com vírgulas (,).
ip	Não	String	Endereço IP para conexão com a instância do DCS.
capacity	Não	String	Capacidade do cache da instância DCS em GB.

Parâmetros de solicitação

Nenhum

Parâmetros de resposta

Código de estado: 200

**Tabela 3** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
instance_num	Integer	Número de instâncias.
instances	Array of InstanceListInfo objects	Matriz de detalhes da instância.

**Tabela 4** InstanceListInfo
Parâmetro	Tipo	Descrição
publicip_id	String	ID do EIP vinculado à instância do DCS Redis. O valor deste parâmetro é null se o acesso público estiver desabilitado.
vpc_name	String	Nome da VPC.
charging_mode	Integer	Modo de cobrança. O valor pode ser 0: pay-per-use.
vpc_id	String	ID de VPC
subnet_id	String	ID da sub-rede.
security_group_id	String	ID do grupo de segurança.
created_at	String	Tempo de criação. Formato: 2017-03-31T12:24:46.297Z
enable_ssl	Boolean	Se o SSL está ativado para acesso público a uma instância do DCS Redis. true: ativar false: desativar
max_memory	Integer	Tamanho total da memória em MB.
used_memory	Integer	Tamanho de memória usado em MB.
publicip_address	String	EIP vinculado à instância do DCS Redis. O valor deste parâmetro é null se o acesso público estiver desabilitado.
capacity	Integer	Capacidade de cache (GB)
capacity_minor	String	Capacidade (GB) de uma pequena instância de DCS (menor que 1 GB).
order_id	String	ID do pedido. O valor é null quando uma instância de pagamento por uso é criada.
maintain_begin	String	Hora UTC quando a janela de tempo de manutenção é iniciada. O formato é HH:mm:ss.
maintain_end	String	Hora UTC quando a janela de tempo de manutenção termina. O formato é HH:mm:ss.
engine	String	Mecanismo de cache.
engine_version	String	Versão cache.
service_upgrade	Boolean	Se a instância tem uma tarefa de upgrade. true: sim false: não
no_password_access	String	Indica se a instância pode ser acessada sem uma senha. true: A instância pode ser acessada sem uma senha. false: A instância pode ser acessada somente após a autenticação de senha.
service_task_id	String	Atualizar ID da tarefa. Se o valor de service_upgrade for definido como true, o valor desse parâmetro será o ID da tarefa de atualização. Se o valor de service_upgrade for definido como false, o valor desse parâmetro ficará vazio.
ip	String	Endereço IP para conexão com a instância do DCS. Para uma instância de cluster, vários endereços IP são retornados e separados por vírgulas (,). Por exemplo, 192.168.0.1,192.168.0.2.
access_user	String	Nome de usuário usado para acessar uma instância de DCS após a autenticação de senha.
instance_id	String	ID da instância.
enable_publicip	Boolean	Indica se o acesso à rede pública está habilitado para a instância do DCS Redis. true: ativar false: desativar
port	Integer	Porta da instância do DCS.
user_id	String	ID do usuário.
user_name	String	Nome de usuário.
domain_name	String	Nome de domínio da instância.
readonly_domain_name	String	Nome de domínio somente leitura da instância. Esse parâmetro está disponível somente para instâncias principal/em espera.
name	String	Nome da instância.
spec_code	String	Variante de produto.
status	String	Status da instância. Para obter detalhes, consulte Status da instância do DCS.
tags	Array of ResourceTag objects	Chave e valor da tag de instância.
enterprise_project_id	String	ID do projeto empresarial.
description	String	Descrição sobre a instância.
cpu_type	String	Tipo de CPU da instância. Geralmente, o valor é x86_64 ou aarch64.
az_codes	Array of strings	Os AZ onde há recursos disponíveis.
features	Features object	Funcionalidades suportadas pela instância.
sub_status	String	Sub-status da instância.

**Tabela 5** ResourceTag
Parâmetro	Tipo	Descrição
key	String	Chave da tag. Este campo não pode ser deixado em branco. O valor-chave de um recurso deve ser exclusivo. A chave de tag pode conter no máximo 36 caracteres. A chave da tag deve ser única e não pode estar vazia.
value	String	Valor da tag. Este parâmetro é obrigatório quando a action é definida para create e é opcional quando a action é definida para delete. O valor da tag pode conter no máximo 43 caracteres.

**Tabela 6** Funcionalidades
Parâmetro	Tipo	Descrição
support_acl	Boolean	Se a ACL é apoiada. true: sim false: não
support_transparent_client_ip	Boolean	Se a passagem de IP do cliente está habilitada. true: sim false: não
support_ssl	Boolean	Se o SSL é suportado. true: sim false: não

Código de estado: 400

**Tabela 7** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_msg	String	Mensagem de erro. Máximo: 1024
error_code	String	Código de erro. Máximo: 9
error_ext_msg	String	Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024

Código de estado: 401

**Tabela 8** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_msg	String	Mensagem de erro. Máximo: 1024
error_code	String	Código de erro. Máximo: 9
error_ext_msg	String	Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024

Código de estado: 403

**Tabela 9** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_msg	String	Mensagem de erro. Máximo: 1024
error_code	String	Código de erro. Máximo: 9
error_ext_msg	String	Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024

Código de estado: 404

**Tabela 10** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_msg	String	Mensagem de erro. Máximo: 1024
error_code	String	Código de erro. Máximo: 9
error_ext_msg	String	Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024

Código de estado: 500

**Tabela 11** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_msg	String	Mensagem de erro. Máximo: 1024
error_code	String	Código de erro. Máximo: 9
error_ext_msg	String	Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024

Exemplos de solicitações

GET https://{dcs_endpoint}/v2/{project_id}/instances?offset=0&limit=10&name={name}&status={status}&id={id}&include_failure=true&include_delete=true&name_equal=false

Exemplo de respostas

Código de estado: 200

Todas as instâncias são listadas com êxito.

{
  "instance_num" : 1,
  "instances" : [ {
    "publicip_id" : { },
    "vpc_name" : "dcs-beta",
    "charging_mode" : 0,
    "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
    "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
    "user_name" : "hwclouduser",
    "created_at" : "2022-08-29T09:00:34.335Z",
    "enable_ssl" : false,
    "max_memory" : 128,
    "publicip_address" : null,
    "capacity" : 0,
    "order_id" : null,
    "maintain_begin" : "18:00:00",
    "engine" : "Redis",
    "maintain_end" : "19:00:00",
    "capacity_minor" : ".125",
    "service_upgrade" : false,
    "no_password_access" : true,
    "service_task_id" : "",
    "ip" : "192.168.0.195",
    "used_memory" : 2,
    "access_user" : null,
    "instance_id" : "c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5",
    "enable_publicip" : false,
    "port" : 6379,
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "domain_name" : "redis-c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5.dcs.huaweicloud.com",
    "name" : "dcs-lpvo0829",
    "spec_code" : "redis.ha.xu1.tiny.r2.128",
    "engine_version" : "5.0",
    "status" : "RUNNING",
    "security_group_id" : "securityGroupId",
    "enterprise_project_id" : 0,
    "tags" : [ {
      "key" : 1,
      "value" : "DCS"
    } ],
    "az_codes" : [ "cn-north-7b", "cn-north-7c" ],
    "description" : "Instance description.",
    "cpu_type" : "x86_64",
    "features" : {
      "support_acl" : true,
      "support_transparent_client_ip" : true,
      "support_ssl" : false
    },
    "sub_status" : "normal"
  } ]
}

Código de estado: 400

Pedido inválido.

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid offset in the request."
}

Códigos de status

Código de status	Descrição
200	Todas as instâncias são listadas com êxito.
400	Pedido inválido.
401	Informações de autenticação inválidas.
403	O pedido é rejeitado.
404	O recurso solicitado não foi encontrado.
500	Erro de serviço interno.