Help Center/ EventGrid/ API Reference/ APIs/ Professional Event Stream Cluster Management/ Querying AZs of a Professional Event Stream Cluster
Updated on 2025-03-31 GMT+08:00

Querying AZs of a Professional Event Stream Cluster

Function

This API is used to query AZs of a professional event stream cluster.

URI

GET /v1/{project_id}/eventrouter/clusters/availability-zone

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.

Request Parameters

Table 2 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 3 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.

Table 4 Response body parameters

Parameter

Type

Description

zone_names

Array of strings

AZ name.

Example Requests

Query AZs of the professional event stream cluster of ${project_id}.

GET https://{eg_endpoint}/v1/{project_id}/eventrouter/clusters/availability-zone

Example Responses

Status code: 200

Request succeeded.

{
  "zone_names" : [ "az1", "az2" ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.