You need to enable JavaScript to run this app.
导航

获取调度列表

最近更新时间2023.12.11 15:33:35

首次发布时间2022.10.24 20:57:01

API 说明

API 名称:ListDnsSchedules
API 域名:open.volcengineapi.com
API 描述:获取您在多云CDN中创建的调度策略列表。

请求方法

POST

使用限制

节流限制:每秒最多提交 30 个请求。

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
Action
String
API 的名称。该参数的取值是 ListDnsSchedules
Version
String
API 的版本。该参数的取值是 2022-03-01

请求正文

参数名称
数据类型
是否必选
参数说明
示例
DomainName
String
在调度策略中配置的域名。
如果不指定该参数,则获取所有域名的调度策略。
www.example.com
ScheduleStatus
String
调度策略的状态。
如果不指定该参数,则查询时不对状态进行筛选。该参数有以下取值:
  • Enable:表示已启用。
  • Disable:表示未启用。
  • Pending:表示正在生效。
Enable
CloudAccountIds
String[]
云服务商账号的 ID。
账号 ID 是多云CDN为云服务商账号生成的唯一 ID。只用于多云CDN业务系统。如果不指定该参数,则查询时不对云服务商账号进行筛选。
63477ac389c27cc310f3****
Pagination
PagingOption
对查询结果进行分页并返回特定页码上的调度策略。如果不指定该参数,则使用该参数的默认值对结果进行分页并返回结果。

响应正文

参数名称
数据类型
参数说明
示例
DnsSchedules
DnsScheduleListItem[]
调度策略的列表。
Pagination
PagingResult
一个分页详情的对象。

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-03-01&Action=ListDnsSchedules&<其他公共请求参数>
{
    "Pagination":{
        "PageSize": 2,
        "PageNum": 1
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "202210241615420102120440190F464675",
        "Action": "ListDnsSchedules",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DnsSchedules": [
            {
                "Id": "10640325939004****",
                "DomainName": "www.example.com",
                "ScheduleCname": "www.example.com.210023****.volcmcdn1.com",
                "ScheduleStatus": "Enable",
                "IsAbnormal": false,
                "Region": "Domestic",
                "CloudAccountIds": [
                    "63477ac389c27cc310f3****",
                    "63468c0034f4d352eded****",
                    "63477aa489c27cc310f3****"
                ],
                "UpdatedAt": 1666334940
            }
        ],
        "Pagination": {
            "PageSize": 2,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误代码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见错误码