获取多云调度实例列表--多云CDN-火山引擎

文档中心

立即注册

导航

获取多云调度实例列表

最近更新时间：2024.08.23 17:21:12首次发布时间：2022.10.24 20:57:01

调用本接口获取多云调度实例的信息列表，包括调度实例 ID、CNAME、启用的调度策略类型等。

说明

多云CDN自动为每个开启多云流量调度的接入域名创建一个多云调度实例（简称“调度实例”）。更多信息，请参见启用多云流量调度。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 10 个 API 请求。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListDnsSchedules&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListDnsSchedules`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
DomainName	String	否	指定一个加速域名，查询与该加速域名模糊匹配的调度实例。	`example.com`
ScheduleStatus	String	否	指定一个状态，查询处于指定状态的调度实例。该参数有以下取值： `Enable`：已启用 `Disable`：未启用 `Pending`：生效中	`Enable`
CloudAccountIds	String[]	否	指定一个或多个云服务商账号的 ID，查询与指定账号关联的调度实例。说明账号 ID 是多云CDN为云服务商账号生成的唯一标识符，只用于多云CDN平台。您可以调用 ListCloudAccounts 接口查询所有云服务商账号 ID。	`654a58632d2d5c7b10dc****`
ExactDomainName	String	否	指定一个加速域名，查询与该加速域名精确匹配的调度实例。	`www.example.com`
Pagination	Object	否	对查询结果进行分页并返回特定页码上的调度实例。
ScheduleStrategy	String	否	指定一个调度策略类型，查询满足以下条件的调度实例：调度实例下启用的调度策略包含指定的策略类型。该参数有以下取值： `Static`：静态调度策略 `Failover`：可用性优先调度策略 `Cost`：成本优先调度策略 `TimePeriod`：分时段调度策略	`Static`
Region	String	否	指定一个调度范围，查询调度范围是指定值的调度实例。该参数有以下取值： `Domestic`：中国内地 `Global`：全球 `Oversea`：全球（不含中国内地）	`Domestic`
SortOrder	String	否	指定调度实例的排序方式。该参数有以下取值： `Asc`：按升序排序 `Desc`（默认）：按降序排序说明该参数需要与 `SortBy` 参数同时使用。	`Desc`
SortBy	String	否	指定调度实例的排序字段。该参数有以下取值： `CreatedAt`（默认）：按创建时间排序 `UpdatedAt`：按更新时间排序说明该参数需要与 `SortOrder` 参数同时使用。	`CreatedAt`

返回参数

参数名称	数据类型	参数说明	示例
DnsSchedules	Object[]	调度实例的信息列表。
Pagination	Object	分页信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240221164450D7E686DD00167FFC3FC9",
        "Action": "ListDnsSchedules",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DnsSchedules": [
            {
                "Id": "27557981222815XXXX",
                "DomainName": "www.example.com",
                "ScheduleCname": "www.example.com.678090.volc****.com",
                "ScheduleStatus": "Enable",
                "Region": "Domestic",
                "CloudAccountIds": [
                    "654a58632d2d5c7b10dc****",
                    "654a5a02b43dd2a58538****",
                    "654a59692d2d5c7b10dc****",
                    "655372974da3635feec7****",
                    "6553732c4da3635feec7****",
                    "655372daa21faa599668****",
                    "6596baa6540a21788fa0****",
                    "6596badbd262c2b7220b****",
                    "65ae5eca60ce269ee6fb****",
                    "65ae5fa2d365c3c705c2****"
                ],
                "CreatedAt": 1706669747,
                "UpdatedAt": 1708488032,
                "BizNodePath": "/web/web01",
                "BizNodeId": "65485c6978287dcda3be****",
                "Tags": [],
                "ScheduleStrategies": [
                    "Static"
                ]
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误码

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