You need to enable JavaScript to run this app.
导航
DescribeTransitRouterRegions
最近更新时间:2024.07.09 08:42:34首次发布时间:2023.09.12 10:21:33

调用 DescribeTransitRouterRegions 接口,查询当前账号支持的地理区域及地域信息。

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeTransitRouterRegions要执行的操作,取值为DescribeTransitRouterRegions。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。

GeographicRegionSetId

String

China

地理区域的ID。取值如下:

  • China:中国大陆。

RegionIds.N

String

RegionIds.1=cn-beijing&RegionIds.2=cn-guangzhou

地域ID。您可以参考地域介绍获取地域ID。

  • 参数 - N:表示地域ID的序号,取值范围为1~100,单次最多可查询100个。
  • 多个地域ID之间使用“&”分隔。
PageNumberInteger1列表的页码,默认值为1。
PageSizeInteger20分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。

返回参数

名称类型示例值描述
PageSizeinteger20当前分页的行数。
PageNumberinteger1当前页码。
TotalCountInteger2符合条件的地域总数。
RegionsArray of Struct-符合条件的地域的详细信息。具体请参见下表“ Regions ”。

Regions

名称类型示例值描述

GeographicRegionSetId

String

China

地理区域ID。

  • China:中国大陆。
RegionTypeStringpublic地理区域中地域的类型。
RegionIdStringcn-beijing地理区域中地域的ID。
RegionNameString华北2(北京)地理区域中地域的名称。

请求示例

GET /?Action=DescribeTransitRouterRegions&Version=2020-04-01&GeographicRegionSetId=China HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterRegions",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Regions": [
            {
                "GeographicRegionSetId": "China",
                "RegionType": "public",
                "RegionId": "cn-beijing"
                "RegionName": "华北2(北京)"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.已达到单次可查询的实例数量上限。