Consulta de instâncias de recurso usando tags
Função
Esta API é usada para consultar instâncias de recursos usando tags.
Depuração
Você pode depurar esta API por meio da autenticação automática no Chamada das API ou usar o código de exemplo do SDK gerado pelo API Explorer.
URI
POST /v2/{project_id}/{resource_type}/resource_instances/action
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | ID do projeto |
resource_type | Sim | String | Tipo de recurso. O valor pode ser DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset ou DNS-ptr_record. |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido pela chamada de uma API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
tags | Não | Array of tagValues objects | Tags que estão incluídas. O corpo de estrutura é obrigatório. Um máximo de 10 chaves de tag são permitidas em cada operação de consulta. A chave de tag não pode ser deixada em branco ou configurada como a cadeia vazia. Uma chave de tag pode ter até 10 valores de tag. Cada chave de tag deve ser exclusiva e cada valor de tag em uma tag deve ser exclusivo. |
tags_any | Não | Array of tagValues objects | Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou configurada como uma cadeia vazia. Cada chave de tag deve ser exclusiva e cada valor de tag em uma tag deve ser exclusivo. |
not_tags | Não | Array of tagValues objects | O corpo de estrutura é obrigatório. Um máximo de 10 chaves de tag são permitidas em cada operação de consulta. A chave de tag não pode ser deixada em branco ou configurada como a cadeia vazia. Uma chave de tag pode ter até 10 valores de tag. Cada chave de tag deve ser exclusiva e cada valor de tag em uma tag deve ser exclusivo. |
not_tags_any | Não | Array of tagValues objects | Cada tag contém um máximo de 10 chaves, e cada chave contém um máximo de 10 valores. O corpo da estrutura não pode estar ausente e a chave não pode ser deixada em branco ou configurada como uma cadeia vazia. Cada chave de tag deve ser exclusiva e cada valor de tag em uma tag deve ser exclusivo. |
limit | Não | Integer | Número de recursos em cada página. Intervalo de valor: 1 a 1000 Se a action estiver configurada como filter, o valor padrão 1000 será usado. Se a action estiver configurada como count, este parâmetro não existirá. |
offset | Não | Integer | Iniciar deslocamento da consulta de paginação. A consulta começará a partir do próximo recurso do valor deslocamento. Intervalo de valores: 0 a 2147483647 Valor padrão: 0 Este parâmetro não é necessário quando os dados na primeira página são consultados. Ao consultar recursos em páginas subsequentes, configure o valor de offset para o local retornado no corpo da resposta da consulta anterior. Se a action estiver configurada como filter, o valor padrão é 0. O valor deve ser um número e não pode ser um número negativo. Se a action estiver configurada como count, este parâmetro não existirá. |
action | Sim | String | Operação a ser realizada. Opções de valor:
|
matches | Não | Array of match objects | Este parâmetro especifica o par chave-valor a ser correspondido na consulta. Se o value for deixado em branco, a correspondência exata funcionará. Caso contrário, a correspondência difusa funcionará. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
key | Não | String | Chave da tag. A chave pode conter um máximo de 127 caracteres Unicode. A key deve ser especificada. (Este parâmetro não é verificado durante a pesquisa.) |
values | Não | Array of strings | Valor da tag. Cada valor pode conter um máximo 255 caracteres Unicode. O asterisco () é um caractere reservado.Se o valor começar com um asterisco (), a correspondência difusa é executada com base no valor após o asterisco (*). Se os values estão faltando, qualquer valor é correspondido. Todos os valores de uma chave de tag estão na relação OR. |
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
resources | Array of resourceItem objects | Lista de tags de recursos |
total_count | Integer | Lista de tags adicionadas a um recurso |
Parâmetro | Tipo | Descrição |
|---|---|---|
resource_id | String | ID do recurso |
resource_detail | Object | Detalhes do recurso. Este campo é reservado, cujo valor é padrão para uma cadeia vazia. |
tags | Array of tag objects | Lista de tags. Se não houver nenhuma tag na lista, uma matriz vazia é retornada. |
resource_name | String | Nome do recurso. Se nenhum nome de recurso for correspondido, o valor será deixado em branco. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | Chave da tag. Uma chave pode conter até 36 caracteres Unicode. Não pode ser deixada em branco. Um valor de tag não pode conter caracteres especiais (=*<>,|/) nem iniciar ou terminar com espaços. |
value | String | Valor da tag. Um valor de tag contém no máximo 43 caracteres Unicode e pode ser deixado em branco. Um valor de tag não pode conter caracteres especiais (=*<>,|/) nem iniciar ou terminar com espaços. |
Exemplo de solicitações
{
"offset" : "100",
"limit" : "100",
"action" : "filter",
"matches" : [ {
"key" : "resource_name",
"value" : "resource1"
} ],
"not_tags" : [ {
"key" : "key1",
"values" : [ "*value1", "value2" ]
} ],
"tags" : [ {
"key" : "key1",
"values" : [ "*value1", "value2" ]
} ],
"tags_any" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ],
"not_tags_any" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ]
} Exemplo de respostas
Código de status: 200
Resposta à solicitação de consulta de recursos por tag
{
"resources" : [ {
"resource_detail" : null,
"resource_id" : "cdfs_cefs_wesas_12_dsad",
"resource_name" : "resouece1",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value1"
} ]
} ],
"total_count" : 1000
} Códigos de status
Código de status | Descrição |
|---|---|
200 | Resposta à solicitação de consulta de recursos por tag |
Códigos de erro
Consulte Códigos de erro.
