Consulta de tags da CMK
Função
Essa API permite que você consulte tags de uma CMK especificada. O TMS pode usar essa API para consultar todas as tags de uma CMK especificada.
URI
GET /v1.0/{project_id}/kms/{key_id}/tags
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. |
| key_id | Sim | String | ID de CMK. |
Parâmetros de solicitação
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| sequence | Não | String | Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| tags | Array of TagItem objects | Lista de tags, que é uma coleção de pares de chave-valor.
|
| existTagsNum | Integer | - |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| key | String | Chave. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=). |
| value | String | Valor. Um valor de marca pode conter um máximo de 43 caracteres Unicode e pode ser uma cadeia de caracteres vazia. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas () e sinais de igual (=). |
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Object | Mensagem de erro. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Informação de erro. |
Código de status: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Object | Mensagem de erro. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Informação de erro. |
Código de status: 404
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Object | Mensagem de erro. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Informação de erro. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
Processamento da solicitação bem-sucedido.
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ],
"existTagsNum" : 2
} Código de status: 400
Parâmetros de solicitação inválidos.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
} Código de status: 403
Autenticação falhou.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
} Código de status: 404
O recurso solicitado não existe ou não foi encontrado.
{
"error" : {
"error_code" : "KMS.XXX",
"error_msg" : "XXX"
}
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | Processamento da solicitação bem-sucedido. |
| 400 | Parâmetros de solicitação inválidos. |
| 403 | Autenticação falhou. |
| 404 | O recurso solicitado não existe ou não foi encontrado. |
Códigos de erro
Consulte Códigos de erro.