Adição ou exclusão de tags de recurso em lotes
Descrição
Essa API é usada para adicionar ou excluir tags da instância especificada em lotes.
Restrições
- Um máximo de 20 tags pode ser adicionado a uma instância de banco de dados. A chave de tag deve ser única.
- Se o corpo da solicitação contiver chaves duplicadas, uma mensagem de erro será relatada quando a API for chamada.
- Se a chave no corpo da solicitação for a mesma que uma chave existente na instância especificada, o valor do parâmetro value que corresponde à chave existente será substituído.
- Se as tags a serem excluídas não existirem, a operação é considerada bem-sucedida por padrão. O conjunto de caracteres das tags não será verificado. A estrutura da tag no corpo da solicitação não pode estar ausente e a chave não pode ser deixada em branco ou uma cadeia vazia.
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
action
String
Sim
O identificador da operação. Valor válido:
- create: indica a adicionar tags.
- delete: indica para excluir tags.
tags
Array of objects
Sim
A lista de tags. Para obter mais informações, consulte Tabela 3.
NOTA:Ao excluir tags, não verifique o conjunto de caracteres desse parâmetro.
Tabela 3 Descrição da estrutura de dados do campo tags Nome
Tipo
Obrigatório
Descrição
key
String
Sim
A chave da etiqueta. Ele contém um máximo de 36 caracteres Unicode. Não pode ser nulo ou uma cadeia vazia ou conter espaços. Antes de verificar e usar key, os espaços são filtrados automaticamente.
Conjunto de caracteres: 0-9, A-Z, a-z, "_" e "-".
value
String
Não
O valor da tag. Ele contém no máximo 43 caracteres Unicode, pode ser uma cadeia de caracteres vazia e não pode conter espaços. Antes de verificar ou usar value, os espaços são automaticamente filtrados.
Conjunto de caracteres: 0-9, A-Z, a-z, "_", "." e "-".
- Se action for definida como create, esse parâmetro será obrigatório.
- Se action for definida para delete, este parâmetro é opcional.
NOTA:
Se value for especificado, as tags serão excluídas por chave e valor. Se value não for especificado, as tags serão excluídas pela chave.
Respostas
{}
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.