On this page

Show all

Help Center/ EventGrid/ API Reference/ APIs/ Metric Management/ Obtaining Event Subscription Metrics

Obtaining Event Subscription Metrics

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to obtain the metrics related to event subscription monitoring.

URI

GET /v1/{project_id}/metrics/sub

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
filter	No	String	Statistics mode of the metric data.
period	No	Integer	Statistical period of the metric data, in minutes.
start_time	Yes	Long	Start time for obtaining the metric data.
end_time	No	Long	End time for obtaining the metric data.
subscription_id	Yes	String	ID of the event subscription.
provider_type	No	String	Type of the event target or event channel.
target_id	No	String	ID of the event target.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of records.
result	Array of EventSubMetricsItem objects	Metric data.

**Table 5** EventSubMetricsItem
Parameter	Type	Description
fail_num	Long	Number of failures.
retry_success_num	Long	Number of successful retries.
retry_fail_num	Long	Number of failed retries.
retry_times	Integer	Number of retries.
timestamp	Long	Timestamp.
num	Long	Number of calls.
success_num	Long	Number of successful calls.
process_time	Long	Processing time.
invoke_time	Long	Time when the API is called.

Example Requests

Query the metrics related to event subscription monitoring in average statistics mode.

GET https://{eg_endpoint}/v1/{project_id}/metrics/sub

filter:AVG

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "result" : [ { } ]
}

Status Codes


Status Code	Description
200	Operation successful.

Error Codes

See Error Codes.

Parent topic: Metric Management

Previous topic: Obtaining Event Channel Metrics

Next topic: Event Stream Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot