Skip to main content

List Cloud Regions

Lists all available cloud regions of a specific cloud provider.


GET
https://controller.api.{cloud-region}.zillizcloud.com/v1/regions

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request GET \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/regions?cloudId=gcp" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

You can obtain valid cloudId values by performing List Cloud Providers operations.

Success response:

{
"code": 200,
"data": [
{
"apiBaseUrl": "https://api.gcp-us-west1.zillizcloud.com",
"cloudId": "gcp",
"regionId": "gcp-us-west1"
}
]
}

Request

Parameters

  • Query parameters

    ParameterDescription
    cloudIdstring
    The ID of a valid cloud provider.
  • No path parameters required

Request Body

No request body required

Response

Returns a list of all available regions that the specified cloud provider offers.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": [
{
"cloudId": "string",
"regionId": "string",
"apiBaseUrl": "string"
}
]
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
dataarray
data[]object
data[].cloudIdstring
The ID of a cloud provider
data[].regionIdstring
The ID of a cloud region
data[].apiBaseUrlstring
The base URL of an Zilliz Cloud open API endpiont
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
80001The token is illegal
80002The token is invalid
90117Invalid domain name used