查看云服务区域 (V1)

即将作废

Lists all available cloud regions of a specific cloud provider.

GET

/v1/regions

Base URL

该 API 的 Base URL 格式如下：

https://controller.api.${CLOUD_REGION}.zilliz.com.cn

📘说明

• 你需要将 ${CLOUD_REGION} 替换为您的集群所在区域。
• 获取云区域 ID 请参考 Zilliz Cloud 控制台 或使用查看云区域接口。

export CLOUD_REGION="ali-cn-hangzhou"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

cloudIdstringquery

有效云提供商的 ID。

示例值：ali

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/regions" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

A success response.

codeinteger

响应码。

dataarray

响应载荷，一个包含有关云地域信息的对象。

[]dataobject

A cloud region.

cloudIdstring

云提供商的 ID。

regionIdstring

云地域的 ID。

domainstring

Zilliz Cloud Open API 的 Base URL。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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

SUCCESS

{
    "code": 200,
    "data": [
        {
            "cloudId": "ali",
            "domain": "*.api.ali-cn-hangzhou.cloud.zilliz.com.cn",
            "regionId": "ali-cn-hangzhou"
        }
    ]
}