ListProjects_云数据库 OceanBase 版_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求参数

字段名称	字段详情
SearchKeystring	数据迁移或数据同步任务的名称/ID。示例值:np_4w****
Typestring	任务的类型，包括 `MIGRATION`（表示数据迁移任务）和 `SYNC`（表示数据同步任务）。示例值: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` 和 `gmtModified`，默认值为 `gmtCreate`。示例值:gmtCreate
Orderstring	排列顺序，包括 `asc`（升序）和 `descend`（降序）。默认值为 `descend`。示例值: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 数据源的名称。

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-03-20	变更请求参数Status 变更请求参数VisibleSubProject 新增请求参数NeedRelatedInfo 变更返回参数

ListProjects_云数据库 OceanBase 版_API文档

流控信息

授权信息

请求参数

返回参数

返回说明

附录

Kafka

DataHub

RocketMQ

OceanBase

TiDB

返回示例

变更历史

相关示例