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 uma instância de DCS

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

Ver PDF

Consulta de uma instância de DCS

Função

Essa API é usada para consultar os detalhes sobre uma instância de DCS especificada.

URI

GET /v1.0/{project_id}/instances/{instance_id}

Tabela 1 descreve os parâmetros.

**Tabela 1** Descrição do parâmetro
Parâmetro	Tipo	Obrigatório	Descrição
project_id	String	Sim	Para obter detalhes sobre como obter o valor deste parâmetro, consulte Obtenção do ID do projeto.
instance_id	String	Sim	ID da instância a ser consultada

Solicitação

Parâmetros de solicitação

Nenhum.

Exemplo de solicitações

URL da solicitação:

GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}

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
name	String	Nome da instância do DCS.
engine	String	Mecanismo de instância DCS.
capacity	Integer	Capacidade do cache da instância DCS. 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.
libos	Boolean	true: Esta instância é uma instância libos. false: Esta instância não é uma instância de libos.
description	String	Breve descrição da instância do DCS.
max_memory	Integer	Tamanho total da memória. Unidade: MB.
used_memory	Integer	Tamanho da memória utilizada. Unidade: MB (em inglês).
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 de uma instância de DCS de pequeno porte e nó único.
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 não é criada ou está em status anormal. Para obter detalhes sobre códigos de erro, consulte Tabela 3.
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. Opções: true: ativado. false: 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 desabilitado.
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 desabilitado.
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.
available_zones	Array	AZ onde um nó de cache reside. O valor desse parâmetro na resposta contém um ID de AZ.
subnet_id	String	ID da sub-rede.
security_group_id	String	ID do grupo de segurança.
backend_addrs	String	Endereço de back-end de uma instância de cluster.
product_id	String	ID do produto.
security_group_name	String	Nome do grupo de segurança.
subnet_name	String	Nome da sub-rede.
subnet_cidr	String	Segmento de sub-rede.
order_id	String	ID do pedido.
instance_backup_policy	JSON	Política de backup. Esse parâmetro está disponível para instâncias de DCS principal/em espera e de cluster. Para mais detalhes, veja Tabela 4 e Tabela 5.
tags	Array of objects	Chave e valor da tag de instância.

**Tabela 3** Código de erro
Código de erro	Descrição
dcs.00.0007	Erro de sistema.
dcs.01.0001	Erro interno do serviço.
dcs.01.0002	Erro interno do serviço.
dcs.01.0003	Erro interno do serviço.
dcs.02.0001	Falha ao criar a VPC.
dcs.02.0002	Falha ao criar a VPC.
dcs.02.0003	Falha ao criar o grupo de segurança.
dcs.02.0004	Falha ao criar a sub-rede.
dcs.02.0005	Status anormal da sub-rede.
dcs.03.0001	Falha ao criar o ECS.
dcs.03.0002	Falha ao criar o ECS.
dcs.03.0003	Falha ao criar o ECS.
dcs.03.0004	Falha ao criar o ECS.
dcs.03.0005	Falha ao vincular NIC ao ECS.
dcs.03.0007	Falha ao iniciar o ECS.
dcs.03.0008	Falha ao iniciar o ECS.
dcs.03.0009	Falha ao parar o ECS.
dcs.03.0017	Alguns nós da instância estão defeituosos.
dcs.04.0002	Falha ao implantar a instância.
dcs.04.0003	Não foi possível se conectar à instância.
dcs.04.0004	Os dois nós de cache estão no estado principal. Um erro de conexão de rede pode ocorrer entre o principal e os nós em espera.

Exemplo de resposta

{
	"name": "dcs-125d",
	"engine": "Redis",
	"capacity": 64,
	"ip": "192.168.1.48",
	"domainName": "XXXXXX",
	"port": 6379,
	"status": "RUNNING",
	"libos": false,
	"description": null,
	"task": null,
	"max_memory": 65536,
	"used_memory": 33,
	"instance_id": "979e9a6b-e2f5-4b5d-8e98-fea495ea27a1",
	"resource_spec_code": "dcs.cluster",
	"engine_version": "3.0",
	"internal_version": null,
	"charging_mode": 0,
	"capacity_minor": null,
	"vpc_id": "d1e8008d-8182-4c86-a142-1ae9349bdc64",
	"vpc_name": "vpc-807d",
	"task_status": null,
	"created_at": "2018-12-11T07:24:18.149Z",
	"error_code": null,
	"user_id": "9bfac09d9bcd4eb7bb1465a7bcff815b",
	"user_name": "r00209145",
	"maintain_begin": "02:00:00",
	"maintain_end": "06:00:00",
	"no_password_access": "true",
	"access_user": null,
	"enable_publicip": false,
	"publicip_id": null,
	"publicip_address": null,
	"enable_ssl": false,
	"service_upgrade": false,
	"service_task_id": null,
	"is_free": null,
	"enterprise_project_id": "0",
	"available_zones": ["f84448fd537f46078dd8bd776747f573"],
	"subnet_id": "9b32218f-6389-485a-912e-076fe9df6fa7",
	"security_group_id": "ecefdad9-c8be-42aa-9d5d-9ab46a221240",
	"backend_addrs": ["192.168.1.136:6379",
	"192.168.1.224:6379"],
	"product_id": "00301-17063-0--0",
	"security_group_name": "sg--test-hanwang",
	"subnet_name": "subnet-7e46",
	"order_id": null,
	"subnet_cidr": "192.168.1.0/24",
	"instance_backup_policy": null,
        "tags": [
        {
            "key": "dcs001",
            "value": "001"
        },
        {
            "key": "dcs002",
            "value": "002"
        }
        ],
	"enterprise_project_name": null
}

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	Instância especificada consultada com sucesso.

Tópico principal: As API de gerenciamento de ciclo de vida

Tópico anterior: Exclusão de instâncias de DCS em massa

Próximo tópico: Consulta de todas as Instâncias DCS de um locatário

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar