ListTagResources - Elasticsearch: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte a documentação de parâmetros de requisição comuns.

Sintaxe da requisição

GET /openapi/tags HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
Page	Integer	Query	Não	1	Número da página na lista de relações entre recursos e tags. Este campo está obsoleto.
Size	Integer	Query	Não	10	Quantidade de entradas por página. Este campo está obsoleto.
ResourceType	String	Query	Sim	INSTANCE	Tipo de recurso a consultar.
NextToken	String	Query	Não	1d2db86sca4384811e0b5e8707e	Token de paginação. Utilize-o na próxima requisição para obter uma nova página de resultados.
ResourceIds	String	Query	Não	["es-cn-aaa","es-cn-bbb"]	IDs das instâncias a consultar. Especifique os IDs como um array JSON. É possível especificar até 20 IDs.
Tags	String	Query	Não	[{"key":"env","value":"dev"},{"key":"dev", "value":"IT"}]	Tags a consultar. Especifique as tags como uma string JSON contendo até 20 subitens.

Especifique pelo menos um dos parâmetros ResourceIds ou Tags. Caso contrário, a API retornará um erro.
A consulta retorna apenas tags de sistema visíveis. Não é possível consultar tags de sistema invisíveis.

Nota
Tags de sistema são aquelas adicionadas às instâncias do usuário pelos serviços da Alibaba Cloud. Elas se dividem em tags visíveis e invisíveis.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	1	Número da página retornada.
RequestId	String	F99407AB-2FA9-489E-A259-40CF6D******	ID da requisição.
Headers	Object		Cabeçalho da resposta. Este parâmetro está vazio e serve apenas para referência. Não utilize este parâmetro em seu programa. Nota Este parâmetro não está incluído no exemplo de retorno.
X-Total-Count	Integer	10	Quantidade total de entradas TagResource retornadas.
TagResources	Object		Lista de recursos com tags.
TagResource	Array of TagResource		Lista de tags.
TagValue	String	dev	Valor da tag.
ResourceType	String	ALIYUN::ELASTICSEARCH::INSTANCE	Tipo do recurso. Valor fixo: `ALIYUN:: Elasticsearch::INSTANCE`.
ResourceId	String	es-cn-oew1q8bev0002****	ID do recurso.
TagKey	String	env	Chave da tag.

Exemplos

Exemplos de requisição

GET /openapi/tags?ResourceType=INSTANCE&NextToken=1d2db86sca4384811e0b5e8707e******&ResourceIds=["es-cn-aaa","es-cn-bbb"]&Tags=[{"key":"env", "value":"dev"},{"key":"dev", "value":"IT"}] HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemplos de resposta de sucesso

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A5423B74-DBD5-4714-BF28-6725E5BE****",
  "TagResources" : {
    "TagResource" : [ {
      "ResourceType" : "ALIYUN::ELASTICSEARCH::INSTANCE",
      "ResourceId" : "es-cn-oew1q8bev0002****",
      "TagKey" : "env",
      "TagValue" : "dev"
    } ]
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.