【旧版】机房列表 ListDc--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】机房列表 ListDc

最近更新时间：2024.06.17 19:36:15首次发布时间：2022.04.06 15:32:23

查询当前业务已订购的机房列表信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	ListDc
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
region	Query	string	否	筛选条件，区域	可选项： cn-north => 华北 cn-south => 华南 cn-east => 华东 cn-middle => 华中 cn-southwest => 西南
isp	Query	int32	否	筛选条件，运营商	网络运营商： 1 => 移动 2 => 联通 4 => 电信 7 => 移动&联通&电信
offset	Query	int64	否	分页偏移量	例：0
count	Query	int64	否	单页数量	例：10

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
字段	类型	说明
total	int32	查询结果总量
row	`List<Dc>`	查询到的机房信息列表，详细信息，参考 Dc 定义

示例

请求示例

GET https://open.volcengineapi.com?Action=ListDc
&Version=2022-08-01
&product_id=1591495366954xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListDc",
        "Region": "cn-north-1",
        "RequestId": "202310261137482CBD3DAD7A7F76F80BDF",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "dc": "jswx-ctcucm-01-xxxxxxxx",
                "dc_name": "XXXX三线01-1",
                "zone": "jswx-ctcucm-01",
                "longitude": 120.3,
                "latitude": 31.57,
                "isp": 7,
                "region": "cn-east",
                "dc_type": ""
            },
            {
                "dc": "gdsz-ctcucm-01-xxxxxxxx",
                "dc_name": "XXXX三线01-1",
                "zone": "gdsz-ctcucm-01",
                "longitude": 114.09,
                "latitude": 22.55,
                "isp": 7,
                "region": "cn-south",
                "dc_type": ""
            }
        ],
        "total": 2
    }
}