dadrobna/enterprise-router
1
0
Fork 0
forked from docs/enterprise-router
Code Pull Requests Activity
enterprise-router/api-ref/source/apis/azs/querying_azs.rst
proposalbot bdabc93498 Changes to er_api-ref from docs/doc-exports#716 (ER API 20230411 version 
For de

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-01-16 12:51:15 +00:00

3.8 KiB
Raw Blame History

original_name

ListAvailabilityZone.html

Querying AZs

Function

This API is used to query AZs where enterprise routers can be created. An enterprise router can be created only when an AZ is in the available state.

URI

GET /v3/{project_id}/enterprise-router/availability-zones

Table 1 Path Parameters
Parameter Mandatory Type Description
project_id Yes String Project ID
Table 2 Query Parameters
Parameter Mandatory Type Description
instance_id No String Enterprise router ID
bandwidth_size No Integer

Bandwidth size, in Mbit/s

Minimum: -1

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter Type Description
availability_zones Array of AvailableZone <listavailabilityzone__response_availablezone> objects AZ list
request_id String Request ID
Table 4 AvailableZone
Parameter Type Description
code String AZ code
state String Whether the AZ is available. Value options: available and unavailable

Example Requests

Querying AZs

GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/availability-zones

Example Responses

Status code: 200

OK

{
  "availability_zones" : [ {
    "code" : "az1",
    "state" : "available"
  }, {
    "code" : "az2",
    "state" : "unavailable"
  } ]
}

Status Codes

Status Code Description
200 OK

Error Codes

See Error Codes <errorcode>.