aiops-获取实例列表

最近更新时间：2024-04-16 17:51:16

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

获取实例列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeScheduleInstances。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
Instances.N	否	Array of InstanceOpsDto	实例列表
CheckFather	否	Boolean	检查父任务类型, true: 检查父任务; false: 不检查父任务示例值：true
RerunType	否	String	重跑类型, 1: 自身; 3: 孩子; 2: 自身以及孩子示例值：1
DependentWay	否	String	实例依赖方式, 1: 自依赖; 2: 任务依赖; 3: 自依赖及父子依赖示例值：1
SkipEventListening	否	Boolean	重跑忽略事件监听与否示例值：true
SonInstanceType	否	String	下游实例范围 1: 所在工作流 2: 所在项目 3: 所有跨工作流依赖的项目示例值：1
SearchCondition	否	InstanceApiOpsRequest	查询条件
OptType	否	String	访问类型
OperatorName	否	String	操作者名称示例值：jack
OperatorId	否	String	操作者id 示例值：11231231032
ProjectId	否	String	项目id 示例值：1531612696090365952
ProjectIdent	否	String	项目标志示例值：project_wedata
ProjectName	否	String	项目名称示例值：project_wedata
PageIndex	否	Integer	索引页码示例值：1
PageSize	否	Integer	页面大小示例值：10
Count	否	Integer	数据总数示例值：100
RequestBaseInfo	否	ProjectBaseInfoOpsRequest	基础请求信息
IsCount	否	Boolean	是否计算总数示例值：false

3. 输出参数

参数名称	类型	描述
Data	CollectionInstanceOpsDto	实例结果集
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例列表示例

获取实例列表

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScheduleInstances
<公共请求参数>

{
    "SearchCondition": {
        "Instance": {
            "ExecutionSpace": "CYCLIC",
            "ProductName": "DATA_DEV"
        }
    },
    "ProjectId": "1460947878944567296",
    "PageIndex": 1,
    "PageSize": 3
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:42",
                    "CurRunDate": "2023-03-15 15:05:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "该实例被手动终止",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:10:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 15:05:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "数据计算"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                },
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:40",
                    "CurRunDate": "2023-03-15 15:00:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "该实例被手动终止",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:05:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 15:00:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "数据计算"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                },
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:38",
                    "CurRunDate": "2023-03-15 14:55:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "该实例被手动终止",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:00:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 14:55:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "数据计算"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                }
            ],
            "PageCount": 3,
            "PageNumber": 1,
            "PageSize": 3,
            "TotalCount": 876,
            "TotalPage": 292
        },
        "RequestId": "20805432-23c1-4c0c-9ae1-a622522034d1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

上一篇: 运维大屏-实例状态分布下一篇: 任务运维-批量补数据（创建补录计划）