Help Center/ EventGrid/ API Reference/ APIs/ Metric Management/ Obtaining Event Subscription Metrics
Updated on 2023-05-24 GMT+08:00
View PDF

Obtaining Event Subscription Metrics

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 project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

filter

No

String

Statistics mode of the metric data.

Default: AVG

Enumeration values:

  • AVG

  • MIN

  • MAX

period

No

Integer

Statistical period of the metric data, in minutes.

Default: 1

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.

Enumeration values:

  • OFFICIAL

  • CUSTOM

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.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

Minimum: 0

Maximum: 100

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.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

None

Example Responses

Status code: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

Status code: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

Status code: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code

Description

200

Operation successful.

400

Invalid request.

401

Unauthorized.

403

Access denied.

404

Resource not found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Metric Management