DescribeCustomEventAttribute - CloudMonitor - Alibaba Cloud Documentation Center

Queries the details of a custom event that occurred in a specified time period.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the custom event.	test123
EventId	string	No	The ID of the custom event.	123****
GroupId	string	No	The ID of the application group.	123****
SearchKeywords	string	No	The keywords that are contained in the content of the custom event to query. You can use a logical operator between keywords. If you need to query the custom event whose content contains a and b, set the value to a and b. If you need to query the custom event whose content contains a or b, set the value to a or b.	cms
StartTime	string	No	The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1552224365971
EndTime	string	No	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1552227965971
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	50

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The returned message.	userId:173651113438**** and name:"BABEL_CHECK"
RequestId	string	The ID of the request.	60912C8D-B340-4253-ADE7-61ACDFD25CFC
Success	string	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
CustomEvents	object []	The details of the custom event.
Time	string	The time when the custom event occurred. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1552199984000
Name	string	The name of the custom event.	BABEL_CHECK
GroupId	string	The ID of the application group.	12345
Content	string	The content of the custom 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 ID of the custom event.	123

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
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.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history