找不到 API ? 点击 反馈吧
- 标签管理
- 集群管理
- 租户管理
- 租户账号管理
- 数据库管理
- 参数管理
- 会话连接
- 诊断管理
- 安全设置
- 监控管理
- 数据传输
- 创建任务CreateProject
- 启动任务StartProject
- 暂停任务StopProject
- 恢复任务ResumeProject
- 释放任务ReleaseProject
- 删除任务DeleteProject
- 分页查询任务列表ListProjects
- 查询任务的详情DescribeProject
- 查询任务步骤的详情DescribeProjectSteps
- 查询任务步骤的指标DescribeProjectStepMetric
- 查询任务的进度DescribeProjectProgress
- 查询任务的组件信息DescribeProjectComponents
- 查询任务的全量校验结果ListProjectFullVerifyResult
- 启动指定标签下所有未启动的任务StartProjectsByLabel
- 暂停指定标签下所有运行中的任务StopProjectsByLabel
- 获取上传 OSS URLGetUploadOssUrl
- 查询传输实例列表ListWorkerInstances
- 创建 MySQL 数据源CreateMySqlDataSource
- 创建 OceanBase 数据源CreateOceanBaseDataSource
- 查询数据源列表ListDataSource
- 创建标签CreateLabel
- 查询标签列表ListAllLabels
- 新建 MySQL 数据源CreateOmsMysqlDataSource
- 释放传输实例ReleaseWorkerInstance
- 取消修改操作CancelProjectModifyRecord
- 重试修改操作RetryProjectModifyRecords
- 终止修改操作StopProjectModifyRecords
- 查询任务的修改记录ListProjectModifyRecords
- 修改传输对象CreateProjectModifyRecords
- 更新任务配置UpdateProjectConfig
- 删除数据源DeleteDataSource
- 创建 RDS PostgreSQL 数据源CreateRdsPostgreSQLDataSource
- 备份恢复
- 未翻译(其他)
- 其他
ListProjects分页
本接口用于数据迁移或数据同步任务列表页面的分页查询
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
SearchKey数据迁移或数据同步任务的名称/ID
Type任务的类型
Status数据迁移或数据同步任务的状态集合
LabelIds标签 ID 的集合
SourceEndpointTypes源端数据源类型的集合
SinkEndpointTypes目标端数据源类型的集合
VisibleSubProject是否展示子任务
请选择布尔值
SortField排序字段
Order排列顺序
NeedRelatedInfo是否需要查询任务关联信息(数据源连接信...
请选择布尔值
分页参数
PageNumber页序号
PageSize页大小
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
请求参数
字段名称 | 字段详情 |
---|---|
SearchKeystring | 数据迁移或数据同步任务的名称/ID。 示例值:np_4w**** |
Typestring | 任务的类型,包括 示例值:MIGRATION枚举值:MIGRATIONSYNC |
Statusarray<string> | 数据迁移或数据同步任务的状态集合,包括 INIT(未启动), RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)、RUNNING_MERGING(合并中)、RUNNING_ALARMING(告警中)和 UNCONFIGURED(待配置)。 枚举值: |
LabelIdsarray<string> | 标签 ID 的集合,最多支持 5 个。 |
SourceEndpointTypesarray<string> | 源端数据源类型的集合。 |
SinkEndpointTypesarray<string> | 目标端数据源类型的集合。 |
VisibleSubProjectboolean | 是否展示子任务。 示例值:false |
SortFieldstring | 排序字段,包括 示例值:gmtCreate |
Orderstring | 排列顺序,包括 示例值:descend枚举值:ascdescend |
NeedRelatedInfoboolean | 是否需要查询任务关联信息(数据源连接信息、传输实例信息、任务步骤信息等),默认值为 true。 示例值:true |
PageNumberinteger<int32> | 页序号,分页查询时生效。 示例值:1 |
PageSizeinteger<int32> | 页大小,分页查询时生效。 示例值:10取值 <= 150 |
返回参数
字段名称 | 字段详情 |
---|---|
Successboolean | 是否调用成功。 示例值:true |
ErrorDetailobject | 错误详情。 |
Codestring | 错误码(旧)。 示例值:INNER_ERROR |
Messagestring | 错误描述(旧)。 示例值:A system error occurred.
|
Advicestring | 建议(旧)。 示例值:Contact the administrator. |
RequestIdstring | 请求 ID。 示例值:EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
PageNumberinteger<int32> | 页序号,分页查询时生效。 示例值:1 |
PageSizeinteger<int32> | 页大小,分页查询时生效。 示例值:10 |
TotalCountinteger<int64> | 总数,分页查询时生效。 注意
请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。 示例值:4 |
Coststring | 请求耗时,单位为秒。 示例值:1 |
Dataarray<object> | 任务列表的相关信息。 |
返回说明
附录
Kafka
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"username":null,
"enableSSL":null,
"enableSASL":null,
"saslMechanism":null,
"disableIdentificationAlgorithm":false
}
}
参数 | 类型 | 描述 |
---|---|---|
endpoint | string | 服务地址。 |
username | string | 用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时,该参数必填。 |
enableSSL | boolean | 是否开启 SSL 认证。如果开启,则需要上传授信证书。 |
enableSASL | boolean | 是否开启 SASL 认证。 |
saslMechanism | KafkaSaslMechanisnEnum | 加密方式,包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。 |
disableIdentificationAlgorithm | boolean | SSL 加密时,是否开启主机名验证。 |
DataHub
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"project":"detx***"
}
}
参数 | 类型 | 描述 |
---|---|---|
endpoint | string | 服务地址。 |
project | string | 任务的名称。 |
RocketMQ
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"endpointType":null,
"version":null
}
}
参数 | 类型 | 描述 |
---|---|---|
endpoint | string | 服务地址。 |
endpointType | CloudRocketMQEndpoint.Type | 服务地址的类型。 |
version | CloudRocketMQInst.Version | RocketMQ 的版本。 |
OceanBase
{
"connExtraAttributes":{
"cluster":"xgez***",
"tenant":"gexr**",
"isLogicSource":false,
"useLogProxy":true,
"drcUser":"tes***",
"configUrl":"http://xxx.xxx.xxx.1:2883/service****",
"logProxyIp":"xxx.xxx.xxx.2",
"logProxyPort":2883,
"noUserAuth":false
}
}
参数 | 类型 | 描述 |
---|---|---|
cluster | string | 集群的名称。 |
tenant | string | 租户的名称。 |
isLogicSource | boolean | 是否为逻辑数据源。 |
useLogProxy | boolean | 是否使用 LogProxy。 |
drcUser | string | drc_user 的配置。 |
configUrl | string | 用于获取 OceanBase 数据库底层服务器的真实地址。 |
logProxyIp | string | LogProxy 服务的 IP 地址。 |
logProxyPort | integer | LogProxy 服务的端口。 |
noUserAuth | boolean | 对于同步 DataWorks 的接口,数据源是 OMS 自动生成的。如果没有用户账号和密码,则不能连接用户的 OceanBase 数据库。 |
TiDB
{
"connExtraAttributes":{
"kafkaId":"e_edz****",
"kafkaTopic":"test**",
"kafkaName":"denz***"
}
}
参数 | 类型 | 描述 |
---|---|---|
kafkaId | string | 绑定的 Kafka 数据源的 ID。 |
kafkaTopic | string | 绑定的 Kafka Topic 的名称。 |
kafkaName | string | 绑定的 Kafka 数据源的名称。 |
变更历史
暂无变更历史