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 bancos de dados e usuários/ Consulta da lista de funções do banco de dados

Atualizado em 2023-05-06 GMT+08:00

Ver PDF

Consulta da lista de funções do banco de dados

Descrição

Essa API é usada para consultar a lista de funções do banco de dados.

Restrições

Esta API aplica-se apenas ao DDS Community Edition.
Esta operação não é permitida se a instância de banco de dados estiver em qualquer um dos seguintes status: criando, alterando a classe da instância, alterando a porta, reiniciando ou anormal.

Depuração

Você pode depurar essa API no API Explorer.

URI

Formato de URI
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit}
Exemplo de URI
- Consulta da lista de todas as funções.
  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles
- Consulta da lista de funções com base em condições especificadas:
  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles?role_name=testRole&db_name=testDb&offset=0&limit=100

**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.
instance_id	String	Sim	O ID da instância, que pode ser obtido ao chamar a API para consultar instâncias. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.
role_name	String	Não	O nome da função. O valor deve conter de 1 a 64 caracteres e pode conter apenas letras (de A a Z ou de a a z), dígitos (de 0 a 9), hífens (-) e pontos (.).
db_name	String	Não	O nome do banco de dados. O valor padrão é "admin". O valor deve ter de 1 a 64 caracteres e pode conter apenas letras (de A a Z ou de a a z), dígitos (de 0 a 9) e sublinhados (_).
offset	Integer	Não	A posição do índice. O valor deve ser superior ou igual a 0. Se este parâmetro não for transferido, o valor é 0 por padrão.
limit	Integer	Não	O limite superior do número de registros consultados. 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.

Solicitações

Nenhuma

Respostas

Descrição do parâmetro

**Tabela 2** Descrição do parâmetro
Nome	Tipo	Obrigatório	Descrição
roles	String	Sim	As informações sobre a função do banco de dados. CUIDADO: O valor de retorno está no formato nativo do banco de dados e precisa ser analisado pelo usuário.
total_count	Integer	Sim	O número total de funções de banco de dados.

Exemplo de resposta

{
  "total_count": 1,
  "roles": "[{\"privileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"inheritedPrivileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"role\":\"userAdmin\",\"roles\":[],\"inheritedRoles\":[],\"isBuiltin\":true,\"db\":\"admin\"}]"
}

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.