获取机房列表 ListDc--云手机-火山引擎

文档中心

立即注册

导航

获取机房列表 ListDc

最近更新时间：2025.03.21 16:22:51首次发布时间：2024.03.04 19:40:01

检索具有资源购买权限的机房列表。
使用本接口，可获取指定业务范围内所有具备实例购买权限的机房的详细信息，辅助资源规划和采购决策。

使用说明

本接口提供灵活的机房信息检索功能，您可以执行全量机房信息查询，或根据资源规格、所在地区等特定条件进行筛选，以获取满足特定需求的机房列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListDc&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListDc`	接口名称。当前 API 的名称为 `ListDc`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，用于指定想要查询的目标业务。可登录云手机控制台，在已创建的业务卡片中获取。
VolcRegion	String	否	`inner`	机房所在的地区 ID。使用本参数可以筛选出指定地区的机房进行查询。包含以下选项： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
Region	String	否	`cn-north`	机房所在的大区 ID。使用本参数可以筛选出指定大区的机房进行查询。若指定 `VolcRegion` 为 `inner`，则本参数包含以下选项： `cn-north`：华北 `cn-south`：华南 `cn-east`：华东 `cn-middle`：华中 `cn-southwest`：西南若指定 `VolcRegion` 为 `cn-hongkong-pop`，则本参数可选值仅为 `cn-hongkong-pop`。
Isp	Integer	否	`1`	网络运营商 ID。使用本参数可以筛选出指定运营商的机房进行查询。包含以下选项： `1`：移动 `2`：联通 `4`：电信 `7`：移动&联通&电信（三线） `8`：BGP
ServerTypeCode	String	否	`g2.8c12g`	云机规格。本地存储业务可使用本参数筛选出含有指定规格云机的机房进行查询。取值详情参看本地存储云机规格列表。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of DcInfo	`-`	机房信息详情。
Total	Long	`2`	查询结果总量。

DcInfo

参数	类型	示例值	描述
Dc	String	`gdsz-ctcucm-01-1`	机房 ID。
DcName	String	`广东深圳三线01-1`	机房名称。
Region	String	`cn-south`	机房所在区域。包含以下取值： `cn-north`：中国大陆华北 `cn-south`：中国大陆华南 `cn-east`：中国大陆华东 `cn-middle`：中国大陆华中 `cn-southwest`：中国大陆西南 `cn-hongkong-pop`：中国香港
Isp	Integer	`7`	网络运营商。包含以下取值： `1`：移动 `2`：联通 `4`：电信 `7`：移动&联通&电信（三线） `8`：BGP
Longitude	Double	`114.09`	机房所在城市经度。
Latitude	Double	`22.55`	机房所在城市纬度。
DcType	String	`-`	机房类型。
Zone	String	`gdsz-ctcucm-01`	机房所属的片区 ID。说明相同片区内的机房共享存储资源池。
ServerTypeCode	String	`g2.8c12g`	机房内的云机规格。
VolcRegion	String	`inner`	机房所在地区，包含以下取值： `inner`：中国大陆 `cn-hongkong-pop`：中国香港

请求示例

GET https://open.volcengineapi.com?Action=ListDc&Version=2023-10-30&ProductId=1591495366954xxxxxx&Region=cn-north&Isp=1&Offset=0&Count=10&ServerTypeCode=g2.8c12g&VolcRegion=inner

返回示例

{
    "ResponseMetadata": {
        "Action": "ListDc",
        "Region": "cn-north-1",
        "RequestId": "202411281425173037A5D6F9E26Exxxxxx",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": {
        "Row": [
            {
                "Dc": "gdsz-ctcucm-01-1",
                "DcName": "广东深圳三线01-1",
                "Region": "cn-south",
                "Isp": 7,
                "Longitude": 114.09,
                "Latitude": 22.55,
                "DcType": "",
                "Zone": "gdsz-ctcucm-01",
                "ServerTypeCode": "g2.8c12g",
                "VolcRegion": "inner"
            },
            {
                "Dc": "hk-ctcucm-01-1",
                "DcName": "香港BGP-01-1",
                "Region": "cn-hongkong-pop",
                "Isp": 8,
                "Longitude": 114.16,
                "Latitude": 22.3,
                "DcType": "",
                "Zone": "hk-ctcucm-01",
                "ServerTypeCode": "g2.8c12g",
                "VolcRegion": "cn-hongkong-pop"
            }
        ],
        "Total": 2
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。