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/ Document Database Service/ Referência de API/ APIs V3.0 (recomendada)/ Gerenciamento de instâncias de banco de dados/ Consulta de instâncias e detalhes
Atualizado em 2023-05-06 GMT+08:00
Ver PDF
Compartilhar

Consulta de instâncias e detalhes

Descrição da API

Essa API é usada para consultar instâncias e detalhes com base em condições especificadas.

Depuração

Você pode depurar essa API no API Explorer.

URI

  • Formato de URI

    GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value},{key}={value}

  • Exemplo de URI
    • Consulta de todas as instâncias e detalhes

      https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances

    • Consulta de instâncias e detalhes com base em critérios de pesquisa

      https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&tags=key1=value1,key2=value2

Tabela 1 Descrição do parâmetro

Nome

Tipo

Obrigatório

Descrição

x-auth-token

string

Sim

Token do usuário

project_id

String

Sim

O ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.

id

String

Não

O ID da instância, que pode ser obtido chamando a API usada para consultar instâncias e detalhes. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.

name

String

Não

O nome da instância de banco de dados.

Se você usar asterisco (*) no início do nome, os resultados da pesquisa difusa serão retornados. Caso contrário, os resultados exatos são retornados.

NOTA:

O asterisco (*) é um caractere reservado no sistema e não pode ser usado sozinho.

mode

String

Não

O tipo de instância.

  • Sharding indica a instância do cluster.
  • ReplicaSet indicam a instância do conjunto de réplicas.
  • Single indica a instância de nó único.

datastore_type

String

Não

O tipo de banco de dados. O valor é DDS-Community.

vpc_id

String

Não

O ID da VPC. Para obter esse valor de parâmetro, use um dos seguintes métodos:

  • Método 1: Faça login no console da VPC e visualize o ID da VPC na página de detalhes da VPC.
  • Método 2: Consulte o ID da VPC por meio da API da VPC. Para obter detalhes, consulte Consulta de VPCs.

subnet_id

String

Não

A ID de rede da sub-rede. Para obter esse valor de parâmetro, use um dos seguintes métodos:

  • Método 1: Faça login no console da VPC e clique na sub-rede de destino na página Subnets. Você pode visualizar o ID da rede na página exibida.
  • Método 2: Consulte o ID da rede por meio da API da VPC. Para obter detalhes, consulte Consulta de sub-redes.

offset

Integer

Não

A posição do índice. A consulta começa a partir do próximo tempo de criação da instância indexada por esse parâmetro em um projeto especificado. Se offset for definido como N, a consulta de recursos começa a partir do dado N+1.

O valor deve ser superior ou igual a 0. Se esse parâmetro não for transferido, offset é definido como 0 por padrão, indicando que a consulta começa a partir da última instância de banco de dados criada.

limit

Integer

Não

O número máximo permitido de instâncias de banco de dados.

O valor varia de 1 a 100. Se esse parâmetro não for transferido, as primeiras 100 instâncias de banco de dados serão consultadas por padrão.

tags

String

Não

Consulta com base na chave e no valor da tag de instância.

{key} indica a chave da tag, {value} indica o valor da tag. Um máximo de 20 pares de chave-valor são suportados. A chave não pode estar vazia ou duplicada, mas o valor pode estar vazio.

Para consultar instâncias com várias chaves e valores de tag, separe os pares chave-valor com vírgulas (,).

Solicitações

Nenhuma

Respostas

  • Descrição do parâmetro
    Tabela 2 Parâmetros de corpo de resposta

    Nome

    Tipo

    Obrigatório

    Descrição

    instances

    Array of objects

    Sim

    As informações da instância de banco de dados. Para obter mais informações, consulte Tabela 3.

    total_count

    Integer

    Sim

    O número total de registros consultados.
    Tabela 3 Estrutura de dados do campo instâncias

    Nome

    Tipo

    Obrigatório

    Descrição

    id

    String

    Sim

    O ID da instância de banco de dados.

    name

    String

    Sim

    O nome da instância de banco de dados.

    remark

    String

    Sim

    Observações de instância

    status

    String

    Sim

    O status da instância de banco de dados.

    Valor válido:

    • normal: indica que a instância está sendo executada corretamente.
    • abnormal: indica que a instância é anormal.
    • creating: indica que a instância está sendo criada.
    • frozen: indica que a instância está congelada.
    • data_disk_full: O espaço de armazenamento está cheio.
    • createfail: indica que a instância falhou ao ser criada.
    • enlargefail: indica que os nós falharam ao serem adicionados à instância.
    NOTA:

    As ações que estão sendo executadas em uma instância, por exemplo, reinicialização, são essencialmente diferentes do status da instância. Para obter detalhes, consulte o campo ações nesta tabela.

    port

    String

    Sim

    A porta do banco de dados. O intervalo de portas é de 2100 a 9500.

    mode

    String

    Sim

    O tipo de instância, que é o mesmo que o parâmetro de solicitação.

    region

    String

    Sim

    A região onde a instância de banco de dados é implantada.

    datastore

    Object

    Sim

    As informações do banco de dados.

    Para obter mais informações, consulte Tabela 4.

    engine

    String

    Sim

    O motor de armazenamento. O DDS suporta os mecanismos de armazenamento WiredTiger e RocksDB.

    • Se a versão do banco de dados for 4.2 e o mecanismo de armazenamento for RocksDB, o valor será rocksDB.
    • Se a versão do banco de dados for 4.0 ou 3.4 e o mecanismo de armazenamento for WiredTiger, o valor será wiredTiger.

    created

    String

    Sim

    A hora de criação da instância de banco de dados.

    updated

    String

    Sim

    O horário em que uma instância de banco de dados é atualizada.

    db_user_name

    String

    Sim

    O nome de usuário padrão. O valor é rwuser.

    ssl

    Integer

    Sim

    Se o SSL está habilitado.

    • 1: indica que o SSL está habilitado.
    • 0: indica que o SSL está desabilitado.

    vpc_id

    String

    Sim

    O ID da VPC.

    subnet_id

    String

    Sim

    A ID de rede da sub-rede.

    security_group_id

    String

    Sim

    Indica o ID do grupo de segurança.

    backup_strategy

    Object

    Sim

    A política de backup.

    Para obter mais informações, consulte Tabela 5.

    pay_mode

    String

    Não

    O modo de cobrança.

    • 0: indica o modo de cobrança de pagamento por uso.
    • 1: indica o modo de cobrança anual/mensal.

    maintenance_window

    String

    Sim

    A janela de tempo de manutenção.

    groups

    Array of objects

    Sim

    Informações do grupo.

    Para obter mais informações, consulte Tabela 6.

    disk_encryption_id

    String

    Sim

    A ID da chave de criptografia do disco. Esse parâmetro é retornado somente quando o disco da instância é criptografado.

    enterprise_project_id

    String

    Sim

    ID do projeto corporativo.

    Se o valor for 0, o recurso pertence ao projeto corporativo padrão.

    time_zone

    String

    Sim

    O fuso horário.

    dss_pool_id

    String

    Não

    O ID do pool de armazenamento do DSS do usuário de DeC.

    actions

    Array of strings

    Sim

    Ação que está sendo executada em uma instância.

    Valor válido:

    • RESTARTING: A instância está sendo reiniciada.
    • RESTORE: A instância está sendo restaurada.
    • RESIZE_FLAVOR: As especificações estão sendo alteradas.
    • RESTORE_TO_NEW_INSTANCE: A instância está sendo restaurada.
    • MODIFY_VPC_PEER: O acesso entre sub-redes está sendo configurado.
    • CREATE: A instância está sendo criada.
    • FROZEN: A instância está congelada.
    • RESIZE_VOLUME: O armazenamento está sendo ampliado.
    • RESTORE_CHECK: A restauração está sendo verificada.
    • RESTORE_FAILED_HANGUP: A restauração falhou.
    • CLOSE_AUDIT_LOG: A política de auditoria está sendo desabilitada.
    • OPEN_AUDIT_LOG: A política de auditoria está sendo habilitada.
    • PERIOD_RESOURCE_SPEC_CHG: As alterações anuais/mensais de recursos estão sendo verificadas.
    • CREATE_IP_SHARD: O endereço IP de shard está sendo habilitado.
    • CREATE_IP_CONFIG: O endereço IP de configuração está sendo habilitado.
    • GROWING: O nó está sendo ampliado.
    • SET_CONFIGURATION: Os parâmetros estão sendo modificados.
    • RESTORE_TABLE: A tabela está sendo restaurada.
    • MODIFY_SECURITYGROUP: Um grupo de segurança está sendo alterado.
    • BIND_EIP: O EIP está sendo alterado.
    • UNBIND_EIP: O EIP está sendo desvinculado.
    • SWITCH_SSL: O SSL está sendo trocado.
    • SWITCH_PRIMARY: Um switchover principal/standby está sendo executado.
    • CHANGE_DBUSER_PASSWORD: A senha está sendo alterada.
    • MODIFY_PORT: O porto está sendo alterado.
    • MODIFY_IP: O endereço IP privado está sendo alterado.
    • DELETE_INSTANCE: A instância está sendo excluída.
    • REBOOT: A instância está sendo reiniciada.
    • BACKUP: O backup está em andamento.
    • MIGRATE_AZ: A AZ está sendo alterada.
    • PWD_RESETING: A senha está sendo redefinida.
    • UPGRADE_DATABASE: O patch está sendo atualizado.
    • DATA_MIGRATION: Os dados estão sendo migrados.
    • SHARD_GROWING: A partição está sendo dimensionada.
    • APPLY_CONFIGURATION: Um grupo de parâmetros está sendo alterado.
    • RESET_PASSWORD: A senha está sendo redefinida.
    • GROWING_REVERT: Os nós estão sendo excluídos.
    • SHARD_GROWING_REVERT: Partições estão sendo apagadas.
    • ONDEMAND_TO_PERIOD: O modo de cobrança está sendo alterado para anual/mensal.
    • LOG_PLAINTEXT_SWITCH: A configuração de log de consulta lenta está sendo modificada.
    • CREATE_DATABASE_USER: O usuário do banco de dados está sendo criado.
    • CREATE_DATABASE_ROLE: A função de banco de dados está sendo criada.
    • MODIFY_NAME: O nome está sendo alterado.
    • MODIFY_PRIVATE_DNS: A zona privada está sendo modificada.
    • MODIFY_OP_LOG_SIZE: O tamanho do oplog está sendo alterado.
    • ADD_READONLY_NODES: Réplicas de leitura estão sendo ampliadas.

    order_id

    String

    Não

    ID do pedido, que é retornado somente quando uma instância é faturada anualmente/mensalmente.

    tags

    Array of objects

    Sim

    Lista de tags

    Para mais detalhes, consulte Tabela 9.
    Tabela 4 Estrutura de dados do campo datastore

    Nome

    Tipo

    Obrigatório

    Descrição

    type

    String

    Sim

    O motor do banco de dados.

    version

    String

    Sim

    A versão do banco de dados. As versões 4.2, 4.0 e 3.4 são suportadas. O valor pode ser 4.2, 4.0 ou 3.4.

    NOTA:
    • O DDS 4.2 é restrito para uso comercial. Para obter detalhes, consulte Avisos do DDS.
    • Para garantir que você tenha uma boa experiência usando o DDS, crie uma instância do DDS 4.0.

    patch_available

    Boolean

    Sim

    Se existe um patch disponível para atualização. Se true for retornado, você pode instalar o patch para atualizar a instância.
    Tabela 5 descrição da estrutura de dados do campo backup_strategy

    Nome

    Tipo

    Obrigatório

    Descrição

    start_time

    String

    Sim

    A janela de tempo de backup. Os backups automáticos serão acionados durante a janela de tempo de backup. A hora atual é a hora UTC.

    keep_days

    Integer

    Sim

    O número de dias para reter os arquivos de backup gerados. A faixa de valores é de 0 a 732.
    Tabela 6 Descrição da estrutura de dados do campo groups

    Nome

    Tipo

    Obrigatório

    Descrição

    type

    String

    Sim

    O tipo de nó.

    Valor válido:

    • shard
    • config
    • mongos
    • replica
    • single

    id

    String

    Sim

    A ID do grupo. Esse parâmetro é válido somente quando o tipo de nó é shard ou config.

    name

    String

    Sim

    O nome do grupo. Esse parâmetro é válido somente quando o tipo de nó é shard ou config.

    status

    String

    Sim

    O status do grupo. Esse parâmetro é válido somente quando o tipo de nó é shard ou config.

    volume

    Object

    Sim

    A informação do volume. Para obter mais informações, consulte Tabela 7. Esse parâmetro é válido somente quando o tipo de nó é shard, config ou replica.

    nodes

    Array of objects

    Sim

    A informação do nó. Para obter mais informações, consulte Tabela 8.
    Tabela 7 Descrição da estrutura de dados do campo volume

    Nome

    Tipo

    Obrigatório

    Descrição

    size

    String

    Sim

    O tamanho do disco. Unidade: GB

    used

    String

    Sim

    O uso do disco. Unidade: GB
    Tabela 8 Descrição da estrutura de dados do campo nodes

    Nome

    Tipo

    Obrigatório

    Descrição

    id

    String

    Sim

    A ID do nó.

    name

    String

    Sim

    O nome do nó.

    status

    String

    Sim

    O status do nó.

    role

    String

    Sim

    A função do nó.

    Valor válido:
    • master: Este valor é retornado para o nó de mongos.
    • Primary: Esse valor é retornado para a partição primária, nós de config e o nó primário de um conjunto de réplicas.
    • Secondary: Esse valor é retornado para a partição secundária, nós de config e o nó secundário de um conjunto de réplicas.
    • Hidden: Esse valor é retornado para a partição oculta, nós de config e o nó oculto de um conjunto de réplicas.
    • unknown. Este valor é retornado quando o nó é anormal.

    private_ip

    String

    Sim

    O endereço IP privado de um nó. Por padrão, esse parâmetro é válido apenas para nós de mongos e instâncias de conjunto de réplicas. O valor existe depois que o ECS é criado com êxito. Caso contrário, o valor é "".

    CUIDADO:

    Depois que a partição ou o endereço IP de configuração é ativado, os endereços IP privados são atribuídos aos nós de configuração ou partição primária e secundária da instância do cluster.

    public_ip

    String

    Sim

    O EIP que foi vinculado. Esse parâmetro é válido somente para nós mongos de instâncias de cluster e nós primários e secundários de instâncias de conjunto de réplicas.

    spec_code

    String

    Sim

    O código de especificação do recurso. Para obter detalhes sobre as especificações da instância, consulte o valor do parâmetro flavors.spec_code em Consulta de especificações do banco de dados.

    availability_zone

    String

    Sim

    AZ.
    Tabela 9 Descrição do campo tag

    Nome

    Tipo

    Obrigatório

    Descrição

    key

    String

    Sim

    Chave da tag

    value

    String

    Sim

    Valor da tag

    Os valores de region e availability_zone são usados como exemplos.

  • Exemplo de resposta 
    {
  "instances": [
    {
      "id": "8436a91546294036b75931e879882200in02",
      "name": "dds-efa6",
      "remark": "test",
      "status": "normal",
      "port": 8635,
      "mode": "ReplicaSet",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:05:52",
      "updated": "2019-01-17T07:05:47",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "16:00-17:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": {
        "type": "replica",
        "volume": {
          "size": 10,
          "used": 0.33
        },
        "nodes": [
          {
            "id": "233eaac9c6f245c0bb9c2d21eea12d1bno02",
            "name": "dds-efa6_replica_node_2",
            "status": "normal",
            "role": "Primary",
            "private_ip": "192.168.0.174",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          },
          {
            "id": "d57d76d6320a4a7b86db82c317550c4ano02",
            "name": "dds-efa6_replica_node_1",
            "status": "normal",
            "role": "Hidden",
            "private_ip": "192.168.0.39",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          },
          {
            "id": "f46b0a1cf4d9400e9fd7af17f8742d37no02",
            "name": "dds-efa6_replica_node_3",
            "status": "normal",
            "role": "Secondary",
            "private_ip": "192.168.0.176",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          }
        ]
      },
      "enterprise_project_id": "0",
      "time_zone": "",
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    },
    {
      "id": "d77905385f114217b75ae7d6ab9a7588in02",
      "name": "dds-5699",
      "status": "normal",
      "remark": "Test",
      "port": 8635,
      "mode": "Single",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:04:39",
      "updated": "2019-01-17T07:04:33",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "17:00-18:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": {
        "type": "single",
        "volume": {
          "size": 10,
          "used": 0.33
        },
        "nodes": [
          {
            "id": "bd4dccbd53ae48d5bd3046bebf715079no02",
            "name": "dds-5699_single_node_1",
            "status": "normal",
            "role": "Primary",
            "private_ip": "192.168.0.9",
            "public_ip": "",
            "spec_code": "dds.mongodb.c6.medium.4.single",
            "availability_zone": "bbb"
          }
        ]
      },
      "enterprise_project_id": "0",
      "time_zone": "",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    },
    {
      "id": "9136fd2a9fcd405ea4674276ce36dae8in02",
      "name": "dds-32f4",
      "remark": 123,
      "status": "normal",
      "port": 8635,
      "mode": "Sharding",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:04:37",
      "updated": "2019-01-17T07:04:31",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "19:00-20:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": [
        {
          "type": "mongos",
          "nodes": [
            {
              "id": "a742c13a284949adad177672e8a0f01cno02",
              "name": "dds-32f4_mongos_node_1",
              "status": "normal",
              "role": "Primary",
              "private_ip": "192.168.0.56",
              "public_ip": "",
              "spec_code": "dds.mongodb.c6.medium.4.mongos",
              "availability_zone": "bbb"
            },
            {
              "id": "d4f66666b1d64ab28719da0526341c7eno02",
              "name": "dds-32f4_mongos_node_2",
              "status": "normal",
              "role": "Primary",
              "private_ip": "192.168.0.185",
              "public_ip": "",
              "spec_code": "dds.mongodb.c6.medium.4.mongos",
              "availability_zone": "bbb"
            }
          ]
        },
        {
          "type": "shard",
          "volume": {
            "size": 10,
            "used": 0.33
          },
          "nodes": [
            {
              "id": "0e9abaebe5974b63a5b221de6ee34cfeno02",
              "name": "dds-32f4_shard_2_node_3",
              "status": "normal",
              "role": "Primary",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            },
            {
              "id": "1d7f4c5476c04cc187f920925c2b601fno02",
              "name": "dds-32f4_shard_2_node_2",
              "status": "normal",
              "role": "Hidden",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            },
            {
              "id": "3dd2cce03da54fc08f10651cbfea778dno02",
              "name": "dds-32f4_shard_2_node_1",
              "status": "normal",
              "role": "Secondary",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            }
          ]
        },
        {
          "type": "config",
          "volume": {
            "size": 10,
            "used": 0.33
          },
          "nodes": [
            {
              "id": "7422f7331b714ac39aa647a1ec968d33no02",
              "name": "dds-32f4_config_node_2",
              "status": "normal",
              "role": "Primary",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            },
            {
              "id": "9e3b343151044eda91ddb8a42ae5cbefno02",
              "name": "dds-32f4_config_node_3",
              "status": "normal",
              "role": "Hidden",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            },
            {
              "id": "c0053ca460ac4889841ffb14a886ec54no02",
              "name": "dds-32f4_config_node_1",
              "status": "normal",
              "role": "Secondary",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            }
          ]
        }
      ],
      "enterprise_project_id": "0",
      "time_zone": "",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    }
  ],
  "total_count": 3
}

Código de status

Para obter mais informações, consulte Código de status.

Código de erro

Para obter mais informações, consulte Código de erro.