You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/私网解析 PrivateZone/API 参考/域名管理接口/ListPrivateZones-获取域名列表
ListPrivateZones-获取域名列表
最近更新时间：2024.11.20 11:13:11首次发布时间：2023.02.08 13:11:36
我的收藏

获取域名的列表。

请求说明

  • 请求方式：GET
  • 请求地址：https://open.volcengineapi.com?Action=ListPrivateZones?Version=2022-06-01

请求参数

除了以下参数，您还需要 对请求进行鉴权。

Query

名称类型是否必选示例值描述
ActionString是ListPrivateZonesAPI 的名称。该参数的取值是 ListPrivateZones。
VersionString是2022-06-01API 的版本。该参数的取值是 2022-06-01。
PageNumberInteger否1页码。页数由获取的域名总数和 PageSize 确定。默认为 1。
PageSizeInteger否10每页包含的域名的数量。默认为 10。最大值为 200。
SearchModeString否LIKE查询模式。包括以下模式：
  • LIKE（默认）：模糊查询。
  • EXACT：精确查询。
ZoneNameString否example.com查询域名使用的关键字，例如 example.com。如果您不传入该参数，该参数不作为查询条件。
RecursionModeBoolean否true域名是否开启了递归解析。
  • true：域名开启了递归解析。
  • false：域名未开启递归解析。
如果您不传入该参数，该参数不作为查询条件。
LineModeInteger否0域名是否开启了智能解析和负载均衡。
  • 0：域名关闭了智能解析和负载均衡。
  • 1：域名开启了负载均衡，同时关闭了智能解析。
  • 2：域名关闭了负载均衡，同时开启了智能解析。
  • 3：域名开启了智能解析和负载均衡。
如果您不传入该参数，该参数不作为查询条件。
VpcIDString否vpc-123456关联该域名的 VPC ID。如果您不传入该参数，该参数不作为查询条件。
RegionString否cn-beijing域名生效的地域。如果您不传入该参数，该参数不作为查询条件。
ZIDs.NInteger否ZIDs.1=123&ZIDs.2=234域名 ID。您可以输入一个或多个域名 ID，例如 ZIDs.1=123&ZIDs.2=234。您最多输入 100 个域名 ID。您需要确保 ZIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，该参数不作为查询条件。
ProjectNameString否default域名所属的项目名称。如果您不传入该参数，该参数不作为查询条件。
TagFilters.NString否TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]}域名的标签。您需要指定：
  • N：表示 TagFilters 的序号，取值范围：1～10。N 应按照从小到大的顺序，且必须为连续的数字。
  • 标签键：例如 "Key":"k1"。如果您指定多个标签键，私网解析 PrivateZone 会查询同时包含所有指定标签键的域名。
  • 标签值：例如 Values":["v1", "v2"]。标签值数组的长度取值范围为 1～3。
您可不传入 Values，表示查询时 Values 不作为查询条件。如果您把仅包含空字符串的数组传入 Values ，私网解析 PrivateZone 会查询 Values 为空的标签。如果一个 Values 包含多个值，这些值之间的关系为逻辑或（OR）。

返回参数

ResponseMetadata 对象

名称
类型
描述
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在地域。

Result 对象

名称
类型
描述
Zones
Array of Objects
域名列表。
Total
Integer
域名数量。
PageSize
Integer
每页包含的域名的数量。
PageNumber
Integer
表示 Zones 展示的域名所在的页码。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListPrivateZones&Version=2022-06-01&PageNumber=1&PageSize=1&ZoneName=example

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202309141706528A3C27DED8770CD641CE",
        "Action": "ListPrivateZones",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-north-1"
    },
    "Result": {
        "Zones": [
            {
                "CreatedAt": "2023-09-14T16:54:40+08:00",
                "UpdatedAt": "2023-09-14T16:54:40+08:00",
                "ZID": 37424,
                "ZoneName": "example.com",
                "Remark": "",
                "RecursionMode": false,
                "RecordCount": 1,
                "LineMode": 0,
                "LastOperator": "21xxxxx1",
                "Region": [
                    "华北1（北京）|cn-north-1"
                ],
                "IsGlobal": false,
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "c",
                        "Value": "D"
                    },
                    {
                        "Key": "a",
                        "Value": "A"
                    },
                    {
                        "Key": "b",
                        "Value": "B"
                    }
                ]
            }
        ],
        "Total": 402,
        "PageNumber": 1,
        "PageSize": 1
    }
}

错误码

您可访问公共错误码，获取详细信息。