1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
获取实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目/工作空间id 示例值："11022568003970304" |
| PageIndex | 是 | Integer | 页码 示例值：1 |
| PageSize | 是 | Integer | 一页展示的条数 示例值：10 |
| CycleList.N | 是 | Array of String | 周期列表（如天，一次性），可选 示例值：[] |
| OwnerList.N | 是 | Array of String | 责任人 示例值：[] |
| InstanceType | 是 | String | 跟之前保持一致 示例值：ALL |
| Sort | 是 | String | 排序顺序（asc，desc） 示例值：desc |
| SortCol | 是 | String | 排序列（costTime 运行耗时，startTime 开始时间，state 实例状态，curRunDate 数据时间） 示例值：startTime |
| TaskTypeList.N | 是 | Array of Integer | 类型列表（如python任务类型：30 pyspark任务类型：31 hivesql任务类型：34 shell任务类型：35 sparksql任务类型：36 jdbcsql任务类型：21 dlc任务类型：32），可选 示例值：[27] |
| StateList.N | 是 | Array of Integer | 状态列表（如成功 2，正在执行 1），可选 示例值：[2] |
| Keyword | 否 | String | 任务名称 示例值：123 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 结果 示例值：true |
| InstanceList | Array of InstanceList | 实例列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 总条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取离线运维实例列表
获取离线运维实例列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceList
<公共请求参数>
{
"ProjectId": "11022568003970304",
"PageIndex": 0,
"PageSize": 0,
"CycleList": [
"12312"
],
"OwnerList": [
"tom"
],
"InstanceType": "2",
"Sort": "DESC",
"SortCol": "name",
"TaskTypeList": [
0
],
"StateList": [
0
],
"Keyword": "123"
}输出示例
{
"Response": {
"Data": "true",
"InstanceList": [
{
"CostTime": "1234",
"CurRunDate": "2022-04-10 19:38:37",
"CycleType": "2",
"DoFlag": 0,
"InCharge": "1231",
"LastLog": "LastLog",
"SchedulerDesc": "descripe",
"StartTime": "2022-04-10 19:38:37",
"State": "COMPLETED",
"TaskId": "20220408130054538",
"TaskName": "1",
"TryLimit": 0
}
],
"TotalCount": 0,
"RequestId": "as1cs2c123asyi23bh213cc"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |