获取一个域名的记录集列表。
请求频率:每秒最多调用 10 次。
参见 基本概念 了解什么是记录集。
在调用该 API 之前,您必须确保在调用 CreatePrivateZone API 创建域名时开启了负载均衡功能。如果您的域名没有开启负载均衡功能,您可以调用 UpdatePrivateZone API 更新负载均衡配置。否则,API 会返回 ErrWeightDisabled 错误。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListRecordSets | 要执行的操作,取值:ListRecordSets。 |
Version | String | 是 | 2022-06-01 | API的版本,取值:2022-06-01。 |
ZID | Integer | 是 | 1234 | 域名 ID。您可以通过以下 API 获取: |
PageNumber | Integer | 否 | 1 | 页码。页数由获取的记录集总数和 |
PageSize | Integer | 否 | 10 | 每页包含的记录集的数量。 |
SearchMode | String | 否 | LIKE | 查询模式,用于搜索
|
Host | String | 否 | www | 主机记录(域名前缀)。如果您不传入该参数,则该参数不作为查询条件。 |
RecordSetID | String | 否 | OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w | 解析记录记录集 ID。如果您已经通过该 API 获取了 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
TotalCount | Integer | 10 | 记录集的总数量。 |
PageNumber | Integer | 1 |
|
PageSize | Integer | 10 | 每页包含的记录集的数量。 |
RecordSets | Array of Object | 无 | 记录集列表。 |
GET https://private-zone.volcengineapi.com/?Action=ListRecordSets&Version=2022-06-01&PageNumber=1&PageSize=10&ZID=1135&Host=www
{ "ResponseMetadata": { "RequestId": "20221216154121E2DE2FD52644751C1DDF", "Action": "ListRecordSets", "Version": "2022-06-01", "Service": "private_zone", "Region": "cn" }, "Result": { "TotalCount": 1, "PageNumber": 1, "PageSize": 10, "RecordSets": [ { "ID": "OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w", "FQDN": "www.example.com", "Host": "www", "Type": "A", "Line": "default", "WeightEnabled": false } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | ErrZoneNotFound | 未找到域名 |
400 | ErrParamInvalid | 参数校验失败 |
500 | ErrInternalServer | 服务内部错误 |