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/ As API desatualizadas (Indisponível em breve)/ As API de gerenciamento de ciclo de vida/ Consulta de todas as Instâncias DCS de um locatário
Atualizado em 2022-11-09 GMT+08:00
Ver PDF
Compartilhar

Consulta de todas as Instâncias DCS de um locatário

Função

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

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}

Tabela 1 descreve os parâmetros.
Tabela 1 Descrição do parâmetro

Parâmetro

Tipo

Obrigatório

Descrição

project_id

String

Sim

ID.

start

Integer

Não

Número inicial para consulta de instâncias de DCS. Não pode ser inferior a 1.

Por padrão, o número inicial é 1.

limit

Integer

Não

Número de instâncias de DCS exibidas em cada página.

Valor mínimo: 1

Valor máximo: 2000

Se esse parâmetro não for especificado, um máximo de 1000 instâncias de DCS serão exibidas em cada página.

name

String

Não

Nome da instância do DCS.

id

String

Não

ID da instância.

status

String

Não

Status da instância do DCS. Para obter detalhes sobre o status, consulte Status da instância do DCS.

ip

String

Não

Endereço IP para conexão com a instância do DCS

includeFailure

String

Não

Um indicador de que o número de instâncias DCS que falharam na criação será retornado ao chamador da API.

Opções:

  • true: O número de instâncias DCS que não foram criadas será retornado para o chamador da API.
  • false ou outros: O número de instâncias DCS que não foram criadas não será retornado para o chamador da API.

isExactMatchName

String

Não

Um indicador da realização de uma correspondência exata ou difusa com base no nome da instância.

Opções:

  • true: correspondência exata
  • false: correspondência difusa

Valor padrão: false.

tags

Array of objects

Não

Consulta com base 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 (,).

Exemplo

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&isExactMatchName=false

Ou

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002

Solicitação

Parâmetros de solicitação

Nenhum

Exemplo de solicitações

Nenhum

Resposta

Parâmetros de resposta

Tabela 2 descreve os parâmetros de resposta.
Tabela 2 Descrição do parâmetro

Parâmetro

Tipo

Descrição

instances

Array

Matriz de detalhes da instância do DCS.

instance_num

Integer

Número de instâncias de DCS.
Tabela 3 Descrição do parâmetro da matriz de instância.

Parâmetro

Tipo

Descrição

name

String

Nome da instância do DCS.

engine

String

Mecanismo de cache.

capacity

Integer

Capacidade de cache.

Unidade: GB.

ip

String

Endereço IP para conexão com a instância 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.

domainName

String

Nome de domínio da instância.

port

Integer

Número da porta do nó de cache.

status

String

Status da instância de cache. Para obter detalhes sobre o status, consulte Status da instância do DCS.

max_memory

Integer

Tamanho geral da memória.

Unidade: MB.

used_memory

Integer

Tamanho da memória utilizada.

Unidade: MB.

instance_id

String

ID da instância do DCS.

resource_spec_code

String

Especificações de recursos.

  • dcs.single_node: indica uma instância de DCS no modo de nó único.
  • dcs.master_standby: indica uma ocorrência de DCS no modo principal/em espera.
  • dcs.cluster: indica uma instância de DCS no modo de cluster.

engine_version

String

Versão do mecanismo de cache.

internal_version

String

Versão interna do DCS.

charging_mode

Integer

Modo de cobrança. 0: pagamento pelo uso.

capacity_minor

String

Capacidade de cache em pequena escala. Unidade: GB.

vpc_id

String

ID de VPC

vpc_name

String

Nome da VPC.

created_at

String

Hora em que a instância do DCS é criada. Por exemplo, 2017-03-31T12:24:46.297Z.

error_code

String

Código de erro retornado quando a instância DCS falha ao ser criada ou é anormal. Para obter detalhes sobre códigos de erro, consulte Códigos de status.

user_id

String

ID do usuário.

user_name

String

Nome de usuário.

maintain_begin

String

Hora em que a janela de tempo de manutenção começa. Formato: hh:mm:ss.

maintain_end

String

Hora em que a janela de tempo de manutenção termina. Formato: hh:mm:ss.

no_password_access

String

Um indicador de se uma instância de DCS pode ser acessada no modo sem senha.

  • true: indica que uma instância do DCS pode ser acessada sem uma senha.
  • false: indica que uma instância de DCS pode ser acessada somente após a autenticação de senha.

access_user

String

Nome de usuário usado para acessar uma instância de DCS com autenticação de senha.

enable_publicip

Boolean

Um indicador de que o acesso público está habilitado para uma instância do DCS Redis.

  • true: ativado.
  • false: desativado.

publicip_address

String

Endereço IP elástico vinculado a uma instância do DCS Redis.

O valor do parâmetro é null se o acesso público estiver desativado.

publicip_id

String

ID do endereço IP elástico vinculado a uma instância do DCS Redis.

O valor do parâmetro é null se o acesso público estiver desativado.

enable_ssl

Boolean

Um indicador da habilitação do SSL para acesso público a uma instância do DCS Redis.

  • true: ativado.
  • false: desativado.

service_upgrade

Boolean

Um indicador de que uma tarefa de atualização foi criada para uma instância de DCS.

  • true: sim.
  • false: não.

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.

enterprise_project_id

String

ID do projeto empresarial.

security_group_id

String

Nome do grupo de segurança.

tags

Array of objects

Chave e valor da tag de instância.

Exemplo de resposta

Código de status

Tabela 4 descreve o código de status das operações bem-sucedidas. Para obter detalhes sobre outros códigos de status, consulte Tabela 1.

Tabela 4 Código de status

Código de status

Descrição

200

Todas as instâncias DCS do locatário consultadas com êxito.