DescribeCustomEventAttribute - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta um evento personalizado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cms:DescribeCustomEventAttribute

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Não	O nome do evento.	test123
EventId	string	Não	O ID do evento.	123****
GroupId	string	Não	O ID do grupo de aplicativos.	123****
SearchKeywords	string	Não	As palavras-chave usadas para pesquisar o evento. Se você precisar consultar o evento personalizado cujo conteúdo contém a e b, defina o valor como a e b. Se você precisar consultar o evento personalizado cujo conteúdo contém a ou b, defina o valor como a ou b.	cms
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1552224365971
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1552227965971
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página.	50

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Nota O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada.	userId:173651113438**** and name:"BABEL_CHECK"
RequestId	string	O ID da solicitação.	60912C8D-B340-4253-ADE7-61ACDFD25CFC
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
CustomEvents	object
CustomEvent	array<object>	Os detalhes do evento.
	object
Time	string	The time when the event occurred. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1552199984000
Name	string	The event name.	BABEL_CHECK
GroupId	string	The ID of the application group.	12345
Content	string	The content of the event.	requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{"autoPay":false,"autoUseCoupon":false,"bid":"26842","buyerId":118935342242**,"commodities":[{"aliyunProduceCode":"cms","chargeType":"PREPAY","commodityCode":"cms_call_num","components":[{"componentCode":"phone_count","instanceProperty":[{"code":"phone_count","value":"500"}],"moduleAttrStatus":1}],"duration":6,"free":false,"orderParams":{"aliyunProduceCode":"cms"},"orderType":"BUY","prePayPostCharge":false,"pricingCycle":"Month","quantity":1,"refundSpecCode":"","renewChange":false,"specCode":"cms_call_num","specUpdate":false,"syncToSubscription":false,"upgradeInquireFinancialValue":true}],"fromApp":"commonbuy","orderParams":{"priceCheck":"true"},"payerId":118935342242,"requestId":"ade3ad32-f58b-45d7-add4-ac542be3d8ec","skipChannel":false,"userId":118935342242**}
Id	string	The event ID.	123

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "userId:173651113438**** and name:\"BABEL_CHECK\"",
  "RequestId": "60912C8D-B340-4253-ADE7-61ACDFD25CFC",
  "Success": "true",
  "CustomEvents": {
    "CustomEvent": [
      {
        "Time": "1552199984000",
        "Name": "BABEL_CHECK",
        "GroupId": "12345",
        "Content": "requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\"autoPay\":false,\"autoUseCoupon\":false,\"bid\":\"26842\",\"buyerId\":118935342242****,\"commodities\":[{\"aliyunProduceCode\":\"cms\",\"chargeType\":\"PREPAY\",\"commodityCode\":\"cms_call_num\",\"components\":[{\"componentCode\":\"phone_count\",\"instanceProperty\":[{\"code\":\"phone_count\",\"value\":\"500\"}],\"moduleAttrStatus\":1}],\"duration\":6,\"free\":false,\"orderParams\":{\"aliyunProduceCode\":\"cms\"},\"orderType\":\"BUY\",\"prePayPostCharge\":false,\"pricingCycle\":\"Month\",\"quantity\":1,\"refundSpecCode\":\"\",\"renewChange\":false,\"specCode\":\"cms_call_num\",\"specUpdate\":false,\"syncToSubscription\":false,\"upgradeInquireFinancialValue\":true}],\"fromApp\":\"commonbuy\",\"orderParams\":{\"priceCheck\":\"true\"},\"payerId\":118935342242****,\"requestId\":\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\",\"skipChannel\":false,\"userId\":118935342242****}",
        "Id": "123"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.