查询调度实例详情--多云CDN-火山引擎

文档中心

立即注册

导航

查询调度实例详情

最近更新时间：2024.12.19 15:35:27首次发布时间：2022.12.02 10:27:48

调用本接口查询某个多云流量调度实例的详情，包括基本信息、加速域名地址详情，以及调度实例下当前生效的调度策略的信息等。

使用说明

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

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Id	String	是	要查询的调度实例的 ID。说明调度实例 ID 是多云CDN为调度实例分配的唯一标识符。您可以调用 ListDnsSchedules 接口查询所有调度实例的 ID。	`27557981222815XXXX`

返回参数

参数名称	数据类型	参数说明	示例
DnsScheduleInfo	Object	调度实例的基本信息。
WeightInfos	Object[]	调度实例下当前生效的调度策略的信息列表。

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=ListDnsSchedules&<其他公共请求参数>=
{
    "Id": "27557981222815XXXX"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20241218165757ADAE54A725E41C5C7F2E",
        "Action": "DescribeDnsSchedule",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DnsScheduleInfo": {
            "Id": "36920457944244XXXX",
            "DomainName": "www.example.com",
            "ScheduleCname": "www.example.com.678090.volcm****.com",
            "ScheduleStatus": "Enable",
            "Region": "Domestic",
            "GlobalDomains": [
                {
                    "Id": "669743179921ee75e1db****",
                    "Name": "www.example.com",
                    "Cname": "www.example.com.volc****.com",
                    "Vendor": "volcengine",
                    "Region": "Domestic",
                    "Status": "Online",
                    "CloudAccountId": "65f80f67376dc36ddd17****",
                    "SubProduct": "cdn",
                    "IsEnabled": true
                }
            ],
            "DomesticDomains": [
                {
                    "Id": "669743179921ee75e1db****",
                    "Name": "www.example.com",
                    "Cname": "www.example.com.volc****.com",
                    "Vendor": "volcengine",
                    "Region": "Domestic",
                    "Status": "Online",
                    "CloudAccountId": "65f80f67376dc36ddd17****",
                    "SubProduct": "cdn",
                    "IsEnabled": true
                }
            ],
            "CreatedAt": 1728991631,
            "UpdatedAt": 1733858160,
            "BizNodePath": "/root",
            "BizNodeId": "65485f3f78287dcda3be****",
            "Tags": [],
            "ScheduleStrategies": [
                "Static"
            ],
            "Vendors": [
                "volcengine"
            ]
        },
        "WeightInfos": [
            {
                "Country": "CN",
                "Province": "",
                "Isp": "",
                "WeightInfoItems": [
                    {
                        "DomainId": "669743179921ee75e1db****",
                        "Value": 100,
                        "ActualValue": 100
                    }
                ],
                "Strategy": "Static",
                "RelatedStrategyId": "36920457965635XXXX",
                "IsFailover": false
            }
        ]
    }
}

错误码

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