Consulta de recursos por tag
Função
Essa API é usada para consultar recursos por tag. Os recursos são classificados pela hora em que foram criados, em ordem decrescente.
Autorização
Cada conta tem todas as permissões necessárias para chamar todas as APIs, mas os usuários do IAM devem ter as permissões necessárias especificamente atribuídas. Para obter as permissões específicas necessárias, consulte Políticas de permissões e ações suportadas.
URI
- POST /v3/sfs/tms/{project_id}/file-systems/resource-instances/filter
- Descrição do parâmetro
Parâmetro
Obrigatório
Tipo
Descrição
project_id
Sim
String
O ID do projeto. Para obter detalhes, consulte Obtenção de um ID de projeto.
limit
Não
Int
O número máximo de registros que podem ser consultados. O valor varia de 1 a 1000, e o valor padrão é 1000.
offset
Não
Int
A localização do índice. A consulta começa a partir do próximo registro de dados indexado por esse parâmetro. O valor padrão é 0, indicando que a consulta começa a partir do primeiro registro de dados. O valor não pode ser um número negativo.
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Content-type | Sim | String | O tipo MIME do corpo da solicitação. Exemplo: application/json |
| X-Auth-Token | Não | String | O token do usuário. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| without_any_tag | Não | Boolean | Exclui quaisquer tags. Se esse parâmetro for definido como true, todos os recursos sem tags serão consultados. Nesse caso, o campo tags é ignorado. Se esse parâmetro for definido como false ou não for especificado, ele não terá efeito, o que significa que todos os recursos serão retornados ou os recursos serão filtrados por tags ou matches. |
| tags | Não | List<tag> | Inclui tags. Um máximo de 20 tags podem ser especificados. As chaves de tag devem ser exclusivas. Cada chave de tag pode ter um máximo de 20 valores de tag. Um valor de tag pode estar vazio, mas a estrutura não pode estar ausente. Os valores de tag da mesma chave devem ser exclusivos. A resposta retorna recursos que contêm todas as tags desta lista. As chaves nesta lista estão em uma relação AND, enquanto os valores em cada estrutura chave-valor estão em uma relação OR. Se este parâmetro não for especificado, todos os recursos serão retornados. Para obter detalhes, consulte Tabela 3. |
| sys_tags | Não | List<tag> | Inclui tags do sistema. Este parâmetro está disponível apenas para usuários com a permissão op_service. Não pode ser usado com critérios de filtragem without_any_tag e tags ao mesmo tempo. Atualmente, contém apenas uma estrutura de tag. key: _sys_enterprise_project_id value: o ID de um projeto corporativo. A chave contém apenas um valor. O valor 0 indica o projeto corporativo padrão. Para obter detalhes, consulte Tabela 3. |
| matches | Não | List<match> | Os campos a serem correspondidos. A chave em match é um valor de dicionário fixado em resource_name, o que significa que a pesquisa de prefixo é realizada com base no valor da chave. Será estendido posteriormente. Para obter detalhes, consulte Tabela 4. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| key | Sim | String | A chave da tag. Uma chave de tag pode conter no máximo 128 caracteres. Pode conter letras, dígitos e espaços representáveis em UTF-8 e caracteres especiais (_.:=+-@). Não pode começar ou terminar com um espaço e não pode ser deixada em branco. Chaves de tag que começam com _sys_ são tags do sistema, e você não pode iniciar uma chave de tag com _sys_. |
| values | Sim | List<String> | A lista de valores de tag. Um valor pode ser uma matriz vazia, mas não pode ser deixado em branco. Se values for uma matriz vazia, qualquer valor será consultado. Os valores estão no relacionamento OR. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| key | Sim | String | A chave. A chave está fixada em resource_name no momento. Outros valores de key estarão disponíveis posteriormente. |
| value | Sim | String | O valor. Cada valor de tag pode conter um máximo de 255 caracteres Unicode. O conjunto de caracteres não foi verificado. |
Parâmetros de resposta
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| resources | Sim | List<resource> | A lista de recursos. Para obter detalhes, consulte Tabela 6. |
| total_count | Sim | Integer | O número total de registros. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| resource_id | Sim | String | O ID do recurso. |
| resource_detail | Sim | Object | Os detalhes do recurso. É deixado em branco por padrão. O valor é um objeto de recurso usado para extensão. |
| tags | Sim | List<resource_tag> | A lista de tags. Se não houver tag, uma matriz vazia é usada por padrão. Para obter detalhes, consulte Tabela 3. |
| sys_tags | Não | List<resource_tag> | Este parâmetro está disponível apenas para usuários com a permissão op_service. Atualmente, contém apenas uma estrutura de resource_tag. key: _sys_enterprise_project_id value: o ID do projeto corporativo. O valor 0 indica o projeto corporativo padrão. Para obter detalhes, consulte Tabela 3. |
| resource_name | Sim | String | O nome do recurso. Este parâmetro é uma cadeia vazia se não houver nome de recurso. |
Exemplo de solicitação
Listagem de recursos (com o ID do projeto definido como c80a2157ba1d46c0825265947342077c, deslocamento como 0 e limite como 10):
POST https://{endpoint}/v3/sfs/tms/c80a2157ba1d46c0825265947342077c/file-systems/resource-instances/filter?limit=10&offset=0 Exemplo de corpo da solicitação:
{
"tags":[
{
"key":"key1",
"values":[
"value1",
"value2"
]
},
{
"key":"key2",
"values":[
"value1",
"value2"
]
}
],
"matches":[
{
"key":"resource_name",
"value":"resource1"
}
],
"without_any_tag":"false"
} Exemplo de resposta
{
"resources":[
{
"resource_detail":"",
"resource_id":"resource1",
"resource_name":"resource1",
"tags":[
{
"key":"key1",
"value":"value1"
}
],
"sys_tags":[]
}
],
"total_count":1
} Códigos de status
- Normal
| Código de status | Descrição |
|---|---|
| 200 | Os recursos estão listados. |
- Anormal
| Código de status | Descrição |
|---|---|
| 400 | Parâmetro de tag inválido. |
| 401 | Falha na certificação. |
| 403 | Falha na autenticação. |
| 404 | Recurso não encontrado. |
| 500 | Erro do sistema. |