Skip to main content

Query Geographic Information

Use this API to retrieve available regions in NineData. Use the returned region IDs when creating or updating data sources that need regional metadata.

Call this API before automated data source provisioning if your workflow needs to select a region programmatically. Store the returned regionId with the data source configuration so later update or audit jobs can use the same regional metadata.

Request URL: /openapi/v1/region/list

Request Method: GET

Request Parameters​

None.

Response Parameters​

ParameterTypeDescriptionExample
successBoolWhether the API call is successful. Return values: true, false.true
requestIdStringRequest ID.Dz6k0CFF-BHEEhOCnCHCz3CMdIIf0QHB
dataArrayRegion list, including region ID (regionId), region name (name), and other information.{
"regionId": "CIDC-RP-25_CIDC-RP-25-57",
"name": "East China-Suzhou (Available Zone 1)"
}

Successful Invocation Example​

{
    "success": true,
    "requestId": "Dz6k0CFF-BHEEhOCnCHCz3CMdIIf0QHB",
    "data": [{
        "regionId": "aliyun-cn-hangzhou",
        "name": "nd.basic.region.aliyun.hangzhou"
    }, {
        "regionId": "aliyun-cn-shanghai",
        "name": "nd.basic.region.aliyun.shanghai"
    }, {
        "regionId": "aliyun-cn-qingdao",
        "name": "nd.basic.region.aliyun.qingdao"
    }, {
        "regionId": "aliyun-cn-beijing",
        "name": "nd.basic.region.aliyun.beijing"
    }, {
        "regionId": "aliyun-cn-zhangjiakou",
        "name": "nd.basic.region.aliyun.zhangjiakou"
    }, {
        "regionId": "aliyun-cn-shenzhen",
        "name": "nd.basic.region.aliyun.shenzhen"
    }, {
        "regionId": "aliyun-cn-chengdu",
        "name": "nd.basic.region.aliyun.chengdu"
    }, {
        "regionId": "tencent-ap-shanghai",
        "name": "nd.basic.region.tencent.shanghai"
    }, {
        "regionId": "tencent-ap-chongqing",
        "name": "nd.basic.region.tencent.chongqing"
    }, {
        "regionId": "tencent-ap-chengdu",
        "name": "nd.basic.region.tencent.chendu"
    }, {
        "regionId": "tencent-ap-beijing",
        "name": "nd.basic.region.tencent.beijing"
    }, {
        "regionId": "tencent-ap-nanjing",
        "name": "nd.basic.region.tencent.nanjing"
    }, {
        "regionId": "tencent-ap-guangzhou",
        "name": "nd.basic.region.tencent.guangzhou"
    }, {
        "regionId": "huawei-cn-north-9",
        "name": "nd.basic.region.huawei.wlcb"
    }, {
        "regionId": "huawei-cn-south-1",
        "name": "nd.basic.region.huawei.guangzhou"
    }, {
        "regionId": "huawei-cn-southwest-2",
        "name": "nd.basic.region.huawei.guiyang1"
    }, {
        "regionId": "huawei-cn-north-4",
        "name": "nd.basic.region.huawei.beijing4"
    }, {
        "regionId": "huawei-cn-north-1",
        "name": "nd.basic.region.huawei.beijing1"
    }, {
        "regionId": "huawei-cn-east-2",
        "name": "nd.basic.region.huawei.shanghai2"
    }, {
        "regionId": "huawei-cn-east-3",
        "name": "nd.basic.region.huawei.shanghai1"
    }, {
        "regionId": "aws-us-east-1",
        "name": "nd.basic.region.aws.us.east"
    }, {
        "regionId": "ecloud-suzhou",
        "name": "nd.basic.region.ecloud.suzhou"
    }, {
        "regionId": "CIDC-RP-25_CIDC-RP-25-57",
        "name": "East China-Suzhou (Available Zone 1)"
    }, {
        "regionId": "baidu-beijing",
        "name": "nd.basic.region.baidu.wuhan"
    }, {
        "regionId": "aws-ap-southeast-1",
        "name": "nd.basic.region.aws.ap.southeast.1"
    }, {
        "regionId": "huawei-ap-southeast-4",
        "name": "nd.common.region.huawei.jakarta"
    }]
}

Result​

A successful response returns the available regions. Use the returned regionId as the region value when you create or update a data source.