Criação de uma função do banco de dados
Descrição
Essa API é usada para criar uma função de banco de dados para uma instância especificada.
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: criação, alteração da classe da instância, alteração da porta, congelada, reiniciando ou anormal.
Depuração
Você pode depurar essa API no API Explorer.
URI
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário |
project_id |
string |
path |
Sim |
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 |
path |
Sim |
ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma. |
Solicitações
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
role_name
String
Sim
O nome da função a ser criada.
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 (.).
roles
Array of objects
Não
A lista de funções herdadas pela nova função. Para mais detalhes, consulte Tabela 3.
db_name
String
Não
O nome do banco de dados ao qual a função pertence. 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 (_).
Tabela 3 Descrição da estrutura de dados do campo roles Nome
Tipo
Obrigatório
Descrição
role_db_name
String
Sim
O nome do banco de dados ao qual uma função herdada pertence.
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 (_).
role_name
String
Sim
O nome de um papel herdado.
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 (.).
- Exemplo de solicitação
{ "role_name": "testRole", "roles" : [{ "role_name":"readWrite", "role_db_name":"testDb" }], "db_name":"testDb" }
Respostas
- Exemplo de resposta
{}
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.
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.