{ "name": "ckafka", "display_name": "消息队列 CKafka 版", "description": "介绍如何使用API对消息队列CKafka进行操作，包括管理实例等。", "domain": "database", "api_version": "2019-08-19", "endpoint": "ckafka.tencentcloudapi.com", "actions": [ { "name": "AuthorizeToken", "description": "给实例授权token", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id, 可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "User", "type": "string", "required": true, "description": "用户", "example": "username-test" }, { "name": "Tokens", "type": "string", "required": true, "description": "token串", "example": "827636a7-3643-4afa-a23c-2eb7352e266c" } ], "required": [ "InstanceId", "User", "Tokens" ] }, { "name": "BatchCreateAcl", "description": "批量添加ACL策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "ResourceType", "type": "integer", "required": true, "description": "Acl资源类型，(2:TOPIC）", "example": "2" }, { "name": "ResourceNames", "type": "array", "required": true, "description": "资源列表数组，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。", "example": "[\"test1\",\"test2\"]", "item_type": "string" }, { "name": "RuleList", "type": "array", "required": true, "description": "设置的ACL规则列表，可通过[DescribeAclRule](https://cloud.tencent.com/document/product/597/89217)接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "Operation", "type": "string", "required": true, "description": "Acl操作方式，枚举值(所有操作: All, 读：Read，写：Write)", "example": "Read" }, { "name": "PermissionType", "type": "string", "required": true, "description": "权限类型，Deny：拒绝，Allow：允许。", "example": "Allow" }, { "name": "Host", "type": "string", "required": true, "description": "表示任何host都可以访问", "example": "10.0.0.6" }, { "name": "Principal", "type": "string", "required": true, "description": "用户，User:*表示任何user都可以访问，当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A，传入为User:A。", "example": "User:*" } ] } ], "required": [ "InstanceId", "ResourceType", "ResourceNames", "RuleList" ] }, { "name": "BatchModifyGroupOffsets", "description": "批量修改消费组offset", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "消费分组名称", "example": "groupName-test" }, { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "Partitions", "type": "array", "required": true, "description": "partition信息", "example": "无", "item_type": "object", "children": [ { "name": "Partition", "type": "integer", "required": true, "description": "分区", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "partition 消费位移", "example": "1" } ] }, { "name": "TopicName", "type": "array", "required": false, "description": "指定topic，默认所有topic", "example": "[\"topic-test\"]", "item_type": "string" } ], "required": [ "GroupName", "InstanceId", "Partitions" ] }, { "name": "BatchModifyTopicAttributes", "description": "批量设置主题属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "Topic", "type": "array", "required": true, "description": "主题属性列表 (同一个批次最多支持10个)，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取", "example": "无", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "分区数", "example": "1" }, { "name": "Note", "type": "string", "required": false, "description": "备注", "example": "note-test" }, { "name": "ReplicaNum", "type": "integer", "required": false, "description": "副本数", "example": "2" }, { "name": "CleanUpPolicy", "type": "string", "required": false, "description": "消息删除策略，可以选择delete 或者compact", "example": "compact" }, { "name": "MinInsyncReplicas", "type": "integer", "required": false, "description": "当producer设置request.required.acks为-1时，min.insync.replicas指定replicas的最小数目", "example": "1" }, { "name": "UncleanLeaderElectionEnable", "type": "boolean", "required": false, "description": "是否允许非ISR的副本成为Leader", "example": "false" }, { "name": "RetentionMs", "type": "integer", "required": false, "description": "topic维度的消息保留时间（毫秒）范围1 分钟到90 天", "example": "3600000" }, { "name": "RetentionBytes", "type": "integer", "required": false, "description": "topic维度的消息保留大小，单位为Byte，范围1 GB到1024 GB。", "example": "1073741824" }, { "name": "SegmentMs", "type": "integer", "required": false, "description": "Segment分片滚动的时长（毫秒），范围1 天到90 天", "example": "86400000" }, { "name": "MaxMessageBytes", "type": "integer", "required": false, "description": "批次的消息大小，范围1 KB到12 MB", "example": "1024" }, { "name": "LogMsgTimestampType", "type": "string", "required": false, "description": "消息保存的时间类型：CreateTime/LogAppendTime", "example": "LogAppendTime" } ] } ], "required": [ "InstanceId", "Topic" ] }, { "name": "CancelAuthorizationToken", "description": "取消授权token", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "User", "type": "string", "required": true, "description": "用户", "example": "user-test" }, { "name": "Tokens", "type": "string", "required": true, "description": "token串", "example": "827636a7-3643-4afa-a23c-2eb7352e266c" } ], "required": [ "InstanceId", "User", "Tokens" ] }, { "name": "CheckCdcCluster", "description": "用于查询cdc-ckafka任务状态", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" } ], "required": [ "TaskId" ] }, { "name": "CreateAcl", "description": "添加 ACL 策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "ResourceType", "type": "integer", "required": true, "description": "Acl资源类型，(2:TOPIC，3:GROUP，4:CLUSTER)", "example": "2" }, { "name": "Operation", "type": "integer", "required": true, "description": "Acl操作方式，(2:ALL，3:READ，4:WRITE，5:CREATE，6:DELETE，7:ALTER，8:DESCRIBE，9:CLUSTER_ACTION，10:DESCRIBE_CONFIGS，11:ALTER_CONFIGS，12:IDEMPOTENT_WRITE)", "example": "2" }, { "name": "PermissionType", "type": "integer", "required": true, "description": "权限类型，(2:DENY，3:ALLOW)，当前ckafka支持ALLOW(相当于白名单)，其它用于后续兼容开源kafka的acl时使用", "example": "2" }, { "name": "ResourceName", "type": "string", "required": false, "description": "资源名称，和resourceType相关，如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称，当resourceType为CLUSTER时，该字段可为空。", "example": "Topic1" }, { "name": "Host", "type": "string", "required": false, "description": "默认为*，表示任何host都可以访问。支持填写IP或网段，支持“;”分隔。", "example": "1.1.1.1" }, { "name": "Principal", "type": "string", "required": false, "description": "用户列表，默认为User:*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户。传入时需要加 User: 前缀,如用户A则传入User:A。", "example": "User:user1" }, { "name": "ResourceNameList", "type": "string", "required": false, "description": "资源名称列表,Json字符串格式。ResourceName和resourceNameList只能指定其中一个。", "example": "[\"Topic1\",\"Topic2\"]" } ], "required": [ "InstanceId", "ResourceType", "Operation", "PermissionType" ] }, { "name": "CreateAclRule", "description": "添加 ACL 规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "ResourceType", "type": "string", "required": true, "description": "Acl资源类型,目前只支持Topic,枚举值列表：Topic", "example": "Topic" }, { "name": "PatternType", "type": "string", "required": true, "description": "ACL规则匹配类型，目前支持前缀匹配与预设策略，枚举值列表：PREFIXED/PRESET", "example": "PREFIXED" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "rulename-test" }, { "name": "RuleList", "type": "array", "required": true, "description": "设置的ACL规则列表", "example": "无", "item_type": "object", "children": [ { "name": "Operation", "type": "string", "required": true, "description": "Acl操作方式，枚举值(所有操作: All, 读：Read，写：Write)", "example": "Read" }, { "name": "PermissionType", "type": "string", "required": true, "description": "权限类型，Deny：拒绝，Allow：允许。", "example": "Allow" }, { "name": "Host", "type": "string", "required": true, "description": "表示任何host都可以访问", "example": "10.0.0.6" }, { "name": "Principal", "type": "string", "required": true, "description": "用户，User:*表示任何user都可以访问，当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A，传入为User:A。", "example": "User:*" } ] }, { "name": "Pattern", "type": "string", "required": false, "description": "表示前缀匹配的前缀的值 (当PatternType取值为PREFIXED时，此参数必填)", "example": "topic-*" }, { "name": "IsApplied", "type": "integer", "required": false, "description": "预设ACL规则是否应用到新增的topic中。默认为0，表示否。取值为1时表示是。", "example": "1" }, { "name": "Comment", "type": "string", "required": false, "description": "ACL规则的备注", "example": "acl备注" } ], "required": [ "InstanceId", "ResourceType", "PatternType", "RuleName", "RuleList" ] }, { "name": "CreateCdcCluster", "description": "用于cdc的专用ckafka集群", "status": "online", "parameters": [ { "name": "CdcId", "type": "string", "required": true, "description": "cdc的id", "example": "cluster-test" }, { "name": "CdcVpcId", "type": "string", "required": true, "description": "vpcId,一个地域只有唯一一个vpcid用于CDC", "example": "cluster-vpc-test" }, { "name": "CdcSubnetId", "type": "string", "required": true, "description": "每个CDC集群有唯一一个子网ID", "example": "cluster-subnet-test" }, { "name": "ZoneId", "type": "integer", "required": true, "description": "所在可用区ID", "example": "100003" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "实例带宽,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s", "example": "20" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "cdc集群的总磁盘", "example": "800" }, { "name": "DiskType", "type": "string", "required": true, "description": "ckafka集群实例磁盘类型", "example": "CLOUD_SSD" }, { "name": "SystemDiskType", "type": "string", "required": true, "description": "系统盘类型", "example": "CLOUD_PREMIUM" } ], "required": [ "CdcId", "CdcVpcId", "CdcSubnetId", "ZoneId", "Bandwidth", "DiskSize", "DiskType", "SystemDiskType" ] }, { "name": "CreateConnectResource", "description": "创建Datahub连接源", "status": "online", "parameters": [ { "name": "ResourceName", "type": "string", "required": true, "description": "连接源名称", "example": "resource-test" }, { "name": "Type", "type": "string", "required": true, "description": "连接源类型", "example": "KAFKA" }, { "name": "Description", "type": "string", "required": false, "description": "连接源描述", "example": "description-test" }, { "name": "DtsConnectParam", "type": "object", "required": false, "description": "Dts配置，Type为DTS时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"GroupId\":\"group-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"Topic\":\"topic-test\"}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "Dts的连接port", "example": "8080" }, { "name": "GroupId", "type": "string", "required": true, "description": "Dts消费分组的Id", "example": "group-test" }, { "name": "UserName", "type": "string", "required": true, "description": "Dts消费分组的账号", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "Dts消费分组的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "Dts实例Id", "example": "resource-test" }, { "name": "Topic", "type": "string", "required": true, "description": "Dts订阅的topic", "example": "topic-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "MongoDBConnectParam", "type": "object", "required": false, "description": "MongoDB配置，Type为MONGODB时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "MongoDB的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "MongoDB连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "MongoDB连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "MongoDB连接源的实例资源", "example": "resource-test" }, { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "MongoDB连接源是否为自建集群", "example": "false" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MongoDB连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MongoDB连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "EsConnectParam", "type": "object", "required": false, "description": "Es配置，Type为ES时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "Es的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "Es连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "Es连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "Es连接源的实例资源", "example": "resource-test" }, { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "Es连接源是否为自建集群", "example": "false" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "Es连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "Es连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "ClickHouseConnectParam", "type": "object", "required": false, "description": "ClickHouse配置，Type为CLICKHOUSE时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "ClickHouse的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "ClickHouse连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "ClickHouse连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "ClickHouse连接源的实例资源", "example": "resource-test" }, { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "ClickHouse连接源是否为自建集群", "example": "false" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "ClickHouse连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "ClickHouse连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "MySQLConnectParam", "type": "object", "required": false, "description": "MySQL配置，Type为MYSQL或TDSQL_C_MYSQL时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"ClusterId\":\"cynosdbmysql-test\",\"SelfBuilt\":false}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "MySQL的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "MySQL连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "MySQL连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "MySQL连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MySQL连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MySQL连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "ClusterId", "type": "string", "required": false, "description": "当type为TDSQL_C_MYSQL时，必填", "example": "cynosdbmysql-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "Mysql 连接源是否为自建集群", "example": "false" } ] }, { "name": "PostgreSQLConnectParam", "type": "object", "required": false, "description": "PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"ClusterId\":\"tdcpg-test\",\"IsUpdate\":true,\"SelfBuilt\":false}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "PostgreSQL的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "PostgreSQL连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "PostgreSQL连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "PostgreSQL连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "PostgreSQL连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "PostgreSQL连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "ClusterId", "type": "string", "required": false, "description": "当type为TDSQL_C_POSTGRESQL时，必填", "example": "tdcpg-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "PostgreSQL连接源是否为自建集群", "example": "false" } ] }, { "name": "MariaDBConnectParam", "type": "object", "required": false, "description": "MariaDB配置，Type为MARIADB时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "MariaDB的连接port", "example": "8080" }, { "name": "UserName", "type": "string", "required": true, "description": "MariaDB连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "MariaDB连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "MariaDB连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MariaDB连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MariaDB连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "SQLServerConnectParam", "type": "object", "required": false, "description": "SQLServer配置，Type为SQLSERVER时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":1433,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "SQLServer的连接port", "example": "1433" }, { "name": "UserName", "type": "string", "required": true, "description": "SQLServer连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "SQLServer连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "SQLServer连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "SQLServer连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "SQLServer连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务", "example": "true" } ] }, { "name": "DorisConnectParam", "type": "object", "required": false, "description": "Doris 配置，Type为 DORIS 时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":9030,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"SelfBuilt\":false,\"BePort\":8040}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "Doris jdbc 负载均衡连接 port，通常映射到 fe 的 9030 端口", "example": "9030" }, { "name": "UserName", "type": "string", "required": true, "description": "Doris 连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "Doris 连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "Doris 连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "Doris 连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "Doris 连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "Doris 连接源是否为自建集群", "example": "false" }, { "name": "BePort", "type": "integer", "required": false, "description": "Doris 的 http 负载均衡连接 port，通常映射到 be 的 8040 端口", "example": "8040" } ] }, { "name": "KafkaConnectParam", "type": "object", "required": false, "description": "Kafka配置，Type为 KAFKA 时必填", "example": "{\"Resource\":\"ckafka-test\",\"SelfBuilt\":true,\"IsUpdate\":true,\"BrokerAddress\":\"10.0.0.30:9092,10.0.0.31:9092\",\"Region\":\"ap-guangzhou\"}", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "Kafka连接源的实例资源, 非自建时必填，NetworkType=VPC时传clb实例id", "example": "ckafka-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "true" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "BrokerAddress", "type": "string", "required": false, "description": "Kafka连接的broker地址, NetworkType=PUBLIC公网时必填", "example": "10.0.0.30:9092,10.0.0.31:9092" }, { "name": "Region", "type": "string", "required": false, "description": "CKafka连接源的实例资源地域, 跨地域时必填", "example": "ap-guangzhou" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型：PUBLIC公网；VPC", "example": "PUBLIC" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpcId，NetworkType=VPC时必传", "example": "vpc-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "vip，NetworkType=VPC时必传", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "端口，NetworkType=VPC时必传", "example": "9092" }, { "name": "CrossNetResourceUniqueId", "type": "string", "required": false, "description": "跨云同步下需要客户传递唯一Id标志一组资源", "example": "id-test" }, { "name": "CrossNetVpcSubNetId", "type": "string", "required": false, "description": "跨云子网ID", "example": "subnet-test" } ] }, { "name": "MqttConnectParam", "type": "object", "required": false, "description": "MQTT配置，Type为 MQTT 时必填", "example": "{\"UserName\":\"username-test\",\"Password\":\"password-test\",\"Resource\":\"resource-test\",\"UniqVpcId\":\"vpc-test\",\"SelfBuilt\":true,\"IsUpdate\":true,\"Region\":\"ap-guangzhou\"}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "MQTT的连接port", "example": "9092" }, { "name": "UserName", "type": "string", "required": true, "description": "MQTT连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "MQTT连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "MQTT连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": true, "description": "MQTT的连接ip", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "MQTT Instance vpc-id", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "true" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "Region", "type": "string", "required": false, "description": "MQTT连接源的实例资源地域, 跨地域时必填", "example": "ap-guangzhou" }, { "name": "Ip", "type": "string", "required": false, "description": "IP", "example": "10.0.0.30" } ] } ], "required": [ "ResourceName", "Type" ] }, { "name": "CreateConsumer", "description": "创建消费者组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "GroupName", "type": "string", "required": true, "description": "消费分组名称", "example": "group-test" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名，TopicName、TopicNameList 需要显示指定一个存在的主题名", "example": "topic-test" }, { "name": "TopicNameList", "type": "array", "required": false, "description": "主题名列表", "example": "[\"topic-test\"]", "item_type": "string" } ], "required": [ "InstanceId", "GroupName" ] }, { "name": "CreateDatahubTask", "description": "创建DIP转储任务", "status": "online", "parameters": [ { "name": "TaskName", "type": "string", "required": true, "description": "任务名称,只能以字母起始,允许包含字母、数字、- 、. 、 下划线且长度不超过64 (、为分割符号规则不包含)", "example": "task-test" }, { "name": "TaskType", "type": "string", "required": true, "description": "任务类型，SOURCE数据接入，SINK数据流出", "example": "SINK" }, { "name": "SourceResource", "type": "object", "required": false, "description": "数据源", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "资源类型 type类型如下: KAFKA, EB_ES, EB_COS, EB_CLS, EB_, MONGODB, HTTP, TDW, ES, CLICKHOUSE, DTS, CLS, COS, TOPIC, MYSQL, MQTT, MYSQL_DATA, DORIS, POSTGRESQL, TDSQL_C_POSTGRESQL, TDSQL_POSTGRESQL, WAREHOUSE_POSTGRESQL, TDSQL_C_MYSQL, MARIADB, SQLSERVER, CTSDB, SCF", "example": "EB_" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "ckafka配置，Type为KAFKA时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": false, "description": "主题名，多个以“,”分隔", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "ResourceName", "type": "string", "required": false, "description": "实例资源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ckafka测试" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "100003" }, { "name": "TopicId", "type": "string", "required": false, "description": "主题Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "Topic的分区数 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EnableToleration", "type": "boolean", "required": false, "description": "启用容错实例/开启死信队列 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "QpsLimit", "type": "integer", "required": false, "description": "Qps 限制", "example": "4000" }, { "name": "TableMappings", "type": "array", "required": false, "description": "Table到Topic的路由，「分发到多个topic」开关打开时必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Database\":\"db1\",\"Table\":\"table1\",\"Topic\":\"topic1\",\"TopicId\":\"topic-id\"}]", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "库名", "example": "db1" }, { "name": "Table", "type": "string", "required": true, "description": "表名，多个表,（逗号）隔开", "example": "table1" }, { "name": "Topic", "type": "string", "required": true, "description": "Topic名称", "example": "topic1" }, { "name": "TopicId", "type": "string", "required": true, "description": "Topic ID", "example": "topic-id" } ] }, { "name": "UseTableMapping", "type": "boolean", "required": false, "description": "「分发到多个topic」开关，默认为false", "example": "false" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）", "example": "false" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，填写\"open\"。", "example": "none" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" }, { "name": "ConnectorSyncType", "type": "string", "required": false, "description": "数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写\"META_SYNC_INSTANCE_TYPE\", 同步元数据及全部topic内消息的填写\"META_AND_DATA_SYNC_INSTANCE_TYPE\"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写\"DATA_SYNC_TYPE\"", "example": "DATA_SYNC_TYPE" }, { "name": "KeepPartition", "type": "boolean", "required": false, "description": "数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false", "example": "false" }, { "name": "TopicRegularExpression", "type": "string", "required": false, "description": "正则匹配Topic列表", "example": "mytest" }, { "name": "Prefix", "type": "string", "required": false, "description": "Topic 前缀" }, { "name": "Separator", "type": "string", "required": false, "description": "Topic前缀分隔符" } ] }, { "name": "EventBusParam", "type": "object", "required": false, "description": "EB配置，Type为EB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "资源类型。COS/ES/CLS", "example": "COS" }, { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "SCF云函数命名空间", "example": "namespace-test" }, { "name": "FunctionName", "type": "string", "required": false, "description": "SCF云函数函数名", "example": "function-test" }, { "name": "Qualifier", "type": "string", "required": false, "description": "SCF云函数版本及别名", "example": "qualifier-test" } ] }, { "name": "MongoDBParam", "type": "object", "required": false, "description": "MongoDB配置，Type为MONGODB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MongoDB的数据库名称", "example": "database-test" }, { "name": "Collection", "type": "string", "required": true, "description": "MongoDB的集群", "example": "collection-test" }, { "name": "CopyExisting", "type": "boolean", "required": true, "description": "是否复制存量数据，默认传参true", "example": "true" }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "MongoDB的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "MongoDB的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "MongoDB数据库用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MongoDB数据库密码", "example": "password-test" }, { "name": "ListeningEvent", "type": "string", "required": false, "description": "监听事件类型，为空时表示全选。取值包括insert,update,replace,delete,invalidate,drop,dropdatabase,rename，多个类型间使用,逗号分隔", "example": "insert,update" }, { "name": "ReadPreference", "type": "string", "required": false, "description": "主从优先级，默认主节点", "example": "主节点" }, { "name": "Pipeline", "type": "string", "required": false, "description": "聚合管道", "example": "pipeline-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" } ] }, { "name": "EsParam", "type": "object", "required": false, "description": "Es配置，Type为ES时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Es实例资源Id", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "Es的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "Es用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Es密码", "example": "password-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "实例vip", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "实例的vpcId", "example": "vpc-test" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "Es是否抛弃解析失败的消息", "example": "true" }, { "name": "Index", "type": "string", "required": false, "description": "Es自定义index名称", "example": "index-test" }, { "name": "DateFormat", "type": "string", "required": false, "description": "Es自定义日期后缀", "example": "yyyy-MM-dd" }, { "name": "ContentKey", "type": "string", "required": false, "description": "非json格式数据的自定义key", "example": "key-test" }, { "name": "DropInvalidJsonMessage", "type": "boolean", "required": false, "description": "Es是否抛弃非json格式的消息", "example": "true" }, { "name": "DocumentIdField", "type": "string", "required": false, "description": "转储到Es中的文档ID取值字段名", "example": "$.payload.name" }, { "name": "IndexType", "type": "string", "required": false, "description": "Es自定义index名称的类型，STRING，JSONPATH，默认为STRING", "example": "JSONPATH" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "{\"DropInvalidMessageToCls\":true,\"DropClsRegion\":\"ap-guangzhou\",\"DropClsOwneruin\":\"10003080064\",\"DropClsTopicId\":\"eafds-vfdfsdf-dbdfsdf\",\"DropClsLogSet\":\"wqead-bfdebv-sfds\"}", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "DatabasePrimaryKey", "type": "string", "required": false, "description": "转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键", "example": "pk_test" }, { "name": "DropDlq", "type": "object", "required": false, "description": "死信队列", "example": "{\"Type\":\"DLQ\",\"KafkaParam\":{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"},\"RetryInterval\":1,\"MaxRetryAttempts\":2,\"TopicParam\":{\"Resource\":\"appId-test\"},\"DlqType\":\"TOPIC\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，DLQ死信队列，IGNORE_ERROR保留，DROP丢弃", "example": "DLQ" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "Ckafka类型死信队列", "example": "{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"}" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔", "example": "1" }, { "name": "MaxRetryAttempts", "type": "integer", "required": false, "description": "重试次数", "example": "2" }, { "name": "TopicParam", "type": "object", "required": false, "description": "DIP Topic类型死信队列", "example": "{\"Resource\":\"appId-test\"}" }, { "name": "DlqType", "type": "string", "required": false, "description": "死信队列类型，CKAFKA，TOPIC", "example": "TOPIC" } ] }, { "name": "RecordMappingList", "type": "array", "required": false, "description": "使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配", "example": "[{\"ColumnName\":\"column-test\",\"JsonKey\":\"key-test\"}]", "item_type": "object", "children": [ { "name": "ColumnName", "type": "string", "required": false, "description": "es 索引成员名称", "example": "column-test" }, { "name": "JsonKey", "type": "string", "required": false, "description": "消息字段名称", "example": "key-test" } ] }, { "name": "DateField", "type": "string", "required": false, "description": "消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射", "example": "create_timestamp" }, { "name": "RecordMappingMode", "type": "string", "required": false, "description": "用来区分当前索引映射，属于新建索引还是存量索引。\"EXIST_MAPPING\"：从存量索引中选择；\"NEW_MAPPING\"：新建索引", "example": "EXIST_MAPPING" } ] }, { "name": "TdwParam", "type": "object", "required": false, "description": "Tdw配置，Type为TDW时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bid", "type": "string", "required": true, "description": "Tdw的bid", "example": "bid-test" }, { "name": "Tid", "type": "string", "required": true, "description": "Tdw的tid", "example": "tid-test" }, { "name": "IsDomestic", "type": "boolean", "required": false, "description": "默认true", "example": "true" }, { "name": "TdwHost", "type": "string", "required": false, "description": "TDW地址，默认tl-tdbank-tdmanager.tencent-distribute.com", "example": "tl-tdbank-tdmanager.tencent-distribute.com" }, { "name": "TdwPort", "type": "integer", "required": false, "description": "TDW端口，默认8099", "example": "8099" } ] }, { "name": "DtsParam", "type": "object", "required": false, "description": "Dts配置，Type为DTS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Dts实例Id", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "Dts的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "Dts的连接port", "example": "8099" }, { "name": "Topic", "type": "string", "required": false, "description": "Dts订阅的topic", "example": "topic-test" }, { "name": "GroupId", "type": "string", "required": false, "description": "Dts消费分组的Id", "example": "group-test" }, { "name": "GroupUser", "type": "string", "required": false, "description": "Dts消费分组的账号", "example": "username-test" }, { "name": "GroupPassword", "type": "string", "required": false, "description": "Dts消费分组的密码", "example": "password-test" }, { "name": "TranSql", "type": "boolean", "required": false, "description": "false同步原始数据，true同步解析后的json格式数据,默认true", "example": "true" } ] }, { "name": "ClickHouseParam", "type": "object", "required": false, "description": "ClickHouse配置，Type为CLICKHOUSE时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Cluster", "type": "string", "required": true, "description": "ClickHouse的集群", "example": "cluster-test" }, { "name": "Database", "type": "string", "required": true, "description": "ClickHouse的数据库名", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "ClickHouse的数据表名", "example": "table-test" }, { "name": "Schema", "type": "array", "required": true, "description": "ClickHouse的schema", "example": "[{\"ColumnName\":\"column_test\",\"JsonKey\":\"column_test\",\"Type\":\"String\",\"AllowNull\":false}]", "item_type": "object", "children": [ { "name": "ColumnName", "type": "string", "required": true, "description": "表的列名", "example": "column_test" }, { "name": "JsonKey", "type": "string", "required": true, "description": "该列对应的jsonKey名", "example": "column_test" }, { "name": "Type", "type": "string", "required": true, "description": "表列项的类型", "example": "String" }, { "name": "AllowNull", "type": "boolean", "required": true, "description": "列项是否允许为空", "example": "false" } ] }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "ClickHouse的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "ClickHouse的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "ClickHouse的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "ClickHouse的密码", "example": "password-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "实例vip", "example": "10.0.0.5" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "实例的vpcId", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "ClickHouse是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "Type", "type": "string", "required": false, "description": "ClickHouse 类型，emr-clickhouse : \"emr\";cdw-clickhouse : \"cdwch\";自建 : \"\"", "example": "emr" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "{\"DropInvalidMessageToCls\":true,\"DropClsRegion\":\"ap-guangzhou\",\"DropClsOwneruin\":\"10003080064\",\"DropClsTopicId\":\"eafds-vfdfsdf-dbdfsdf\",\"DropClsLogSet\":\"wqead-bfdebv-sfds\"}", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "BatchSize", "type": "integer", "required": false, "description": "每批次投递到 ClickHouse 表消息数量，默认为 1000 条。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "1000" }, { "name": "ConsumerFetchMinBytes", "type": "integer", "required": false, "description": "每次从 topic 中拉取消息大小，默认为 1MB，即至少要从 topic 中批量拉取 1MB 消息，才进行数据投递到 ClickHouse 操作。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "1000000" }, { "name": "ConsumerFetchMaxWaitMs", "type": "integer", "required": false, "description": "每次从 topic 拉取消息最大等待时间，当超过当前最大等待时间时，即使没有拉取到 ConsumerFetchMinBytes 大小，也将进行 ClickHouse 投递操作。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "30000" } ] }, { "name": "ClsParam", "type": "object", "required": false, "description": "Cls配置，Type为CLS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "DecodeJson", "type": "boolean", "required": true, "description": "生产的信息是否为json格式", "example": "true" }, { "name": "Resource", "type": "string", "required": true, "description": "cls日志主题id", "example": "resource-test" }, { "name": "LogSet", "type": "string", "required": false, "description": "cls日志集id", "example": "logset-test" }, { "name": "ContentKey", "type": "string", "required": false, "description": "当DecodeJson为false时必填", "example": "key-test" }, { "name": "TimeField", "type": "string", "required": false, "description": "指定消息中的某字段内容作为cls日志的时间。 字段内容格式需要是秒级时间戳", "example": "time" } ] }, { "name": "CosParam", "type": "object", "required": false, "description": "Cos配置，Type为COS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BucketName", "type": "string", "required": true, "description": "cos 存储桶名称", "example": "bucket-name-test" }, { "name": "Region", "type": "string", "required": true, "description": "地域代码", "example": "ap-guangzhou" }, { "name": "ObjectKey", "type": "string", "required": false, "description": "对象名称", "example": "key-test" }, { "name": "AggregateBatchSize", "type": "integer", "required": false, "description": "汇聚消息量的大小（单位：MB)", "example": "100" }, { "name": "AggregateInterval", "type": "integer", "required": false, "description": "汇聚的时间间隔（单位：小时）", "example": "1" }, { "name": "FormatOutputType", "type": "string", "required": false, "description": "消息汇聚后的文件格式（支持csv, json）", "example": "json" }, { "name": "ObjectKeyPrefix", "type": "string", "required": false, "description": "转储的对象目录前缀", "example": "prefix-test" }, { "name": "DirectoryTimeFormat", "type": "string", "required": false, "description": "根据strptime 时间格式化的分区格式", "example": "/%Y/%m/%d/%H" } ] }, { "name": "MySQLParam", "type": "object", "required": false, "description": "MySQL配置，Type为MYSQL时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MySQL的数据库名称，\"*\"为全数据库", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "MySQL的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写，需要填入正则表达式时，格式为\"数据库名\\\\.数据表名\"", "example": "table-test" }, { "name": "Resource", "type": "string", "required": true, "description": "该MySQL在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only不复制, initial全量)，默认值initial", "example": "initial" }, { "name": "DdlTopic", "type": "string", "required": false, "description": "存放MySQL的Ddl信息的Topic，为空则默认不存放", "example": "topic-test" }, { "name": "DataSourceMonitorMode", "type": "string", "required": false, "description": "\"TABLE\" 表示读取项为 table，\"QUERY\" 表示读取项为 query", "example": "TABLE" }, { "name": "DataSourceMonitorResource", "type": "string", "required": false, "description": "当 \"DataMonitorMode\"=\"TABLE\" 时，传入需要读取的 Table；当 \"DataMonitorMode\"=\"QUERY\" 时，传入需要读取的查询 sql 语句", "example": "table-test" }, { "name": "DataSourceIncrementMode", "type": "string", "required": false, "description": "\"TIMESTAMP\" 表示增量列为时间戳类型，\"INCREMENT\" 表示增量列为自增 id 类型", "example": "TIMESTAMP" }, { "name": "DataSourceIncrementColumn", "type": "string", "required": false, "description": "传入需要监听的列名称", "example": "column_test" }, { "name": "DataSourceStartFrom", "type": "string", "required": false, "description": "\"HEAD\" 表示复制存量 + 增量数据，\"TAIL\" 表示只复制增量数据", "example": "HEAD" }, { "name": "DataTargetInsertMode", "type": "string", "required": false, "description": "\"INSERT\" 表示使用 Insert 模式插入，\"UPSERT\" 表示使用 Upsert 模式插入", "example": "INSERT" }, { "name": "DataTargetPrimaryKeyField", "type": "string", "required": false, "description": "当 \"DataInsertMode\"=\"UPSERT\" 时，传入当前 upsert 时依赖的主键", "example": "id" }, { "name": "DataTargetRecordMapping", "type": "array", "required": false, "description": "表与消息间的映射关系", "example": "无", "item_type": "object", "children": [ { "name": "JsonKey", "type": "string", "required": false, "description": "消息的 key 名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test-key" }, { "name": "Type", "type": "string", "required": false, "description": "消息类型", "example": "Integer" }, { "name": "AllowNull", "type": "boolean", "required": false, "description": "消息是否允许为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ColumnName", "type": "string", "required": false, "description": "对应映射列名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "column_test" }, { "name": "ExtraInfo", "type": "string", "required": false, "description": "数据库表额外字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "AUTO_INCREMENT COMMENT 'ID'" }, { "name": "ColumnSize", "type": "string", "required": false, "description": "当前列大小 注意：此字段可能返回 null，表示取不到有效值。", "example": "32" }, { "name": "DecimalDigits", "type": "string", "required": false, "description": "当前列精度 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "AutoIncrement", "type": "boolean", "required": false, "description": "是否为自增列 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "数据库表默认参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "TopicRegex", "type": "string", "required": false, "description": "事件路由到特定主题的正则表达式，默认为(.*)", "example": "(.*).db.(.*)" }, { "name": "TopicReplacement", "type": "string", "required": false, "description": "TopicRegex的引用组，指定$1、$2等", "example": "$1" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "Mysql 是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "无", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式，DEFAULT、CANAL_1、CANAL_2", "example": "DEFAULT" }, { "name": "IsTablePrefix", "type": "boolean", "required": false, "description": "当Table输入的是前缀时，该项值为true，否则为false", "example": "false" }, { "name": "IncludeContentChanges", "type": "string", "required": false, "description": "如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic", "example": "all" }, { "name": "IncludeQuery", "type": "boolean", "required": false, "description": "如果该值为true，且MySQL中\"binlog_rows_query_log_events\"配置项的值为\"ON\"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句", "example": "false" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" }, { "name": "SignalDatabase", "type": "string", "required": false, "description": "存放信令表的数据库名称", "example": "database-test" }, { "name": "IsTableRegular", "type": "boolean", "required": false, "description": "输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix", "example": "false" }, { "name": "SignalTable", "type": "string", "required": false, "description": "信号表 注意：此字段可能返回 null，表示取不到有效值。", "example": "table-test" }, { "name": "DateTimeZone", "type": "string", "required": false, "description": "datetime 类型字段转换为时间戳的时区", "example": "UTC+8" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" } ] }, { "name": "PostgreSQLParam", "type": "object", "required": false, "description": "PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "PostgreSQL的数据库名称", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "PostgreSQL的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"Schema名.数据表名\"的格式进行填写，需要填入正则表达式时，格式为\"Schema名\\\\.数据表名\"", "example": "SchemaName.Tabletest" }, { "name": "Resource", "type": "string", "required": true, "description": "该PostgreSQL在连接管理内的Id", "example": "resource-test" }, { "name": "PluginName", "type": "string", "required": true, "description": "插件名(decoderbufs/pgoutput)，默认为decoderbufs", "example": "decoderbufs" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(never增量, initial全量)，默认为initial", "example": "initial" }, { "name": "DataFormat", "type": "string", "required": false, "description": "上游数据格式(JSON/Debezium), 当数据库同步模式为默认字段匹配时,必填", "example": "JSON" }, { "name": "DataTargetInsertMode", "type": "string", "required": false, "description": "\"INSERT\" 表示使用 Insert 模式插入，\"UPSERT\" 表示使用 Upsert 模式插入", "example": "INSERT" }, { "name": "DataTargetPrimaryKeyField", "type": "string", "required": false, "description": "当 \"DataInsertMode\"=\"UPSERT\" 时，传入当前 upsert 时依赖的主键", "example": "id" }, { "name": "DataTargetRecordMapping", "type": "array", "required": false, "description": "表与消息间的映射关系", "example": "[{\"JsonKey\":\"test-key\",\"Type\":\"Integer\",\"AllowNull\":false,\"ColumnName\":\"column_test\",\"ExtraInfo\":\"AUTO_INCREMENT COMMENT 'ID'\",\"ColumnSize\":\"32\",\"DecimalDigits\":\"10\",\"AutoIncrement\":true,\"DefaultValue\":\"0\"}]", "item_type": "object", "children": [ { "name": "JsonKey", "type": "string", "required": false, "description": "消息的 key 名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test-key" }, { "name": "Type", "type": "string", "required": false, "description": "消息类型", "example": "Integer" }, { "name": "AllowNull", "type": "boolean", "required": false, "description": "消息是否允许为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ColumnName", "type": "string", "required": false, "description": "对应映射列名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "column_test" }, { "name": "ExtraInfo", "type": "string", "required": false, "description": "数据库表额外字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "AUTO_INCREMENT COMMENT 'ID'" }, { "name": "ColumnSize", "type": "string", "required": false, "description": "当前列大小 注意：此字段可能返回 null，表示取不到有效值。", "example": "32" }, { "name": "DecimalDigits", "type": "string", "required": false, "description": "当前列精度 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "AutoIncrement", "type": "boolean", "required": false, "description": "是否为自增列 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "数据库表默认参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "IsTableRegular", "type": "boolean", "required": false, "description": "输入的table是否为正则表达式", "example": "false" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" } ] }, { "name": "TopicParam", "type": "object", "required": false, "description": "Topic配置，Type为Topic时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "单独售卖Topic的Topic名称", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "TopicId", "type": "string", "required": false, "description": "Topic的TopicId【出参】", "example": "topic-test" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，可选择\"gzip\", \"snappy\", \"lz4\"中的一个进行填写。", "example": "none" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）", "example": "false" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" } ] }, { "name": "MariaDBParam", "type": "object", "required": false, "description": "MariaDB配置，Type为MARIADB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MariaDB的数据库名称，\"*\"为全数据库", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "MariaDB的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写", "example": "table-test" }, { "name": "Resource", "type": "string", "required": true, "description": "该MariaDB在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only不复制, initial全量)，默认值initial", "example": "initial" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "IsTablePrefix", "type": "boolean", "required": false, "description": "当Table输入的是前缀时，该项值为true，否则为false", "example": "false" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式，DEFAULT、CANAL_1、CANAL_2", "example": "DEFAULT" }, { "name": "IncludeContentChanges", "type": "string", "required": false, "description": "如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic", "example": "all" }, { "name": "IncludeQuery", "type": "boolean", "required": false, "description": "如果该值为true，且MySQL中\"binlog_rows_query_log_events\"配置项的值为\"ON\"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句", "example": "false" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" } ] }, { "name": "SQLServerParam", "type": "object", "required": false, "description": "SQLServer配置，Type为SQLSERVER时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "SQLServer的数据库名称", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "SQLServer的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写", "example": " DatabaseName.Tabletest" }, { "name": "Resource", "type": "string", "required": true, "description": "该SQLServer在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only增量, initial全量)，默认为initial", "example": "initial" } ] }, { "name": "CtsdbParam", "type": "object", "required": false, "description": "Ctsdb配置，Type为CTSDB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "连接管理实例资源", "example": "resource-test" }, { "name": "CtsdbMetric", "type": "string", "required": false, "description": "Ctsdb的metric", "example": "metric-test" } ] }, { "name": "ScfParam", "type": "object", "required": false, "description": "Scf配置，Type为SCF时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FunctionName", "type": "string", "required": true, "description": "SCF云函数函数名", "example": "function-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "SCF云函数命名空间, 默认为default", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "SCF云函数版本及别名, 默认为$DEFAULT", "example": "$DEFAULT" }, { "name": "BatchSize", "type": "integer", "required": false, "description": "每批最大发送消息数, 默认为1000", "example": "1000" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "SCF调用失败后重试次数, 默认为5", "example": "5" } ] }, { "name": "MqttParam", "type": "object", "required": false, "description": "MQTT配置，Type为 MQTT 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Topics", "type": "string", "required": true, "description": "需要同步的MQTT Topic列表, CSV格式", "example": "topic-test" }, { "name": "CleanSession", "type": "boolean", "required": true, "description": "用于控制会话的持久性。cleanSession 为true时，连接时会创建一个全新的会话。 cleanSession = false时，连接时会恢复之前的会话。", "example": "true" }, { "name": "Resource", "type": "string", "required": false, "description": "MQTT instance-id", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "MQTT实例VIP", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "MQTT VIP 端口", "example": "1883" }, { "name": "UserName", "type": "string", "required": false, "description": "MQTT实例用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MQTT实例内账户密码", "example": "password-test" }, { "name": "Qos", "type": "integer", "required": false, "description": "QoS", "example": "1" }, { "name": "MaxTasks", "type": "integer", "required": false, "description": "tasks.max 订阅Topic的并发Task个数, 默认为1; 当设置大于1时, 使用Shared Subscription", "example": "1" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MQTT 实例的Service VIP", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MQTT实例的VPC ID", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群, MQTT只支持非自建集群", "example": "false" } ] } ] }, { "name": "TargetResource", "type": "object", "required": false, "description": "数据目标", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "资源类型 type类型如下: KAFKA, EB_ES, EB_COS, EB_CLS, EB_, MONGODB, HTTP, TDW, ES, CLICKHOUSE, DTS, CLS, COS, TOPIC, MYSQL, MQTT, MYSQL_DATA, DORIS, POSTGRESQL, TDSQL_C_POSTGRESQL, TDSQL_POSTGRESQL, WAREHOUSE_POSTGRESQL, TDSQL_C_MYSQL, MARIADB, SQLSERVER, CTSDB, SCF", "example": "EB_" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "ckafka配置，Type为KAFKA时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": false, "description": "主题名，多个以“,”分隔", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "ResourceName", "type": "string", "required": false, "description": "实例资源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ckafka测试" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "100003" }, { "name": "TopicId", "type": "string", "required": false, "description": "主题Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "Topic的分区数 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EnableToleration", "type": "boolean", "required": false, "description": "启用容错实例/开启死信队列 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "QpsLimit", "type": "integer", "required": false, "description": "Qps 限制", "example": "4000" }, { "name": "TableMappings", "type": "array", "required": false, "description": "Table到Topic的路由，「分发到多个topic」开关打开时必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Database\":\"db1\",\"Table\":\"table1\",\"Topic\":\"topic1\",\"TopicId\":\"topic-id\"}]", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "库名", "example": "db1" }, { "name": "Table", "type": "string", "required": true, "description": "表名，多个表,（逗号）隔开", "example": "table1" }, { "name": "Topic", "type": "string", "required": true, "description": "Topic名称", "example": "topic1" }, { "name": "TopicId", "type": "string", "required": true, "description": "Topic ID", "example": "topic-id" } ] }, { "name": "UseTableMapping", "type": "boolean", "required": false, "description": "「分发到多个topic」开关，默认为false", "example": "false" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）", "example": "false" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，填写\"open\"。", "example": "none" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" }, { "name": "ConnectorSyncType", "type": "string", "required": false, "description": "数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写\"META_SYNC_INSTANCE_TYPE\", 同步元数据及全部topic内消息的填写\"META_AND_DATA_SYNC_INSTANCE_TYPE\"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写\"DATA_SYNC_TYPE\"", "example": "DATA_SYNC_TYPE" }, { "name": "KeepPartition", "type": "boolean", "required": false, "description": "数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false", "example": "false" }, { "name": "TopicRegularExpression", "type": "string", "required": false, "description": "正则匹配Topic列表", "example": "mytest" }, { "name": "Prefix", "type": "string", "required": false, "description": "Topic 前缀" }, { "name": "Separator", "type": "string", "required": false, "description": "Topic前缀分隔符" } ] }, { "name": "EventBusParam", "type": "object", "required": false, "description": "EB配置，Type为EB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "资源类型。COS/ES/CLS", "example": "COS" }, { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "SCF云函数命名空间", "example": "namespace-test" }, { "name": "FunctionName", "type": "string", "required": false, "description": "SCF云函数函数名", "example": "function-test" }, { "name": "Qualifier", "type": "string", "required": false, "description": "SCF云函数版本及别名", "example": "qualifier-test" } ] }, { "name": "MongoDBParam", "type": "object", "required": false, "description": "MongoDB配置，Type为MONGODB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MongoDB的数据库名称", "example": "database-test" }, { "name": "Collection", "type": "string", "required": true, "description": "MongoDB的集群", "example": "collection-test" }, { "name": "CopyExisting", "type": "boolean", "required": true, "description": "是否复制存量数据，默认传参true", "example": "true" }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "MongoDB的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "MongoDB的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "MongoDB数据库用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MongoDB数据库密码", "example": "password-test" }, { "name": "ListeningEvent", "type": "string", "required": false, "description": "监听事件类型，为空时表示全选。取值包括insert,update,replace,delete,invalidate,drop,dropdatabase,rename，多个类型间使用,逗号分隔", "example": "insert,update" }, { "name": "ReadPreference", "type": "string", "required": false, "description": "主从优先级，默认主节点", "example": "主节点" }, { "name": "Pipeline", "type": "string", "required": false, "description": "聚合管道", "example": "pipeline-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" } ] }, { "name": "EsParam", "type": "object", "required": false, "description": "Es配置，Type为ES时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Es实例资源Id", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "Es的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "Es用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Es密码", "example": "password-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "实例vip", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "实例的vpcId", "example": "vpc-test" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "Es是否抛弃解析失败的消息", "example": "true" }, { "name": "Index", "type": "string", "required": false, "description": "Es自定义index名称", "example": "index-test" }, { "name": "DateFormat", "type": "string", "required": false, "description": "Es自定义日期后缀", "example": "yyyy-MM-dd" }, { "name": "ContentKey", "type": "string", "required": false, "description": "非json格式数据的自定义key", "example": "key-test" }, { "name": "DropInvalidJsonMessage", "type": "boolean", "required": false, "description": "Es是否抛弃非json格式的消息", "example": "true" }, { "name": "DocumentIdField", "type": "string", "required": false, "description": "转储到Es中的文档ID取值字段名", "example": "$.payload.name" }, { "name": "IndexType", "type": "string", "required": false, "description": "Es自定义index名称的类型，STRING，JSONPATH，默认为STRING", "example": "JSONPATH" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "{\"DropInvalidMessageToCls\":true,\"DropClsRegion\":\"ap-guangzhou\",\"DropClsOwneruin\":\"10003080064\",\"DropClsTopicId\":\"eafds-vfdfsdf-dbdfsdf\",\"DropClsLogSet\":\"wqead-bfdebv-sfds\"}", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "DatabasePrimaryKey", "type": "string", "required": false, "description": "转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键", "example": "pk_test" }, { "name": "DropDlq", "type": "object", "required": false, "description": "死信队列", "example": "{\"Type\":\"DLQ\",\"KafkaParam\":{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"},\"RetryInterval\":1,\"MaxRetryAttempts\":2,\"TopicParam\":{\"Resource\":\"appId-test\"},\"DlqType\":\"TOPIC\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，DLQ死信队列，IGNORE_ERROR保留，DROP丢弃", "example": "DLQ" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "Ckafka类型死信队列", "example": "{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"}" }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔", "example": "1" }, { "name": "MaxRetryAttempts", "type": "integer", "required": false, "description": "重试次数", "example": "2" }, { "name": "TopicParam", "type": "object", "required": false, "description": "DIP Topic类型死信队列", "example": "{\"Resource\":\"appId-test\"}" }, { "name": "DlqType", "type": "string", "required": false, "description": "死信队列类型，CKAFKA，TOPIC", "example": "TOPIC" } ] }, { "name": "RecordMappingList", "type": "array", "required": false, "description": "使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配", "example": "[{\"ColumnName\":\"column-test\",\"JsonKey\":\"key-test\"}]", "item_type": "object", "children": [ { "name": "ColumnName", "type": "string", "required": false, "description": "es 索引成员名称", "example": "column-test" }, { "name": "JsonKey", "type": "string", "required": false, "description": "消息字段名称", "example": "key-test" } ] }, { "name": "DateField", "type": "string", "required": false, "description": "消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射", "example": "create_timestamp" }, { "name": "RecordMappingMode", "type": "string", "required": false, "description": "用来区分当前索引映射，属于新建索引还是存量索引。\"EXIST_MAPPING\"：从存量索引中选择；\"NEW_MAPPING\"：新建索引", "example": "EXIST_MAPPING" } ] }, { "name": "TdwParam", "type": "object", "required": false, "description": "Tdw配置，Type为TDW时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bid", "type": "string", "required": true, "description": "Tdw的bid", "example": "bid-test" }, { "name": "Tid", "type": "string", "required": true, "description": "Tdw的tid", "example": "tid-test" }, { "name": "IsDomestic", "type": "boolean", "required": false, "description": "默认true", "example": "true" }, { "name": "TdwHost", "type": "string", "required": false, "description": "TDW地址，默认tl-tdbank-tdmanager.tencent-distribute.com", "example": "tl-tdbank-tdmanager.tencent-distribute.com" }, { "name": "TdwPort", "type": "integer", "required": false, "description": "TDW端口，默认8099", "example": "8099" } ] }, { "name": "DtsParam", "type": "object", "required": false, "description": "Dts配置，Type为DTS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Dts实例Id", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "Dts的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "Dts的连接port", "example": "8099" }, { "name": "Topic", "type": "string", "required": false, "description": "Dts订阅的topic", "example": "topic-test" }, { "name": "GroupId", "type": "string", "required": false, "description": "Dts消费分组的Id", "example": "group-test" }, { "name": "GroupUser", "type": "string", "required": false, "description": "Dts消费分组的账号", "example": "username-test" }, { "name": "GroupPassword", "type": "string", "required": false, "description": "Dts消费分组的密码", "example": "password-test" }, { "name": "TranSql", "type": "boolean", "required": false, "description": "false同步原始数据，true同步解析后的json格式数据,默认true", "example": "true" } ] }, { "name": "ClickHouseParam", "type": "object", "required": false, "description": "ClickHouse配置，Type为CLICKHOUSE时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Cluster", "type": "string", "required": true, "description": "ClickHouse的集群", "example": "cluster-test" }, { "name": "Database", "type": "string", "required": true, "description": "ClickHouse的数据库名", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "ClickHouse的数据表名", "example": "table-test" }, { "name": "Schema", "type": "array", "required": true, "description": "ClickHouse的schema", "example": "[{\"ColumnName\":\"column_test\",\"JsonKey\":\"column_test\",\"Type\":\"String\",\"AllowNull\":false}]", "item_type": "object", "children": [ { "name": "ColumnName", "type": "string", "required": true, "description": "表的列名", "example": "column_test" }, { "name": "JsonKey", "type": "string", "required": true, "description": "该列对应的jsonKey名", "example": "column_test" }, { "name": "Type", "type": "string", "required": true, "description": "表列项的类型", "example": "String" }, { "name": "AllowNull", "type": "boolean", "required": true, "description": "列项是否允许为空", "example": "false" } ] }, { "name": "Resource", "type": "string", "required": true, "description": "实例资源", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "ClickHouse的连接ip", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "ClickHouse的连接port", "example": "8099" }, { "name": "UserName", "type": "string", "required": false, "description": "ClickHouse的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "ClickHouse的密码", "example": "password-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "实例vip", "example": "10.0.0.5" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "实例的vpcId", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "ClickHouse是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "Type", "type": "string", "required": false, "description": "ClickHouse 类型，emr-clickhouse : \"emr\";cdw-clickhouse : \"cdwch\";自建 : \"\"", "example": "emr" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "{\"DropInvalidMessageToCls\":true,\"DropClsRegion\":\"ap-guangzhou\",\"DropClsOwneruin\":\"10003080064\",\"DropClsTopicId\":\"eafds-vfdfsdf-dbdfsdf\",\"DropClsLogSet\":\"wqead-bfdebv-sfds\"}", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "BatchSize", "type": "integer", "required": false, "description": "每批次投递到 ClickHouse 表消息数量，默认为 1000 条。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "1000" }, { "name": "ConsumerFetchMinBytes", "type": "integer", "required": false, "description": "每次从 topic 中拉取消息大小，默认为 1MB，即至少要从 topic 中批量拉取 1MB 消息，才进行数据投递到 ClickHouse 操作。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "1000000" }, { "name": "ConsumerFetchMaxWaitMs", "type": "integer", "required": false, "description": "每次从 topic 拉取消息最大等待时间，当超过当前最大等待时间时，即使没有拉取到 ConsumerFetchMinBytes 大小，也将进行 ClickHouse 投递操作。 提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。", "example": "30000" } ] }, { "name": "ClsParam", "type": "object", "required": false, "description": "Cls配置，Type为CLS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "DecodeJson", "type": "boolean", "required": true, "description": "生产的信息是否为json格式", "example": "true" }, { "name": "Resource", "type": "string", "required": true, "description": "cls日志主题id", "example": "resource-test" }, { "name": "LogSet", "type": "string", "required": false, "description": "cls日志集id", "example": "logset-test" }, { "name": "ContentKey", "type": "string", "required": false, "description": "当DecodeJson为false时必填", "example": "key-test" }, { "name": "TimeField", "type": "string", "required": false, "description": "指定消息中的某字段内容作为cls日志的时间。 字段内容格式需要是秒级时间戳", "example": "time" } ] }, { "name": "CosParam", "type": "object", "required": false, "description": "Cos配置，Type为COS时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BucketName", "type": "string", "required": true, "description": "cos 存储桶名称", "example": "bucket-name-test" }, { "name": "Region", "type": "string", "required": true, "description": "地域代码", "example": "ap-guangzhou" }, { "name": "ObjectKey", "type": "string", "required": false, "description": "对象名称", "example": "key-test" }, { "name": "AggregateBatchSize", "type": "integer", "required": false, "description": "汇聚消息量的大小（单位：MB)", "example": "100" }, { "name": "AggregateInterval", "type": "integer", "required": false, "description": "汇聚的时间间隔（单位：小时）", "example": "1" }, { "name": "FormatOutputType", "type": "string", "required": false, "description": "消息汇聚后的文件格式（支持csv, json）", "example": "json" }, { "name": "ObjectKeyPrefix", "type": "string", "required": false, "description": "转储的对象目录前缀", "example": "prefix-test" }, { "name": "DirectoryTimeFormat", "type": "string", "required": false, "description": "根据strptime 时间格式化的分区格式", "example": "/%Y/%m/%d/%H" } ] }, { "name": "MySQLParam", "type": "object", "required": false, "description": "MySQL配置，Type为MYSQL时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MySQL的数据库名称，\"*\"为全数据库", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "MySQL的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写，需要填入正则表达式时，格式为\"数据库名\\\\.数据表名\"", "example": "table-test" }, { "name": "Resource", "type": "string", "required": true, "description": "该MySQL在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only不复制, initial全量)，默认值initial", "example": "initial" }, { "name": "DdlTopic", "type": "string", "required": false, "description": "存放MySQL的Ddl信息的Topic，为空则默认不存放", "example": "topic-test" }, { "name": "DataSourceMonitorMode", "type": "string", "required": false, "description": "\"TABLE\" 表示读取项为 table，\"QUERY\" 表示读取项为 query", "example": "TABLE" }, { "name": "DataSourceMonitorResource", "type": "string", "required": false, "description": "当 \"DataMonitorMode\"=\"TABLE\" 时，传入需要读取的 Table；当 \"DataMonitorMode\"=\"QUERY\" 时，传入需要读取的查询 sql 语句", "example": "table-test" }, { "name": "DataSourceIncrementMode", "type": "string", "required": false, "description": "\"TIMESTAMP\" 表示增量列为时间戳类型，\"INCREMENT\" 表示增量列为自增 id 类型", "example": "TIMESTAMP" }, { "name": "DataSourceIncrementColumn", "type": "string", "required": false, "description": "传入需要监听的列名称", "example": "column_test" }, { "name": "DataSourceStartFrom", "type": "string", "required": false, "description": "\"HEAD\" 表示复制存量 + 增量数据，\"TAIL\" 表示只复制增量数据", "example": "HEAD" }, { "name": "DataTargetInsertMode", "type": "string", "required": false, "description": "\"INSERT\" 表示使用 Insert 模式插入，\"UPSERT\" 表示使用 Upsert 模式插入", "example": "INSERT" }, { "name": "DataTargetPrimaryKeyField", "type": "string", "required": false, "description": "当 \"DataInsertMode\"=\"UPSERT\" 时，传入当前 upsert 时依赖的主键", "example": "id" }, { "name": "DataTargetRecordMapping", "type": "array", "required": false, "description": "表与消息间的映射关系", "example": "无", "item_type": "object", "children": [ { "name": "JsonKey", "type": "string", "required": false, "description": "消息的 key 名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test-key" }, { "name": "Type", "type": "string", "required": false, "description": "消息类型", "example": "Integer" }, { "name": "AllowNull", "type": "boolean", "required": false, "description": "消息是否允许为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ColumnName", "type": "string", "required": false, "description": "对应映射列名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "column_test" }, { "name": "ExtraInfo", "type": "string", "required": false, "description": "数据库表额外字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "AUTO_INCREMENT COMMENT 'ID'" }, { "name": "ColumnSize", "type": "string", "required": false, "description": "当前列大小 注意：此字段可能返回 null，表示取不到有效值。", "example": "32" }, { "name": "DecimalDigits", "type": "string", "required": false, "description": "当前列精度 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "AutoIncrement", "type": "boolean", "required": false, "description": "是否为自增列 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "数据库表默认参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "TopicRegex", "type": "string", "required": false, "description": "事件路由到特定主题的正则表达式，默认为(.*)", "example": "(.*).db.(.*)" }, { "name": "TopicReplacement", "type": "string", "required": false, "description": "TopicRegex的引用组，指定$1、$2等", "example": "$1" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "Mysql 是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "DropCls", "type": "object", "required": false, "description": "当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效", "example": "无", "children": [ { "name": "DropInvalidMessageToCls", "type": "boolean", "required": false, "description": "是否投递到cls", "example": "true" }, { "name": "DropClsRegion", "type": "string", "required": false, "description": "投递cls的地域", "example": "ap-guangzhou" }, { "name": "DropClsOwneruin", "type": "string", "required": false, "description": "投递cls的账号", "example": "10003080064" }, { "name": "DropClsTopicId", "type": "string", "required": false, "description": "投递cls的主题", "example": "eafds-vfdfsdf-dbdfsdf" }, { "name": "DropClsLogSet", "type": "string", "required": false, "description": "投递cls的日志集id", "example": "wqead-bfdebv-sfds" } ] }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式，DEFAULT、CANAL_1、CANAL_2", "example": "DEFAULT" }, { "name": "IsTablePrefix", "type": "boolean", "required": false, "description": "当Table输入的是前缀时，该项值为true，否则为false", "example": "false" }, { "name": "IncludeContentChanges", "type": "string", "required": false, "description": "如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic", "example": "all" }, { "name": "IncludeQuery", "type": "boolean", "required": false, "description": "如果该值为true，且MySQL中\"binlog_rows_query_log_events\"配置项的值为\"ON\"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句", "example": "false" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" }, { "name": "SignalDatabase", "type": "string", "required": false, "description": "存放信令表的数据库名称", "example": "database-test" }, { "name": "IsTableRegular", "type": "boolean", "required": false, "description": "输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix", "example": "false" }, { "name": "SignalTable", "type": "string", "required": false, "description": "信号表 注意：此字段可能返回 null，表示取不到有效值。", "example": "table-test" }, { "name": "DateTimeZone", "type": "string", "required": false, "description": "datetime 类型字段转换为时间戳的时区", "example": "UTC+8" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" } ] }, { "name": "PostgreSQLParam", "type": "object", "required": false, "description": "PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "PostgreSQL的数据库名称", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "PostgreSQL的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"Schema名.数据表名\"的格式进行填写，需要填入正则表达式时，格式为\"Schema名\\\\.数据表名\"", "example": "SchemaName.Tabletest" }, { "name": "Resource", "type": "string", "required": true, "description": "该PostgreSQL在连接管理内的Id", "example": "resource-test" }, { "name": "PluginName", "type": "string", "required": true, "description": "插件名(decoderbufs/pgoutput)，默认为decoderbufs", "example": "decoderbufs" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(never增量, initial全量)，默认为initial", "example": "initial" }, { "name": "DataFormat", "type": "string", "required": false, "description": "上游数据格式(JSON/Debezium), 当数据库同步模式为默认字段匹配时,必填", "example": "JSON" }, { "name": "DataTargetInsertMode", "type": "string", "required": false, "description": "\"INSERT\" 表示使用 Insert 模式插入，\"UPSERT\" 表示使用 Upsert 模式插入", "example": "INSERT" }, { "name": "DataTargetPrimaryKeyField", "type": "string", "required": false, "description": "当 \"DataInsertMode\"=\"UPSERT\" 时，传入当前 upsert 时依赖的主键", "example": "id" }, { "name": "DataTargetRecordMapping", "type": "array", "required": false, "description": "表与消息间的映射关系", "example": "[{\"JsonKey\":\"test-key\",\"Type\":\"Integer\",\"AllowNull\":false,\"ColumnName\":\"column_test\",\"ExtraInfo\":\"AUTO_INCREMENT COMMENT 'ID'\",\"ColumnSize\":\"32\",\"DecimalDigits\":\"10\",\"AutoIncrement\":true,\"DefaultValue\":\"0\"}]", "item_type": "object", "children": [ { "name": "JsonKey", "type": "string", "required": false, "description": "消息的 key 名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test-key" }, { "name": "Type", "type": "string", "required": false, "description": "消息类型", "example": "Integer" }, { "name": "AllowNull", "type": "boolean", "required": false, "description": "消息是否允许为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ColumnName", "type": "string", "required": false, "description": "对应映射列名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "column_test" }, { "name": "ExtraInfo", "type": "string", "required": false, "description": "数据库表额外字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "AUTO_INCREMENT COMMENT 'ID'" }, { "name": "ColumnSize", "type": "string", "required": false, "description": "当前列大小 注意：此字段可能返回 null，表示取不到有效值。", "example": "32" }, { "name": "DecimalDigits", "type": "string", "required": false, "description": "当前列精度 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "AutoIncrement", "type": "boolean", "required": false, "description": "是否为自增列 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "数据库表默认参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "DropInvalidMessage", "type": "boolean", "required": false, "description": "是否抛弃解析失败的消息，默认为true", "example": "true" }, { "name": "IsTableRegular", "type": "boolean", "required": false, "description": "输入的table是否为正则表达式", "example": "false" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" } ] }, { "name": "TopicParam", "type": "object", "required": false, "description": "Topic配置，Type为Topic时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "单独售卖Topic的Topic名称", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "TopicId", "type": "string", "required": false, "description": "Topic的TopicId【出参】", "example": "topic-test" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，可选择\"gzip\", \"snappy\", \"lz4\"中的一个进行填写。", "example": "none" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）", "example": "false" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" } ] }, { "name": "MariaDBParam", "type": "object", "required": false, "description": "MariaDB配置，Type为MARIADB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "MariaDB的数据库名称，\"*\"为全数据库", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "MariaDB的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写", "example": "table-test" }, { "name": "Resource", "type": "string", "required": true, "description": "该MariaDB在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only不复制, initial全量)，默认值initial", "example": "initial" }, { "name": "KeyColumns", "type": "string", "required": false, "description": "格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键", "example": "db1.table2.k1,k2" }, { "name": "IsTablePrefix", "type": "boolean", "required": false, "description": "当Table输入的是前缀时，该项值为true，否则为false", "example": "false" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式，DEFAULT、CANAL_1、CANAL_2", "example": "DEFAULT" }, { "name": "IncludeContentChanges", "type": "string", "required": false, "description": "如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic", "example": "all" }, { "name": "IncludeQuery", "type": "boolean", "required": false, "description": "如果该值为true，且MySQL中\"binlog_rows_query_log_events\"配置项的值为\"ON\"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句", "example": "false" }, { "name": "RecordWithSchema", "type": "boolean", "required": false, "description": "如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带", "example": "false" } ] }, { "name": "SQLServerParam", "type": "object", "required": false, "description": "SQLServer配置，Type为SQLSERVER时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "SQLServer的数据库名称", "example": "database-test" }, { "name": "Table", "type": "string", "required": true, "description": "SQLServer的数据表名称，\"*\"为所监听的所有数据库中的非系统表，可以\",\"间隔，监听多个数据表，但数据表需要以\"数据库名.数据表名\"的格式进行填写", "example": " DatabaseName.Tabletest" }, { "name": "Resource", "type": "string", "required": true, "description": "该SQLServer在连接管理内的Id", "example": "resource-test" }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "复制存量信息(schema_only增量, initial全量)，默认为initial", "example": "initial" } ] }, { "name": "CtsdbParam", "type": "object", "required": false, "description": "Ctsdb配置，Type为CTSDB时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "连接管理实例资源", "example": "resource-test" }, { "name": "CtsdbMetric", "type": "string", "required": false, "description": "Ctsdb的metric", "example": "metric-test" } ] }, { "name": "ScfParam", "type": "object", "required": false, "description": "Scf配置，Type为SCF时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FunctionName", "type": "string", "required": true, "description": "SCF云函数函数名", "example": "function-test" }, { "name": "Namespace", "type": "string", "required": false, "description": "SCF云函数命名空间, 默认为default", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "SCF云函数版本及别名, 默认为$DEFAULT", "example": "$DEFAULT" }, { "name": "BatchSize", "type": "integer", "required": false, "description": "每批最大发送消息数, 默认为1000", "example": "1000" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "SCF调用失败后重试次数, 默认为5", "example": "5" } ] }, { "name": "MqttParam", "type": "object", "required": false, "description": "MQTT配置，Type为 MQTT 时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Topics", "type": "string", "required": true, "description": "需要同步的MQTT Topic列表, CSV格式", "example": "topic-test" }, { "name": "CleanSession", "type": "boolean", "required": true, "description": "用于控制会话的持久性。cleanSession 为true时，连接时会创建一个全新的会话。 cleanSession = false时，连接时会恢复之前的会话。", "example": "true" }, { "name": "Resource", "type": "string", "required": false, "description": "MQTT instance-id", "example": "resource-test" }, { "name": "Ip", "type": "string", "required": false, "description": "MQTT实例VIP", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "MQTT VIP 端口", "example": "1883" }, { "name": "UserName", "type": "string", "required": false, "description": "MQTT实例用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MQTT实例内账户密码", "example": "password-test" }, { "name": "Qos", "type": "integer", "required": false, "description": "QoS", "example": "1" }, { "name": "MaxTasks", "type": "integer", "required": false, "description": "tasks.max 订阅Topic的并发Task个数, 默认为1; 当设置大于1时, 使用Shared Subscription", "example": "1" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MQTT 实例的Service VIP", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MQTT实例的VPC ID", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群, MQTT只支持非自建集群", "example": "false" } ] } ] }, { "name": "TransformParam", "type": "object", "required": false, "description": "数据处理规则", "example": "无", "children": [ { "name": "AnalysisFormat", "type": "string", "required": true, "description": "解析格式，JSON，DELIMITER分隔符，REGULAR正则提取", "example": "DELIMITER" }, { "name": "OutputFormat", "type": "string", "required": true, "description": "输出格式", "example": "JSON" }, { "name": "FailureParam", "type": "object", "required": true, "description": "是否保留解析失败数据", "example": "{\"Type\":\"DLQ\",\"KafkaParam\":{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"},\"RetryInterval\":1,\"MaxRetryAttempts\":1,\"TopicParam\":{\"Resource\":\"appId-test\"},\"DlqType\":\"TOPIC\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，DLQ死信队列，IGNORE_ERROR保留，DROP丢弃", "example": "DLQ" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "Ckafka类型死信队列", "example": "{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"}", "children": [ { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": false, "description": "主题名，多个以“,”分隔", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "ResourceName", "type": "string", "required": false, "description": "实例资源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ckafka测试" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "100003" }, { "name": "TopicId", "type": "string", "required": false, "description": "主题Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "Topic的分区数 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EnableToleration", "type": "boolean", "required": false, "description": "启用容错实例/开启死信队列 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "QpsLimit", "type": "integer", "required": false, "description": "Qps 限制", "example": "4000" }, { "name": "TableMappings", "type": "array", "required": false, "description": "Table到Topic的路由，「分发到多个topic」开关打开时必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Database\":\"db1\",\"Table\":\"table1\",\"Topic\":\"topic1\",\"TopicId\":\"topic-id\"}]", "item_type": "string" }, { "name": "UseTableMapping", "type": "boolean", "required": false, "description": "「分发到多个topic」开关，默认为false", "example": "false" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）", "example": "false" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，填写\"open\"。", "example": "none" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" }, { "name": "ConnectorSyncType", "type": "string", "required": false, "description": "数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写\"META_SYNC_INSTANCE_TYPE\", 同步元数据及全部topic内消息的填写\"META_AND_DATA_SYNC_INSTANCE_TYPE\"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写\"DATA_SYNC_TYPE\"", "example": "DATA_SYNC_TYPE" }, { "name": "KeepPartition", "type": "boolean", "required": false, "description": "数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false", "example": "false" }, { "name": "TopicRegularExpression", "type": "string", "required": false, "description": "正则匹配Topic列表", "example": "mytest" }, { "name": "Prefix", "type": "string", "required": false, "description": "Topic 前缀" }, { "name": "Separator", "type": "string", "required": false, "description": "Topic前缀分隔符" } ] }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔", "example": "1" }, { "name": "MaxRetryAttempts", "type": "integer", "required": false, "description": "重试次数", "example": "2" }, { "name": "TopicParam", "type": "object", "required": false, "description": "DIP Topic类型死信队列", "example": "{\"Resource\":\"appId-test\"}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "单独售卖Topic的Topic名称", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "TopicId", "type": "string", "required": false, "description": "Topic的TopicId【出参】", "example": "topic-test" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，可选择\"gzip\", \"snappy\", \"lz4\"中的一个进行填写。", "example": "none" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）", "example": "false" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" } ] }, { "name": "DlqType", "type": "string", "required": false, "description": "死信队列类型，CKAFKA，TOPIC", "example": "TOPIC" } ] }, { "name": "Content", "type": "string", "required": true, "description": "原始数据", "example": "content-test" }, { "name": "SourceType", "type": "string", "required": true, "description": "数据来源，TOPIC从源topic拉取，CUSTOMIZE自定义", "example": "TOPIC" }, { "name": "Regex", "type": "string", "required": false, "description": "分隔符、正则表达式", "example": "," }, { "name": "MapParam", "type": "array", "required": false, "description": "Map", "example": "[{\"Key\":\"key-test\",\"Type\":\"DEFAULT\",\"Value\":\"value-test\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key值", "example": "key-test" }, { "name": "Type", "type": "string", "required": false, "description": "类型，DEFAULT默认，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射", "example": "DEFAULT" }, { "name": "Value", "type": "string", "required": false, "description": "值", "example": "value-test" } ] }, { "name": "FilterParam", "type": "array", "required": false, "description": "过滤器", "example": "[{\"Key\":\"key-test\",\"Type\":\"REGULAR\",\"MatchMode\":\"PREFIX\",\"Value\":\"value-test\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Key值", "example": "key-test" }, { "name": "MatchMode", "type": "string", "required": true, "description": "匹配模式，前缀匹配PREFIX，后缀匹配SUFFIX，包含匹配CONTAINS，EXCEPT除外匹配，数值匹配NUMBER，IP匹配IP", "example": "PREFIX" }, { "name": "Value", "type": "string", "required": true, "description": "Value值", "example": "value-test" }, { "name": "Type", "type": "string", "required": false, "description": "固定REGULAR", "example": "REGULAR" } ] }, { "name": "Result", "type": "string", "required": false, "description": "测试结果", "example": "result-test" }, { "name": "AnalyseResult", "type": "array", "required": false, "description": "解析结果", "example": "[{\"Type\":\"DEFAULT\",\"Key\":\"1\"},{\"Type\":\"DEFAULT\",\"Key\":\"2\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key值", "example": "key-test" }, { "name": "Type", "type": "string", "required": false, "description": "类型，DEFAULT默认，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射", "example": "DEFAULT" }, { "name": "Value", "type": "string", "required": false, "description": "值", "example": "value-test" } ] }, { "name": "UseEventBus", "type": "boolean", "required": false, "description": "底层引擎是否使用eb", "example": "true" } ] }, { "name": "SchemaId", "type": "string", "required": false, "description": "选择所要绑定的SchemaId", "example": "schema-test" }, { "name": "TransformsParam", "type": "object", "required": false, "description": "数据处理规则", "example": "无", "children": [ { "name": "Content", "type": "string", "required": true, "description": "原始数据", "example": "{\"name\":\"abc\"}" }, { "name": "FieldChain", "type": "array", "required": true, "description": "处理链", "example": "{\"Analyse\":{\"Format\":\"JSON\"}}", "item_type": "object", "children": [ { "name": "Analyse", "type": "object", "required": true, "description": "解析", "example": "{\"Format\":\"JSON\"}", "children": [ { "name": "Format", "type": "string", "required": true, "description": "解析格式，JSON，DELIMITER分隔符，REGULAR正则提取，SOURCE处理上层所有结果", "example": "JSON" }, { "name": "Regex", "type": "string", "required": false, "description": "分隔符、正则表达式", "example": "," }, { "name": "InputValueType", "type": "string", "required": false, "description": "需再次处理的KEY——模式", "example": "JSONPATH" }, { "name": "InputValue", "type": "string", "required": false, "description": "需再次处理的KEY——KEY表达式", "example": "$.log" } ] }, { "name": "SecondaryAnalyse", "type": "object", "required": false, "description": "二次解析", "example": "{\"Regex\":\",\"}", "children": [ { "name": "Regex", "type": "string", "required": true, "description": "分隔符", "example": "," } ] }, { "name": "SMT", "type": "array", "required": false, "description": "数据处理", "example": "[{\"Key\":\"key-test\",\"Operate\":\"MAPPING\",\"SchemeType\":\"ORIGINAL\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "数据处理KEY", "example": "key-test" }, { "name": "Operate", "type": "string", "required": true, "description": "操作，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射，JSONPATH", "example": "MAPPING" }, { "name": "SchemeType", "type": "string", "required": true, "description": "数据类型，ORIGINAL原始，STRING，INT64，FLOAT64，BOOLEAN，MAP，ARRAY", "example": "ORIGINAL" }, { "name": "Value", "type": "string", "required": false, "description": "数据处理VALUE", "example": "value-test" }, { "name": "ValueOperate", "type": "object", "required": false, "description": "VALUE处理", "example": "{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}" }, { "name": "OriginalValue", "type": "string", "required": false, "description": "原始VALUE", "example": "value-test" }, { "name": "ValueOperates", "type": "array", "required": false, "description": "VALUE处理链", "example": "[{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}]", "item_type": "string" } ] }, { "name": "Result", "type": "string", "required": false, "description": "测试结果", "example": "result-test" }, { "name": "AnalyseResult", "type": "array", "required": false, "description": "解析结果", "example": "[{\"Key\":\"key-test\",\"Operate\":\"MAPPING\",\"SchemeType\":\"ORIGINAL\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "数据处理KEY", "example": "key-test" }, { "name": "Operate", "type": "string", "required": true, "description": "操作，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射，JSONPATH", "example": "MAPPING" }, { "name": "SchemeType", "type": "string", "required": true, "description": "数据类型，ORIGINAL原始，STRING，INT64，FLOAT64，BOOLEAN，MAP，ARRAY", "example": "ORIGINAL" }, { "name": "Value", "type": "string", "required": false, "description": "数据处理VALUE", "example": "value-test" }, { "name": "ValueOperate", "type": "object", "required": false, "description": "VALUE处理", "example": "{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}" }, { "name": "OriginalValue", "type": "string", "required": false, "description": "原始VALUE", "example": "value-test" }, { "name": "ValueOperates", "type": "array", "required": false, "description": "VALUE处理链", "example": "[{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}]", "item_type": "string" } ] }, { "name": "SecondaryAnalyseResult", "type": "array", "required": false, "description": "二次解析结果", "example": "[{\"Key\":\"key-test\",\"Operate\":\"MAPPING\",\"SchemeType\":\"ORIGINAL\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "数据处理KEY", "example": "key-test" }, { "name": "Operate", "type": "string", "required": true, "description": "操作，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射，JSONPATH", "example": "MAPPING" }, { "name": "SchemeType", "type": "string", "required": true, "description": "数据类型，ORIGINAL原始，STRING，INT64，FLOAT64，BOOLEAN，MAP，ARRAY", "example": "ORIGINAL" }, { "name": "Value", "type": "string", "required": false, "description": "数据处理VALUE", "example": "value-test" }, { "name": "ValueOperate", "type": "object", "required": false, "description": "VALUE处理", "example": "{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}" }, { "name": "OriginalValue", "type": "string", "required": false, "description": "原始VALUE", "example": "value-test" }, { "name": "ValueOperates", "type": "array", "required": false, "description": "VALUE处理链", "example": "[{\"Date\":{\"Format\":\"yyyy-MM-dd HH:mm:ss\"},\"Substr\":{\"Start\":0,\"End\":1},\"Type\":\"type-test\",\"Replace\":{\"NewValue\":\"value-new\",\"OldValue\":\"value-old\"}}]", "item_type": "string" } ] }, { "name": "AnalyseJsonResult", "type": "string", "required": false, "description": "JSON格式解析结果", "example": "result-test" }, { "name": "SecondaryAnalyseJsonResult", "type": "string", "required": false, "description": "JSON格式二次解析结果", "example": "result-test" } ] }, { "name": "FilterParam", "type": "array", "required": false, "description": "过滤器", "example": "[{\"Key\":\"key-test\",\"Type\":\"REGULAR\",\"MatchMode\":\"PREFIX\",\"Value\":\"value-test\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Key值", "example": "key-test" }, { "name": "MatchMode", "type": "string", "required": true, "description": "匹配模式，前缀匹配PREFIX，后缀匹配SUFFIX，包含匹配CONTAINS，EXCEPT除外匹配，数值匹配NUMBER，IP匹配IP", "example": "PREFIX" }, { "name": "Value", "type": "string", "required": true, "description": "Value值", "example": "value-test" }, { "name": "Type", "type": "string", "required": false, "description": "固定REGULAR", "example": "REGULAR" } ] }, { "name": "FailureParam", "type": "object", "required": false, "description": "失败处理", "example": "{\"Type\":\"DROP\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，DLQ死信队列，IGNORE_ERROR保留，DROP丢弃", "example": "DLQ" }, { "name": "KafkaParam", "type": "object", "required": false, "description": "Ckafka类型死信队列", "example": "{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\"}", "children": [ { "name": "SelfBuilt", "type": "boolean", "required": true, "description": "是否为自建集群", "example": "false" }, { "name": "Resource", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": false, "description": "主题名，多个以“,”分隔", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "ResourceName", "type": "string", "required": false, "description": "实例资源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "ckafka测试" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "100003" }, { "name": "TopicId", "type": "string", "required": false, "description": "主题Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": false, "description": "Topic的分区数 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EnableToleration", "type": "boolean", "required": false, "description": "启用容错实例/开启死信队列 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "QpsLimit", "type": "integer", "required": false, "description": "Qps 限制", "example": "4000" }, { "name": "TableMappings", "type": "array", "required": false, "description": "Table到Topic的路由，「分发到多个topic」开关打开时必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Database\":\"db1\",\"Table\":\"table1\",\"Topic\":\"topic1\",\"TopicId\":\"topic-id\"}]", "item_type": "string" }, { "name": "UseTableMapping", "type": "boolean", "required": false, "description": "「分发到多个topic」开关，默认为false", "example": "false" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）", "example": "false" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，填写\"open\"。", "example": "none" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" }, { "name": "ConnectorSyncType", "type": "string", "required": false, "description": "数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写\"META_SYNC_INSTANCE_TYPE\", 同步元数据及全部topic内消息的填写\"META_AND_DATA_SYNC_INSTANCE_TYPE\"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写\"DATA_SYNC_TYPE\"", "example": "DATA_SYNC_TYPE" }, { "name": "KeepPartition", "type": "boolean", "required": false, "description": "数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false", "example": "false" }, { "name": "TopicRegularExpression", "type": "string", "required": false, "description": "正则匹配Topic列表", "example": "mytest" }, { "name": "Prefix", "type": "string", "required": false, "description": "Topic 前缀" }, { "name": "Separator", "type": "string", "required": false, "description": "Topic前缀分隔符" } ] }, { "name": "RetryInterval", "type": "integer", "required": false, "description": "重试间隔", "example": "1" }, { "name": "MaxRetryAttempts", "type": "integer", "required": false, "description": "重试次数", "example": "2" }, { "name": "TopicParam", "type": "object", "required": false, "description": "DIP Topic类型死信队列", "example": "{\"Resource\":\"appId-test\"}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "单独售卖Topic的Topic名称", "example": "topic-test" }, { "name": "OffsetType", "type": "string", "required": false, "description": "Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。", "example": "timestamp" }, { "name": "StartTime", "type": "integer", "required": false, "description": "Offset类型为timestamp时必传，传时间戳，精确到秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1566144000" }, { "name": "TopicId", "type": "string", "required": false, "description": "Topic的TopicId【出参】", "example": "topic-test" }, { "name": "CompressionType", "type": "string", "required": false, "description": "写入Topic时是否进行压缩，不开启填\"none\"，开启的话，可选择\"gzip\", \"snappy\", \"lz4\"中的一个进行填写。", "example": "none" }, { "name": "UseAutoCreateTopic", "type": "boolean", "required": false, "description": "使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）", "example": "false" }, { "name": "MsgMultiple", "type": "integer", "required": false, "description": "源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)", "example": "1" } ] }, { "name": "DlqType", "type": "string", "required": false, "description": "死信队列类型，CKAFKA，TOPIC", "example": "TOPIC" } ] }, { "name": "Result", "type": "string", "required": false, "description": "测试结果", "example": "result-test" }, { "name": "SourceType", "type": "string", "required": false, "description": "数据来源", "example": "CKAFKA" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式，JSON，ROW，默认为JSON", "example": "JSON" }, { "name": "RowParam", "type": "object", "required": false, "description": "输出格式为ROW必填", "example": "{\"RowContent\":\"KEY_VALUE\",\"KeyValueDelimiter\":\"=\",\"EntryDelimiter\":\"\u0026\"}", "children": [ { "name": "RowContent", "type": "string", "required": true, "description": "行内容，KEY_VALUE，VALUE", "example": "KEY_VALUE" }, { "name": "KeyValueDelimiter", "type": "string", "required": false, "description": "key和value间的分隔符", "example": "=" }, { "name": "EntryDelimiter", "type": "string", "required": false, "description": "元素建的分隔符", "example": "\u0026" } ] }, { "name": "KeepMetadata", "type": "boolean", "required": false, "description": "是否保留数据源Topic元数据信息（源Topic、Partition、Offset），默认为false", "example": "false" }, { "name": "BatchAnalyse", "type": "object", "required": false, "description": "数组解析", "example": "{\"Format\":\"ONE_BY_ONE\"}", "children": [ { "name": "Format", "type": "string", "required": true, "description": "ONE_BY_ONE单条输出，MERGE合并输出", "example": "ONE_BY_ONE" } ] } ] }, { "name": "TaskId", "type": "string", "required": false, "description": "任务Id", "example": "task-test" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] }, { "name": "Description", "type": "string", "required": false, "description": "任务描述信息", "example": "任务描述信息" } ], "required": [ "TaskName", "TaskType" ] }, { "name": "CreateDatahubTopic", "description": "创建DIP主题", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "名称，是一个不超过 128 个字符的字符串，必须以“AppId-”为首字符，剩余部分可以包含字母、数字和横划线(-)", "example": "appId-test" }, { "name": "PartitionNum", "type": "integer", "required": true, "description": "Partition个数，大于0", "example": "1" }, { "name": "RetentionMs", "type": "integer", "required": true, "description": "消息保留时间，单位ms，当前最小值为60000ms", "example": "60000" }, { "name": "Note", "type": "string", "required": false, "description": "主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)", "example": "note-test" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "[{\"TagKey\":\"tagkey-test\",\"TagValue\":\"tagvalue-test\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] } ], "required": [ "Name", "PartitionNum", "RetentionMs" ] }, { "name": "CreateInstancePre", "description": "创建实例(预付费包年包月), 仅支持创建专业版实例", "status": "online", "parameters": [ { "name": "InstanceName", "type": "string", "required": true, "description": "ckafka集群实例Name，是一个不超过 128 个字符的任意字符串。", "example": "ckafka集群实例Name" }, { "name": "ZoneId", "type": "integer", "required": true, "description": "可用区。当购买多可用区实例时，当前参数为主可用区。 查看可用区", "example": "100003" }, { "name": "Period", "type": "string", "required": true, "description": "预付费购买时长，例如 \"1m\",就是一个月,取值范围 1m~36m", "example": "1m" }, { "name": "InstanceType", "type": "integer", "required": true, "description": "国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写...", "example": "1" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id", "example": "vpc-test" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网id", "example": "subnet-test" }, { "name": "MsgRetentionTime", "type": "integer", "required": false, "description": "可选。实例日志的最长保留时间，单位分钟，不填默认为1440（1天），可设置范围为1分钟到90天。", "example": "1440" }, { "name": "ClusterId", "type": "integer", "required": false, "description": "创建实例时可以选择集群Id, 该入参表示集群Id", "example": "1232" }, { "name": "RenewFlag", "type": "integer", "required": false, "description": "预付费自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)", "example": "0" }, { "name": "KafkaVersion", "type": "string", "required": false, "description": "CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本，传任意一个均可。", "example": "2.4.2" }, { "name": "SpecificationsType", "type": "string", "required": false, "description": "实例类型: [标准版实例]填写 \"standard\" (默认), [专业版实例]填写 \"profession\",[高级版实例]填写\"premium\"", "example": "profession" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "磁盘大小，如果跟控制台规格配比不相符，则无法创建成功。默认取值为500，步长设置为100。可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122562", "example": "800" }, { "name": "BandWidth", "type": "integer", "required": false, "description": "实例带宽,默认值为40，单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s。可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/11745", "example": "20" }, { "name": "Partition", "type": "integer", "required": false, "description": "分区大小，如果跟控制台规格配比不相符，则无法创建成功。默认值为800，步长为100。可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122563", "example": "800" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] }, { "name": "DiskType", "type": "string", "required": false, "description": "专业版/高级版实例磁盘类型，标准版实例不需要填写。\"CLOUD_SSD\"：SSD云硬盘；\"CLOUD_BASIC\"：高性能云硬盘。不传默认为 \"CLOUD_BASIC\"", "example": "CLOUD_SSD" }, { "name": "MultiZoneFlag", "type": "boolean", "required": false, "description": "是否创建跨可用区实例，当前参数为 true 时，zoneIds必填", "example": "true" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区列表，购买多可用区实例时为必填项", "example": "[100006,100007]", "item_type": "integer" }, { "name": "PublicNetworkMonthly", "type": "integer", "required": false, "description": "公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍", "example": "12" }, { "name": "InstanceNum", "type": "integer", "required": false, "description": "购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券:1-是;0否。默认为0", "example": "0" }, { "name": "ElasticBandwidthSwitch", "type": "integer", "required": false, "description": "弹性带宽开关 0不开启 1开启（0默认）", "example": "0" }, { "name": "CustomSSLCertId", "type": "string", "required": false, "description": "自定义证书Id,仅当SpecificationsType为profession时生效,支持自定义证书能力可通过DescribeCertificateDetail接口获取", "example": "TPNd2oBB" } ], "required": [ "InstanceName", "ZoneId", "Period", "InstanceType", "VpcId", "SubnetId" ] }, { "name": "CreatePartition", "description": "本接口用于增加主题中的分区", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": true, "description": "主题分区个数，传入参数为修改后的分区数，而不是增加的分区数，因此传入参数需要大于当前主题分区个数。", "example": "3" } ], "required": [ "InstanceId", "TopicName", "PartitionNum" ] }, { "name": "CreatePostPaidInstance", "description": "当前接口用来替代 CreateInstancePost 接口。创建按量计费实例。通常用于 SDK 或云 API 控制台调用接口，创建后付费 CKafka 实例。调用接口与在 CKafka 控制台购买按量付费实例效果相同。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id,可通过DescribeVpcs接口获取", "example": "vpc-test" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网Id,可通过DescribeSubnets接口获取", "example": "subnet-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "ckafka集群实例名称，是一个长度不超过128的任意字符。", "example": "ckafka测试" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写...", "example": "1" }, { "name": "MsgRetentionTime", "type": "integer", "required": false, "description": "实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准", "example": "1440" }, { "name": "ClusterId", "type": "integer", "required": false, "description": "创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数", "example": "5914" }, { "name": "KafkaVersion", "type": "string", "required": false, "description": "实例版本。目前支持当前支持\"2.4.1\", \"2.4.2\",\"2.8.1\", \"3.2.3\"，默认取值\"2.4.1\"。\"2.4.1\" 与 \"2.4.2\" 属于同一个版本，传任意一个均可。", "example": "2.4.2" }, { "name": "SpecificationsType", "type": "string", "required": false, "description": "实例类型。\"standard\"：标准版，\"profession\"：专业版。 (标准版仅国际站支持，国内站目前支持专业版)", "example": "profession" }, { "name": "DiskType", "type": "string", "required": false, "description": "专业版实例磁盘类型，标准版实例不需要填写。\"CLOUD_SSD\"：SSD云硬盘；\"CLOUD_BASIC\"：高性能云硬盘。不传默认值为 \"CLOUD_BASIC\"", "example": "CLOUD_BASIC" }, { "name": "BandWidth", "type": "integer", "required": false, "description": "实例内网峰值带宽，默认值为40。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格，可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/11745", "example": "20" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "实例硬盘大小，默认取值为500，步长设置为100。需要满足当前实例的计费规格，可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122562", "example": "200" }, { "name": "Partition", "type": "integer", "required": false, "description": "实例最大分区数量，需要满足当前实例的计费规格。默认值为800，步长为100。可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122563", "example": "400" }, { "name": "TopicNum", "type": "integer", "required": false, "description": "实例最大 topic 数量，需要满足当前实例的计费规格。默认值为800，步长设置为100。", "example": "200" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id。ZoneId、ZoneIds不能同时为空，可通过DescribeCkafkaZone接口获取。", "example": "100006" }, { "name": "MultiZoneFlag", "type": "boolean", "required": false, "description": "当前实例是否为多可用区实例。", "example": "true" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中。ZoneId、ZoneIds不能同时为空，可通过DescribeCkafkaZone接口获取。", "example": "[100006,100007]", "item_type": "integer" }, { "name": "InstanceNum", "type": "integer", "required": false, "description": "购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例", "example": "1" }, { "name": "PublicNetworkMonthly", "type": "integer", "required": false, "description": "公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍", "example": "12" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] }, { "name": "ElasticBandwidthSwitch", "type": "integer", "required": false, "description": "弹性带宽开关 0不开启 1开启（0默认)", "example": "0" }, { "name": "CustomSSLCertId", "type": "string", "required": false, "description": "自定义证书Id,仅当SpecificationsType为profession时生效,支持自定义证书能力可通过DescribeCertificateDetail接口获取", "example": "TTpTQ6QD" } ], "required": [ "VpcId", "SubnetId" ] }, { "name": "CreatePrometheus", "description": "添加普罗米修斯监控", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络Id,可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取", "example": "vpc-test" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网Id,可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取", "example": "subnet-test" } ], "required": [ "InstanceId", "VpcId", "SubnetId" ] }, { "name": "CreateRoute", "description": "添加实例路由", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例id,可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "VipType", "type": "integer", "required": true, "description": "路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc网络Id,当vipType为3时必填", "example": "vpc-test" }, { "name": "SubnetId", "type": "string", "required": false, "description": "vpc子网id,当vipType为3时必填", "example": "subnet-test" }, { "name": "AccessType", "type": "integer", "required": false, "description": "访问类型：0-plaintext；1-sasl_plaintext；3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0vipType=3,支持 0,1,3,4,5vipType=7,支持0,1,3vipType=1,支持1,3", "example": "1" }, { "name": "AuthFlag", "type": "integer", "required": false, "description": "是否需要权限管理,该字段已废弃", "example": "1" }, { "name": "CallerAppid", "type": "integer", "required": false, "description": "调用方appId", "example": "1000000001" }, { "name": "PublicNetwork", "type": "integer", "required": false, "description": "公网带宽,公网路由必传,且是3的倍数,无默认值", "example": "3" }, { "name": "Ip", "type": "string", "required": false, "description": "vip地址", "example": "10.0.0.30" }, { "name": "Note", "type": "string", "required": false, "description": "备注信息", "example": "note-test" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "关联安全组有序列表", "example": "[\"sg-test\"]", "item_type": "string" } ], "required": [ "InstanceId", "VipType" ] }, { "name": "CreateToken", "description": "创建最高权限的token", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "username-test" } ], "required": [ "InstanceId", "User" ] }, { "name": "CreateTopic", "description": "创建ckafka主题", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "只能包含字母、数字、下划线、“-”、“.”", "example": "topic-test" }, { "name": "PartitionNum", "type": "integer", "required": true, "description": "Partition个数，大于0", "example": "1" }, { "name": "ReplicaNum", "type": "integer", "required": true, "description": "副本个数，不能多于 broker 数，最大为3", "example": "2" }, { "name": "EnableWhiteList", "type": "integer", "required": false, "description": "ip白名单开关, 1:打开 0:关闭，默认不打开", "example": "0" }, { "name": "IpWhiteList", "type": "array", "required": false, "description": "Ip白名单列表，配额限制，enableWhileList=1时必选", "example": "[\"1.1.1.1\",\"2.2.2.2\"]", "item_type": "string" }, { "name": "CleanUpPolicy", "type": "string", "required": false, "description": "清理日志策略，日志清理模式，默认为\u0026quot;delete\u0026quot;。\u0026quot;delete\u0026quot;：日志按保存时间删除，\u0026quot;compact\u0026quot;：日志按 key 压缩，\u0026quot;compact, delete\u0026quot;：日志按 key 压缩且会按保存时间删除。", "example": "delete" }, { "name": "Note", "type": "string", "required": false, "description": "主题备注入参限制：不超过 64 个字符", "example": "note" }, { "name": "MinInsyncReplicas", "type": "integer", "required": false, "description": "最小同步副本数默认值：1最小值为1", "example": "2" }, { "name": "UncleanLeaderElectionEnable", "type": "integer", "required": false, "description": "是否允许未同步的副本选为leader，0:不允许，1:允许，默认不允许", "example": "1" }, { "name": "RetentionMs", "type": "integer", "required": false, "description": "可选参数，消息保留时间取值范围：[60000, 7776000000]单位：毫秒默认值：7200000", "example": "60000" }, { "name": "SegmentMs", "type": "integer", "required": false, "description": "Segment分片滚动的时长单位：毫秒默认值：86400000最小值为86400000ms（1天）", "example": "86400000" }, { "name": "MaxMessageBytes", "type": "integer", "required": false, "description": "主题消息最大值，单位为 Byte，最小值1024Bytes(即1KB)，最大值为12582912Bytes（即12MB）", "example": "1024" }, { "name": "EnableAclRule", "type": "integer", "required": false, "description": "预设ACL规则, 1:打开 0:关闭，默认不打开", "example": "0" }, { "name": "AclRuleName", "type": "string", "required": false, "description": "预设ACL规则的名称", "example": "rulename-test" }, { "name": "RetentionBytes", "type": "integer", "required": false, "description": "可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。取值范围：[1073741824, 1099511627776]单位：字节特殊值：-1表示无限制", "example": "1073741824" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] }, { "name": "LogMsgTimestampType", "type": "string", "required": false, "description": "消息保存的时间类型:CreateTime/LogAppendTime", "example": "LogAppendTime" } ], "required": [ "InstanceId", "TopicName", "PartitionNum", "ReplicaNum" ] }, { "name": "CreateTopicIpWhiteList", "description": "创建主题ip白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取", "example": "topic-test" }, { "name": "IpWhiteList", "type": "array", "required": true, "description": "ip白名单列表，最大值为512，即最大允许传入512个ip。", "example": "[\"192.16.23.36\"]", "item_type": "string" } ], "required": [ "InstanceId", "TopicName", "IpWhiteList" ] }, { "name": "CreateUser", "description": "添加用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "Name", "type": "string", "required": true, "description": "用户名称", "example": "name-test" }, { "name": "Password", "type": "string", "required": true, "description": "用户密码", "example": "password-test" } ], "required": [ "InstanceId", "Name", "Password" ] }, { "name": "DeleteAcl", "description": "删除ACL", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "ResourceType", "type": "integer", "required": true, "description": "Acl资源类型，(2:TOPIC，3:GROUP，4:CLUSTER)", "example": "2" }, { "name": "ResourceName", "type": "string", "required": true, "description": "资源名称，和resourceType相关，如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称，当resourceType为CLUSTER时，该字段可为空。", "example": "topic-test" }, { "name": "Operation", "type": "integer", "required": true, "description": "Acl操作方式，(2:ALL，3:READ，4:WRITE，5:CREATE，6:DELETE，7:ALTER，8:DESCRIBE，9:CLUSTER_ACTION，10:DESCRIBE_CONFIGS，11:ALTER_CONFIGS，12:IDEMPOTENT_WRITE)", "example": "2" }, { "name": "PermissionType", "type": "integer", "required": true, "description": "权限类型，(2:DENY，3:ALLOW)，当前ckafka支持ALLOW(相当于白名单)，其它用于后续兼容开源kafka的acl时使用", "example": "2" }, { "name": "Host", "type": "string", "required": false, "description": "默认为\\*，表示任何host都可以访问，当前ckafka不支持host为\\*，但是后面开源kafka的产品化会直接支持", "example": "1.1.1.1" }, { "name": "Principal", "type": "string", "required": false, "description": "用户列表，默认为User:*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户", "example": "User:*" } ], "required": [ "InstanceId", "ResourceType", "ResourceName", "Operation", "PermissionType" ] }, { "name": "DeleteAclRule", "description": "删除ACL规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id信息，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "RuleName", "type": "string", "required": true, "description": "acl规则名称，可通过DescribeAclRule接口获取。", "example": "rulename-test" } ], "required": [ "InstanceId", "RuleName" ] }, { "name": "DeleteConnectResource", "description": "删除Datahub连接源", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "连接源的Id", "example": "resource-test" } ], "required": [ "ResourceId" ] }, { "name": "DeleteDatahubTask", "description": "删除Dip任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" } ], "required": [ "TaskId" ] }, { "name": "DeleteDatahubTopic", "description": "删除DIP主题", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "Topic名称", "example": "appId-test" } ], "required": [ "Name" ] }, { "name": "DeleteGroup", "description": "删除消费组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取。", "example": "ckafka-test" }, { "name": "Group", "type": "string", "required": true, "description": "消费组名称，可通过[DescribeConsumerGroup](https://cloud.tencent.com/document/product/597/40841)接口获取。", "example": "group-test" } ], "required": [ "InstanceId", "Group" ] }, { "name": "DeleteGroupSubscribeTopic", "description": "删除消费分组订阅的topic(消费分组必须是Empty 状态)", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Group", "type": "string", "required": true, "description": "消费分组名称", "example": "group-test" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名", "example": "topic-test" } ], "required": [ "InstanceId", "Group", "Topic" ] }, { "name": "DeleteInstancePost", "description": "删除后付费实例，通过调用API删除不会对连接器和任务进行关联预检查，直接进行实例销毁。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DeleteInstancePre", "description": "删除预付费实例，该接口会对实例执行隔离并删除的动作，执行成功后实例会被直接删除销毁。通过调用API删除不会对连接器和任务进行关联预检查，直接进行实例销毁。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过DescribeInstances接口获取", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DeleteRoute", "description": "删除路由", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "RouteId", "type": "integer", "required": true, "description": "路由id,可通过[DescribeRoute](https://cloud.tencent.com/document/product/597/45484)接口获取", "example": "301" }, { "name": "CallerAppid", "type": "integer", "required": false, "description": "调用方appId", "example": "1000000001" }, { "name": "DeleteRouteTime", "type": "string", "required": false, "description": "设置定时删除路由时间,仅类型为公网路由支持定时删除,可选择未来的24小时的任意时间", "example": "2020-08-21 11:15:54" } ], "required": [ "InstanceId", "RouteId" ] }, { "name": "DeleteRouteTriggerTime", "description": "修改删除路由延迟触发时间", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "DelayTime", "type": "string", "required": true, "description": "修改删除路由的定时时间", "example": "2020-08-21 11:15:54" } ], "required": [ "InstanceId", "DelayTime" ] }, { "name": "DeleteTopic", "description": "删除ckafka主题", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka 实例Id", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "ckafka 主题名称", "example": "topic-test" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "DeleteTopicIpWhiteList", "description": "删除主题IP白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。", "example": "topic-test" }, { "name": "IpWhiteList", "type": "array", "required": true, "description": "ip白名单列表", "example": "[\"192.16.23.3666\"]", "item_type": "string" } ], "required": [ "InstanceId", "TopicName", "IpWhiteList" ] }, { "name": "DeleteUser", "description": "删除用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取。", "example": "ckafka-test" }, { "name": "Name", "type": "string", "required": true, "description": "用户名称，可通过[DescribeUser](https://cloud.tencent.com/document/product/597/40855)接口获取。", "example": "name-test" } ], "required": [ "InstanceId", "Name" ] }, { "name": "DescribeACL", "description": "枚举ACL", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "ResourceType", "type": "integer", "required": true, "description": "Acl资源类型，(2:TOPIC，3:GROUP，4:CLUSTER)", "example": "2" }, { "name": "ResourceName", "type": "string", "required": true, "description": "资源名称，和resourceType相关，如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称，当resourceType为CLUSTER时，该字段可为空。", "example": "topic-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "个数限制，默认值为50，最大值为50。", "example": "20" }, { "name": "SearchWord", "type": "string", "required": false, "description": "关键字匹配", "example": "search-test" } ], "required": [ "InstanceId", "ResourceType", "ResourceName" ] }, { "name": "DescribeAclRule", "description": "查询ACL规则列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "RuleName", "type": "string", "required": false, "description": "ACL规则名", "example": "rulename-test" }, { "name": "PatternType", "type": "string", "required": false, "description": "ACL规则匹配类型 （PREFIXED：前缀匹配，PRESET：预设策略）", "example": "PREFIXED" }, { "name": "IsSimplified", "type": "boolean", "required": false, "description": "是否读取简略的ACL规则，默认值为false，表示不读取简略的ACL规则。", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCkafkaVersion", "description": "查询实例版本信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCkafkaZone", "description": "用于查看ckafka的可用区列表", "status": "online", "parameters": [ { "name": "CdcId", "type": "string", "required": false, "description": "cdc集群Id", "example": "cluster-test" } ], "required": [] }, { "name": "DescribeConnectResource", "description": "查询Datahub连接源", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "连接源的Id", "example": "resource-test" } ], "required": [ "ResourceId" ] }, { "name": "DescribeConnectResources", "description": "查询Datahub连接源列表", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": false, "description": "连接源类型", "example": "KAFKA" }, { "name": "SearchWord", "type": "string", "required": false, "description": "连接源名称的关键字查询,支持模糊匹配", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为1000 (超过1000,则限制为1000)", "example": "20" }, { "name": "ResourceRegion", "type": "string", "required": false, "description": "连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源)", "example": "ap-guangzhou" } ], "required": [] }, { "name": "DescribeConsumerGroup", "description": "查询消费分组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "GroupName", "type": "string", "required": false, "description": "用户需要查询的group名称。", "example": " group-test" }, { "name": "TopicName", "type": "string", "required": false, "description": "用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。", "example": " topic-test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回消费组的限制数量，最大支持50", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "消费组列表的起始偏移量", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCvmInfo", "description": "本接口用于获取实例对应后端CVM信息，包括cvmId和ip等。用于专业版，标准版返回数据为空", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDatahubGroupOffsets", "description": "获取Datahub消费分组offset", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "（过滤条件）按照实例 ID 过滤", "example": "appId-test" }, { "name": "Group", "type": "string", "required": true, "description": "Kafka 消费分组", "example": "group-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊匹配 topicName", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "本次查询的偏移位置，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "本次返回结果的最大个数，默认为50，最大值为50", "example": "10" } ], "required": [ "Name", "Group" ] }, { "name": "DescribeDatahubTask", "description": "查询Datahub任务信息", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" } ], "required": [ "TaskId" ] }, { "name": "DescribeDatahubTasks", "description": "查询Datahub任务列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100 (超过100限制为100)", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认为0", "example": "0" }, { "name": "SearchWord", "type": "string", "required": false, "description": "过滤条件，按照 TaskName 过滤，支持模糊查询", "example": "search-test" }, { "name": "TargetType", "type": "string", "required": false, "description": "转储的目标类型", "example": "KAFKA" }, { "name": "TaskType", "type": "string", "required": false, "description": "任务类型，SOURCE数据接入，SINK数据流出", "example": "SINK" }, { "name": "SourceType", "type": "string", "required": false, "description": "转储的源类型", "example": "KAFKA" }, { "name": "Resource", "type": "string", "required": false, "description": "转储的资源", "example": "resource-test" } ], "required": [] }, { "name": "DescribeDatahubTopic", "description": "获取DIP主题属性", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "弹性topic名称", "example": "appId-test" } ], "required": [ "Name" ] }, { "name": "DescribeDatahubTopics", "description": "查询DIP主题列表", "status": "online", "parameters": [ { "name": "SearchWord", "type": "string", "required": false, "description": "搜索词", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "本次查询的偏移位置，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "本次返回结果的最大个数，默认为50，最大值为50", "example": "50" }, { "name": "QueryFromConnectResource", "type": "boolean", "required": false, "description": "是否从连接查询topic列表", "example": "false" }, { "name": "ConnectResourceId", "type": "string", "required": false, "description": "连接的ID", "example": "resource-xxx" }, { "name": "TopicRegularExpression", "type": "string", "required": false, "description": "topic资源表达式", "example": ".*" } ], "required": [] }, { "name": "DescribeGroup", "description": "枚举消费分组(精简版)", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索关键字", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大返回数量默认值：20", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "仅支持 GroupState 筛选, 支持的筛选状态有 Empty/Stable 注意：该参数只能在2.8/3.2 版本生效", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "GroupState" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Empty\"]", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeGroupInfo", "description": "获取消费分组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "GroupList", "type": "array", "required": true, "description": "Kafka 消费分组列表,可通过[DescribeConsumerGroup](https://cloud.tencent.com/document/product/597/40841)接口获取", "example": "[\"group-test\"]", "item_type": "string" } ], "required": [ "InstanceId", "GroupList" ] }, { "name": "DescribeGroupOffsets", "description": "获取消费分组offset", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "Group", "type": "string", "required": true, "description": "Kafka 消费分组取值参考：DescribeGroup", "example": "group-test" }, { "name": "Topics", "type": "array", "required": false, "description": "group 订阅的主题名称数组，如果没有该数组，则表示指定的 group 下所有 topic 信息取值参考：DescribeTopic", "example": "[\"topic-test\"]", "item_type": "string" }, { "name": "SearchWord", "type": "string", "required": false, "description": "模糊匹配 topicName", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "本次查询的偏移位置，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "本次返回结果的最大个数，默认为50，最大值为50", "example": "20" } ], "required": [ "InstanceId", "Group" ] }, { "name": "DescribeInstanceAttributes", "description": "获取实例属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "本接口（DescribeInstances）用于在用户账户下获取消息队列 CKafka 实例列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "（查询条件）按照ckafka集群实例Id过滤", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "搜索词 ex:（查询条件）按照实例名称过滤，支持模糊查询", "example": "search-test" }, { "name": "Status", "type": "array", "required": false, "description": "（查询条件）实例的状态 不填默认返回全部枚举值：-1： 创建失败0： 创建中1： 运行中2： 删除中3： 已删除4： 删除失败5： 隔离中7： 升级中", "example": "[1,7]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认10，最大值100", "example": "10" }, { "name": "VpcId", "type": "string", "required": false, "description": "（查询条件）私有网络Id", "example": "vpc-test" } ], "required": [] }, { "name": "DescribeInstancesDetail", "description": "用户账户下获取实例列表详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "（过滤条件）按照实例ID过滤", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "（过滤条件）按照实例名,实例Id,可用区,私有网络id,子网id 过滤，支持模糊查询", "example": "search-test" }, { "name": "Status", "type": "array", "required": false, "description": "（过滤条件）实例的状态，不填默认返回全部枚举值：-1： 创建失败0： 创建中1： 运行中2： 删除中3： 已删除4： 删除失败5： 隔离中7： 升级中", "example": "[1,5]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认10，最大值20。", "example": "10" }, { "name": "TagKey", "type": "string", "required": false, "description": "匹配标签key值。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器。filter.Name 支持(\u0026#39;Ip\u0026#39;, \u0026#39;VpcId\u0026#39;, \u0026#39;SubNetId\u0026#39;, \u0026#39;InstanceType\u0026#39;,\u0026#39;InstanceId\u0026#39;) ,filter.Values最多传递10个值.", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "GroupState" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Empty\"]", "item_type": "string" } ] }, { "name": "InstanceIdList", "type": "array", "required": false, "description": "按照实例ID过滤", "example": "[\"ckafka-test\"]", "item_type": "string" }, { "name": "TagList", "type": "array", "required": false, "description": "根据标签列表过滤实例（取交集）", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] } ], "required": [] }, { "name": "DescribeModifyType", "description": "查询实例变配类型", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "BandWidth", "type": "integer", "required": true, "description": "升配后的带宽，单位mb", "example": "320" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "升配后的磁盘，单位G", "example": "1000" }, { "name": "DiskType", "type": "string", "required": true, "description": "磁盘类型，例如 CLOUD_PREMIUM", "example": "CLOUD_PREMIUM" }, { "name": "Partition", "type": "integer", "required": true, "description": "分区数量", "example": "1200" }, { "name": "Topic", "type": "integer", "required": true, "description": "topic数量", "example": "120" }, { "name": "Type", "type": "string", "required": true, "description": "实例类型例如 sp_ckafka_profession", "example": "sp_ckafka_profession" }, { "name": "ModifyEntry", "type": "string", "required": false, "description": "变配入口", "example": "OPEN_ELASTIC_BANDWIDTH_ENTRY" }, { "name": "ModifyZone", "type": "boolean", "required": false, "description": "是否可用区变更 false: 非可用区变更 true: 可用区变更 默认false", "example": "true" } ], "required": [ "InstanceId", "BandWidth", "DiskSize", "DiskType", "Partition", "Topic", "Type" ] }, { "name": "DescribePrometheus", "description": "获取实例Prometheus信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRegion", "description": "枚举地域信息", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大结果数", "example": "50" }, { "name": "Business", "type": "string", "required": false, "description": "业务字段，可忽略枚举值：ckafka： ckafka业务cmq： cmq业务默认值：ckafka", "example": "ckafka" }, { "name": "CdcId", "type": "string", "required": false, "description": "cdc专有集群业务字段，可忽略", "example": "cluster-test" } ], "required": [] }, { "name": "DescribeRoute", "description": "查看路由信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由Id", "example": "301" }, { "name": "MainRouteFlag", "type": "boolean", "required": false, "description": "是否显示主路由，true时会在返回原路由列表的基础上,再额外展示实例创建时的主路由信息(且不被InternalFlag/UsedFor等参数过滤影响)", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSecurityGroupRoutes", "description": "获取安全组路由信息列表", "status": "online", "parameters": [ { "name": "InstanceRoute", "type": "object", "required": false, "description": "路由信息", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "RouteId", "type": "integer", "required": true, "description": "路由Id", "example": "301" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "过滤名称,目前支持security-group-id,按安全组关联过滤", "example": "security-group-id" }, { "name": "Values", "type": "array", "required": false, "description": "过滤值,当过滤名称为security-group-id时仅支持传单个value", "example": "[\"sg-test\"]", "item_type": "string" }, { "name": "Relation", "type": "string", "required": false, "description": "过滤关系,支持IN和NOT_IN,默认为IN", "example": "IN" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Offset,默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页Limit,默认20", "example": "10" }, { "name": "SearchWord", "type": "string", "required": false, "description": "关键词,可根据实例id/实例名称/vip模糊搜索", "example": "group-test" } ], "required": [] }, { "name": "DescribeTaskStatus", "description": "查询任务状态", "status": "online", "parameters": [ { "name": "FlowId", "type": "integer", "required": true, "description": "流程Id", "example": "500201" } ], "required": [ "FlowId" ] }, { "name": "DescribeTopic", "description": "接口请求域名：https://ckafka.tencentcloudapi.com 本接口（DescribeTopic）用于在用户获取消息队列 CKafka 实例的主题列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "过滤条件，按照 topicName 过滤，支持模糊查询", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认为20，最大值为50", "example": "50" }, { "name": "AclRuleName", "type": "string", "required": false, "description": "Acl预设策略名称", "example": "rulename-test" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopicAttributes", "description": "获取主题属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取", "example": "topic-test" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "DescribeTopicDetail", "description": "获取主题列表详情（仅控制台调用）", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "（过滤条件）按照topicName过滤，支持模糊查询", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认 20，取值要大于0", "example": "10" }, { "name": "AclRuleName", "type": "string", "required": false, "description": "Acl预设策略名称", "example": "rulename-test" }, { "name": "OrderBy", "type": "string", "required": false, "description": "根据特定的属性排序(目前支持PartitionNum/CreateTime)，默认值为CreateTime。该参数为空时，默认按CreateTime倒序排序", "example": "PartitionNum/CreateTime" }, { "name": "OrderType", "type": "integer", "required": false, "description": "0-顺序、1-倒序，默认值为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "目前支持 ReplicaNum （副本数）筛选", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "GroupState" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Empty\"]", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopicFlowRanking", "description": "获取Topic流量排行，消费者流量排行", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "RankingType", "type": "string", "required": true, "description": "排行类别，PRO：Topic生产流量；CON：Topic消费流量", "example": "PRO" }, { "name": "BeginDate", "type": "string", "required": false, "description": "排行起始日期", "example": "2019-08-19T00:00:00+08:00" }, { "name": "EndDate", "type": "string", "required": false, "description": "排行结束日期", "example": "2019-08-20T00:00:00+08:00" }, { "name": "BrokerIp", "type": "string", "required": false, "description": "Broker IP 地址", "example": "10.0.0.14" } ], "required": [ "InstanceId", "RankingType" ] }, { "name": "DescribeTopicProduceConnection", "description": "查询topic 生产端连接信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名，可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。", "example": "topic-test" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "DescribeTopicSubscribeGroup", "description": "查询订阅某主题消息分组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "topic-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页时的起始位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页时的个数默认值：20", "example": "10" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "DescribeTopicSyncReplica", "description": "获取Topic 副本详情信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称取值参考：DescribeTopic", "example": "topic-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值为20，必须大于0。", "example": "10" }, { "name": "OutOfSyncReplicaOnly", "type": "boolean", "required": false, "description": "仅筛选未同步副本", "example": "true" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "DescribeTypeInstances", "description": "本接口（DescribeTypeInstances）用于在用户账户下获取指定类型消息队列 CKafka 实例列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "（过滤条件）按照实例ID过滤", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "（过滤条件）按照实例名称过滤，支持模糊查询", "example": "search-test" }, { "name": "Status", "type": "array", "required": false, "description": "（过滤条件）实例的状态，不填默认返回全部枚举值：-1： 创建失败0： 创建中1： 运行中2： 删除中3： 已删除4： 删除失败5： 隔离中7： 升级中", "example": "[0,1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不填默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，不填则默认10，最大值100", "example": "10" }, { "name": "TagKey", "type": "string", "required": false, "description": "匹配标签key值。", "example": "tagkey-test" } ], "required": [] }, { "name": "DescribeUser", "description": "查询用户信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "SearchWord", "type": "string", "required": false, "description": "按照名称过滤支持模糊匹配", "example": "search-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量默认值：20", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "FetchDatahubMessageByOffset", "description": "根据指定offset位置的消息", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "弹性topic名称，可通过[DescribeDatahubTopics](https://cloud.tencent.com/document/product/597/86863)接口获取", "example": "appId-test" }, { "name": "Partition", "type": "integer", "required": true, "description": "分区id", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "位点信息", "example": "1" } ], "required": [ "Name", "Partition", "Offset" ] }, { "name": "FetchLatestDatahubMessageList", "description": "查询最新消息列表", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "弹性topic名称", "example": "appId-test" }, { "name": "Partition", "type": "integer", "required": true, "description": "分区id", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "位点信息", "example": "1" }, { "name": "MessageCount", "type": "integer", "required": false, "description": "最大查询条数，最小1，最大100", "example": "20" } ], "required": [ "Name", "Partition" ] }, { "name": "FetchMessageByOffset", "description": "根据指定offset位置的消息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id，可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名，可通过DescribeTopic接口获取", "example": "topic-test" }, { "name": "Partition", "type": "integer", "required": true, "description": "分区id", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "位点信息", "example": "0" } ], "required": [ "InstanceId", "Topic", "Partition", "Offset" ] }, { "name": "FetchMessageListByOffset", "description": "根据位点查询消息列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名", "example": "topic-test" }, { "name": "Partition", "type": "integer", "required": true, "description": "分区id", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "位点信息", "example": "0" }, { "name": "SinglePartitionRecordNumber", "type": "integer", "required": false, "description": "最大查询条数，默认20，最大20", "example": "20" } ], "required": [ "InstanceId", "Topic", "Partition", "Offset" ] }, { "name": "FetchMessageListByTimestamp", "description": "根据时间戳查询消息列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Topic", "type": "string", "required": true, "description": "主题名", "example": "topic-test" }, { "name": "Partition", "type": "integer", "required": false, "description": "分区id", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "查询开始时间，13位时间戳", "example": "1577808000000" }, { "name": "SinglePartitionRecordNumber", "type": "integer", "required": false, "description": "最大查询条数，默认20，最大20, 最小1", "example": "20" } ], "required": [ "InstanceId", "Topic" ] }, { "name": "InquireCkafkaPrice", "description": "Ckafka实例购买/续费询价", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "国内站标准版填写standards2, 国际站标准版填写standard,专业版填写profession,高级版填写premium", "example": "profession" }, { "name": "InstanceChargeParam", "type": "object", "required": false, "description": "购买/续费付费类型(购买时不填的话, 默认获取购买包年包月一个月的费用)", "example": "无", "children": [ { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例付费类型: PREPAID(包年包月), POSTPAID_BY_HOUR(按量付费)", "example": "PREPAID" }, { "name": "InstanceChargePeriod", "type": "integer", "required": false, "description": "购买时长: 包年包月时需要填写, 按量计费无需填写", "example": "1" } ] }, { "name": "InstanceNum", "type": "integer", "required": false, "description": "购买/续费时购买的实例数量(不填时, 默认为1个)", "example": "1" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "实例内网带宽大小, 单位MB/s (购买时必填，专业版/高级版询价时带宽信息必填)", "example": "40" }, { "name": "InquiryDiskParam", "type": "object", "required": false, "description": "实例的硬盘购买类型以及大小 (购买时必填，专业版/高级版询价时磁盘信息必填)", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "购买硬盘类型: SSD(SSD), CLOUD_SSD(SSD云硬盘), CLOUD_PREMIUM(高性能云硬盘), CLOUD_BASIC(云盘)", "example": "SSD" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "购买硬盘大小: 单位GB", "example": "400" } ] }, { "name": "MessageRetention", "type": "integer", "required": false, "description": "实例消息保留时间大小, 单位小时 (购买时必填)", "example": "1" }, { "name": "Topic", "type": "integer", "required": false, "description": "购买实例topic数, 单位个 (购买时必填)", "example": "40" }, { "name": "Partition", "type": "integer", "required": false, "description": "购买实例分区数, 单位个 (购买时必填，专业版/高级版询价时带宽信息必填) 分区上限 最大值: 40000,步长: 100 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563", "example": "400" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "购买地域, 可通过查看DescribeCkafkaZone这个接口获取ZoneId", "example": "[100001]", "item_type": "integer" }, { "name": "CategoryAction", "type": "string", "required": false, "description": "标记操作, 新购填写purchase, 续费填写renew, (不填时, 默认为purchase)", "example": "purchase" }, { "name": "BillType", "type": "string", "required": false, "description": "国内站购买的版本, sv_ckafka_instance_s2_1(入门型), sv_ckafka_instance_s2_2(标准版), sv_ckafka_instance_s2_3(进阶型), 如果instanceType为standards2, 但该参数为空, 则默认值为sv_ckafka_instance_s2_1", "example": "sv_ckafka_instance_s2_1" }, { "name": "PublicNetworkParam", "type": "object", "required": false, "description": "公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填),取值为3的倍数", "example": "无", "children": [ { "name": "PublicNetworkChargeType", "type": "string", "required": false, "description": "公网计费模式: BANDWIDTH_PREPAID(包年包月), BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时计费)", "example": "BANDWIDTH_PREPAID" }, { "name": "PublicNetworkMonthly", "type": "integer", "required": false, "description": "公网带宽, 单位MB 取值需是0，或是3的倍数", "example": "0" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "续费时的实例id, 续费时填写", "example": "ckafka-test" } ], "required": [ "InstanceType" ] }, { "name": "InstanceScalingDown", "description": "按量实例缩容", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "UpgradeStrategy", "type": "integer", "required": true, "description": "缩容模式 1:稳定变配 2.高速变配", "example": "1" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "磁盘大小 单位 GB 最大值为500000,步长100 可以通过以下链接查看规格限制：https://cloud.tencent.com/document/product/597/122562", "example": "800" }, { "name": "BandWidth", "type": "integer", "required": false, "description": "峰值带宽 单位 MB/s 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745", "example": "60" }, { "name": "Partition", "type": "integer", "required": false, "description": "分区上限 最大值: 40000, 步长: 100 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563", "example": "400" } ], "required": [ "InstanceId", "UpgradeStrategy" ] }, { "name": "ModifyAclRule", "description": "修改ACL策略，目前只支持预设规则的是否应用到新增topic这一项的修改", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "RuleName", "type": "string", "required": true, "description": "ACL规则名", "example": "rulename-test" }, { "name": "IsApplied", "type": "integer", "required": false, "description": "修改预设规则时传入,是否应用到新增的Topic枚举值：0： 不允许应用到新增的topic1： 允许应用到新增的topic默认值：0", "example": "1" } ], "required": [ "InstanceId", "RuleName" ] }, { "name": "ModifyConnectResource", "description": "编辑Datahub连接源", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "连接源的Id", "example": "resource-test" }, { "name": "ResourceName", "type": "string", "required": false, "description": "连接源名称，为空时不修改", "example": "resource-test" }, { "name": "Description", "type": "string", "required": false, "description": "连接源描述，为空时不修改", "example": "description-test" }, { "name": "Type", "type": "string", "required": false, "description": "连接源类型，修改数据源参数时，需要与原Type相同，否则编辑数据源无效", "example": "KAFKA" }, { "name": "DtsConnectParam", "type": "object", "required": false, "description": "Dts配置，Type为DTS时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"GroupId\":\"group-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"Topic\":\"topic-test\"}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Dts实例Id【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "Dts的连接port【不支持修改】", "example": "8080" }, { "name": "GroupId", "type": "string", "required": false, "description": "Dts消费分组的Id", "example": "group-test" }, { "name": "UserName", "type": "string", "required": false, "description": "Dts消费分组的账号", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Dts消费分组的密码", "example": "password-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务，默认为true", "example": "true" }, { "name": "Topic", "type": "string", "required": false, "description": "Dts订阅的topic【不支持修改】", "example": "topic-test" } ] }, { "name": "MongoDBConnectParam", "type": "object", "required": false, "description": "MongoDB配置，Type为MONGODB时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "MongoDB连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "MongoDB的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MongoDB连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MongoDB连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "MongoDB连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MongoDB连接源的密码", "example": "password-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "MongoDB连接源是否为自建集群【不支持修改】", "example": "false" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "EsConnectParam", "type": "object", "required": false, "description": "Es配置，Type为ES时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Es连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "Es的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "Es连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "Es连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "Es连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Es连接源的密码", "example": "password-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "Es连接源是否为自建集群【不支持修改】", "example": "false" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "ClickHouseConnectParam", "type": "object", "required": false, "description": "ClickHouse配置，Type为CLICKHOUSE时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"SelfBuilt\":false,\"IsUpdate\":true}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "ClickHouse连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "ClickHouse的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "ClickHouse连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "ClickHouse连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "ClickHouse连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "ClickHouse连接源的密码", "example": "password-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "ClickHouse连接源是否为自建集群【不支持修改】", "example": "false" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务，默认为true", "example": "true" } ] }, { "name": "MySQLConnectParam", "type": "object", "required": false, "description": "MySQL配置，Type为MYSQL或TDSQL_C_MYSQL时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"ClusterId\":\"cynosdbmysql-test\",\"SelfBuilt\":false}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "MySQL连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "MySQL的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MySQL连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MySQL连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "MySQL连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MySQL连接源的密码", "example": "password-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" }, { "name": "ClusterId", "type": "string", "required": false, "description": "当type为TDSQL_C_MYSQL时", "example": "cynosdbmysql-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否是自建的集群", "example": "false" } ] }, { "name": "PostgreSQLConnectParam", "type": "object", "required": false, "description": "PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"ClusterId\":\"tdcpg-test\",\"IsUpdate\":true,\"SelfBuilt\":false}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "PostgreSQL连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "PostgreSQL的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "PostgreSQL连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "PostgreSQL连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "PostgreSQL连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "PostgreSQL连接源的密码", "example": "password-test" }, { "name": "ClusterId", "type": "string", "required": false, "description": "当type为TDSQL_C_POSTGRESQL时，该参数才有值【不支持修改】", "example": "tdcpg-xxx" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "false" } ] }, { "name": "MariaDBConnectParam", "type": "object", "required": false, "description": "MariaDB配置，Type为MARIADB时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "MariaDB连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "MariaDB的连接port【不支持修改】", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "MariaDB连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "MariaDB连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "MariaDB连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "MariaDB连接源的密码", "example": "password-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" } ] }, { "name": "SQLServerConnectParam", "type": "object", "required": false, "description": "SQLServer配置，Type为SQLSERVER时必填", "example": "{\"Resource\":\"resource-test\",\"Port\":1433,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "SQLServer连接源的实例资源【不支持修改】", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "SQLServer的连接port【不支持修改】", "example": "1433" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "SQLServer连接源的实例vip【不支持修改】", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "SQLServer连接源的vpcId【不支持修改】", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "SQLServer连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "SQLServer连接源的密码", "example": "password-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务", "example": "true" } ] }, { "name": "CtsdbConnectParam", "type": "object", "required": false, "description": "Ctsdb配置，Type为CTSDB", "example": "{\"Port\":8080,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"Resource\":\"resource-test\"}", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "Ctsdb的连接port", "example": "8080" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "Ctsdb连接源的实例vip", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "Ctsdb连接源的vpcId", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "Ctsdb连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Ctsdb连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": false, "description": "Ctsdb连接源的实例资源", "example": "resource-test" } ] }, { "name": "DorisConnectParam", "type": "object", "required": false, "description": "Doris配置，Type为DORIS", "example": "{\"Resource\":\"resource-test\",\"Port\":9030,\"ServiceVip\":\"10.0.0.31\",\"UniqVpcId\":\"vpc-test\",\"UserName\":\"username-test\",\"Password\":\"password-test\",\"IsUpdate\":true,\"SelfBuilt\":false,\"BePort\":8040}", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "Doris 连接源的实例资源", "example": "resource-test" }, { "name": "Port", "type": "integer", "required": false, "description": "Doris jdbc 负载均衡连接 port，通常映射到 fe 的 9030 端口", "example": "9030" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "Doris 连接源的实例vip，当为腾讯云实例时，必填", "example": "10.0.0.31" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "Doris 连接源的vpcId，当为腾讯云实例时，必填", "example": "vpc-test" }, { "name": "UserName", "type": "string", "required": false, "description": "Doris 连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": false, "description": "Doris 连接源的密码", "example": "password-test" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Datahub任务", "example": "true" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "Doris 连接源是否为自建集群", "example": "false" }, { "name": "BePort", "type": "integer", "required": false, "description": "Doris 的 http 负载均衡连接 port，通常映射到 be 的 8040 端口", "example": "8040" } ] }, { "name": "KafkaConnectParam", "type": "object", "required": false, "description": "Kafka配置，Type为 KAFKA 时必填", "example": "{\"Resource\":\"ckafka-test\",\"SelfBuilt\":true,\"IsUpdate\":true,\"BrokerAddress\":\"10.0.0.30:9092,10.0.0.31:9092\",\"Region\":\"ap-guangzhou\"}", "children": [ { "name": "Resource", "type": "string", "required": false, "description": "Kafka连接源的实例资源, 非自建时必填，NetworkType=VPC时传clb实例id", "example": "ckafka-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "true" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "BrokerAddress", "type": "string", "required": false, "description": "Kafka连接的broker地址, NetworkType=PUBLIC公网时必填", "example": "10.0.0.30:9092,10.0.0.31:9092" }, { "name": "Region", "type": "string", "required": false, "description": "CKafka连接源的实例资源地域, 跨地域时必填", "example": "ap-guangzhou" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型：PUBLIC公网；VPC", "example": "PUBLIC" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpcId，NetworkType=VPC时必传", "example": "vpc-test" }, { "name": "ServiceVip", "type": "string", "required": false, "description": "vip，NetworkType=VPC时必传", "example": "10.0.0.5" }, { "name": "Port", "type": "integer", "required": false, "description": "端口，NetworkType=VPC时必传", "example": "9092" }, { "name": "CrossNetResourceUniqueId", "type": "string", "required": false, "description": "跨云同步下需要客户传递唯一Id标志一组资源", "example": "id-test" }, { "name": "CrossNetVpcSubNetId", "type": "string", "required": false, "description": "跨云子网ID", "example": "subnet-test" } ] }, { "name": "MqttConnectParam", "type": "object", "required": false, "description": "MQTT配置，Type为 MQTT 时必填", "example": "{\"UserName\":\"username-test\",\"Password\":\"password-test\",\"Resource\":\"resource-test\",\"UniqVpcId\":\"vpc-test\",\"SelfBuilt\":true,\"IsUpdate\":true,\"Region\":\"ap-guangzhou\"}", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "MQTT的连接port", "example": "9092" }, { "name": "UserName", "type": "string", "required": true, "description": "MQTT连接源的用户名", "example": "username-test" }, { "name": "Password", "type": "string", "required": true, "description": "MQTT连接源的密码", "example": "password-test" }, { "name": "Resource", "type": "string", "required": true, "description": "MQTT连接源的实例资源", "example": "resource-test" }, { "name": "ServiceVip", "type": "string", "required": true, "description": "MQTT的连接ip", "example": "10.0.0.30" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "MQTT Instance vpc-id", "example": "vpc-test" }, { "name": "SelfBuilt", "type": "boolean", "required": false, "description": "是否为自建集群", "example": "true" }, { "name": "IsUpdate", "type": "boolean", "required": false, "description": "是否更新到关联的Dip任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "Region", "type": "string", "required": false, "description": "MQTT连接源的实例资源地域, 跨地域时必填", "example": "ap-guangzhou" }, { "name": "Ip", "type": "string", "required": false, "description": "IP", "example": "10.0.0.30" } ] } ], "required": [ "ResourceId" ] }, { "name": "ModifyDatahubTask", "description": "修改Datahub任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称", "example": "task-name" }, { "name": "Description", "type": "string", "required": false, "description": "任务描述信息", "example": "任务描述信息" } ], "required": [ "TaskId" ] }, { "name": "ModifyDatahubTopic", "description": "修改DIP主题属性", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "弹性topic名称", "example": "appId-test" }, { "name": "RetentionMs", "type": "integer", "required": true, "description": "消息保留时间，单位：ms，当前最小值为60000ms。", "example": "360000" }, { "name": "Note", "type": "string", "required": false, "description": "主题备注，是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线-。", "example": "note-test" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] } ], "required": [ "Name", "RetentionMs" ] }, { "name": "ModifyGroupOffsets", "description": "设置Groups 消费分组offset", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "Group", "type": "string", "required": true, "description": "消费分组名称,可通过[DescribeConsumerGroup](https://cloud.tencent.com/document/product/597/40841)接口获取", "example": "group-test" }, { "name": "Strategy", "type": "integer", "required": true, "description": "重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置", "example": "1" }, { "name": "Topics", "type": "array", "required": true, "description": "需要重置的主题名列表", "example": "[\"topic-test\"]", "item_type": "string" }, { "name": "Shift", "type": "integer", "required": false, "description": "当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest", "example": "10" }, { "name": "ShiftTimestamp", "type": "integer", "required": false, "description": "单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的是，如果指定的时间不存在消息，则获取最末尾的offset。", "example": "13589015901000" }, { "name": "Offset", "type": "integer", "required": false, "description": "需要重新设置的offset位置。当strategy为2，必须包含该字段。", "example": "100" }, { "name": "Partitions", "type": "array", "required": false, "description": "需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。", "example": "[0]", "item_type": "integer" } ], "required": [ "InstanceId", "Group", "Strategy", "Topics" ] }, { "name": "ModifyInstanceAttributes", "description": "设置实例属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "MsgRetentionTime", "type": "integer", "required": false, "description": "实例日志的最长保留时间，单位分钟，最大90天，最小为1min", "example": "10" }, { "name": "InstanceName", "type": "string", "required": false, "description": "ckafka集群实例Name", "example": "ckafka测试" }, { "name": "Config", "type": "object", "required": false, "description": "实例配置", "example": "无", "children": [ { "name": "AutoCreateTopicEnable", "type": "boolean", "required": false, "description": "自动创建 true 表示开启，false 表示不开启", "example": "true" }, { "name": "DefaultNumPartitions", "type": "integer", "required": false, "description": "新创建主题的默认分区数,如果AutoCreateTopicEnable设置为true没有设置该值时，默认设置为3", "example": "3" }, { "name": "DefaultReplicationFactor", "type": "integer", "required": false, "description": "新创建主题的默认副本数,如果AutoCreateTopicEnable设置为true没有指定该值时默认设置为2", "example": "2" } ] }, { "name": "DynamicRetentionConfig", "type": "object", "required": false, "description": "动态消息保留策略配置", "example": "无", "children": [ { "name": "Enable", "type": "integer", "required": false, "description": "动态消息保留时间配置开关（0: 关闭，1: 开启） 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskQuotaPercentage", "type": "integer", "required": false, "description": "磁盘配额百分比触发条件，即消息达到此值触发消息保留时间变更事件 注意：此字段可能返回 null，表示取不到有效值。", "example": "75" }, { "name": "StepForwardPercentage", "type": "integer", "required": false, "description": "每次向前调整消息保留时间百分比 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "BottomRetention", "type": "integer", "required": false, "description": "保底时长，单位分钟 注意：此字段可能返回 null，表示取不到有效值。", "example": "360" } ] }, { "name": "RebalanceTime", "type": "integer", "required": false, "description": "用于修改升级版本或升配定时任务的执行时间，Unix时间戳，精确到秒", "example": "1566144000" }, { "name": "PublicNetwork", "type": "integer", "required": false, "description": "公网带宽 最小3Mbps 最大999Mbps 仅专业版支持填写", "example": "3" }, { "name": "MaxMessageByte", "type": "integer", "required": false, "description": "实例级别单条消息大小（单位byte) 最大 12582912(不包含) 最小1024(不包含)", "example": "8388680" }, { "name": "UncleanLeaderElectionEnable", "type": "integer", "required": false, "description": "是否允许未同步的副本选为 leader: 1 开启 0 关闭", "example": "1" }, { "name": "DeleteProtectionEnable", "type": "integer", "required": false, "description": "实例删除保护开关: 1 开启 0 关闭", "example": "1" }, { "name": "RetentionBytes", "type": "integer", "required": false, "description": "实例级别消息保留大小单位：byte默认值：-1实例级别消息保留大小", "example": "1073741824" }, { "name": "AdminSecurity", "type": "boolean", "required": false, "description": "是否封禁高风险admin接口; true则封禁高风险adminApi; 关闭后不支持打开,仅专业版支持; 默认是false 对高风险admin接口不做处理", "example": "true" }, { "name": "TransactionalIdExpirationMs", "type": "integer", "required": false, "description": "事务ID最大空闲时间，超时未提交的事务将被标记为过期取值范围：[3600000, 604800000]单位：ms", "example": "604800000" } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstancePre", "description": "预付费实例变配接口，调整磁盘，带宽, 分区", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "磁盘大小 单位 GB 最大值为500000,步长100可以通过以下链接查看规格限制：https://cloud.tencent.com/document/product/597/122562", "example": "800" }, { "name": "BandWidth", "type": "integer", "required": false, "description": "峰值带宽 单位 MB/s可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745", "example": "20" }, { "name": "Partition", "type": "integer", "required": false, "description": "分区上限 最大值: 40000, 步长: 100可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563", "example": "400" } ], "required": [ "InstanceId" ] }, { "name": "ModifyPassword", "description": "修改密码", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "Name", "type": "string", "required": true, "description": "用户名称，可通过[DescribeUser](https://cloud.tencent.com/document/product/597/40855)接口获取。", "example": "name-test" }, { "name": "Password", "type": "string", "required": true, "description": "用户当前密码", "example": "password-test" }, { "name": "PasswordNew", "type": "string", "required": true, "description": "用户新密码", "example": "password-new-test" } ], "required": [ "InstanceId", "Name", "Password", "PasswordNew" ] }, { "name": "ModifyRoutineMaintenanceTask", "description": "设置自动化运维属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取", "example": "ckafka-test" }, { "name": "MaintenanceType", "type": "string", "required": true, "description": "自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH", "example": "QUOTA" }, { "name": "MaintenanceSubtype", "type": "string", "required": true, "description": "INSTANCE_STORAGE_CAPACITY(磁盘自动扩容)/MESSAGE_RETENTION_PERIOD(磁盘动态消息保留策略)", "example": "INSTANCE_STORAGE_CAPACITY" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名", "example": "topic-test" }, { "name": "ConfigureThreshold", "type": "integer", "required": false, "description": "任务触发阈值", "example": "60" }, { "name": "ConfigureStepSize", "type": "integer", "required": false, "description": "任务调整步长", "example": "30" }, { "name": "ConfigureLimit", "type": "integer", "required": false, "description": "任务调整上限", "example": "70" }, { "name": "PlannedTime", "type": "integer", "required": false, "description": "任务预期触发时间，存储从当日 0AM 开始偏移的秒数", "example": "9600" }, { "name": "ExtraConfig", "type": "string", "required": false, "description": "任务额外信息", "example": "{\"key\":\"value\"}" }, { "name": "Status", "type": "integer", "required": false, "description": "任务状态,0 开启,1 关闭", "example": "1" }, { "name": "Week", "type": "string", "required": false, "description": "执行week day", "example": "1,2,3,4,5,6,7" } ], "required": [ "InstanceId", "MaintenanceType", "MaintenanceSubtype" ] }, { "name": "ModifyTopicAttributes", "description": "本接口用于修改主题属性。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id取值参考：DescribeInstances", "example": "ckafka-test" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "topic-test" }, { "name": "Note", "type": "string", "required": false, "description": "主题备注入参限制：不超过64个字符默认值：\u0026quot;\u0026quot;", "example": "note-test" }, { "name": "EnableWhiteList", "type": "integer", "required": false, "description": "IP 白名单开关，1：打开；0：关闭。", "example": "0" }, { "name": "MinInsyncReplicas", "type": "integer", "required": false, "description": "最小同步副本数默认值：1最小值为1", "example": "1" }, { "name": "UncleanLeaderElectionEnable", "type": "integer", "required": false, "description": "是否允许未同步的副本选为leader枚举值：0： 不允许1： 允许默认值：0", "example": "0" }, { "name": "RetentionMs", "type": "integer", "required": false, "description": "Segment分片滚动的时长单位：毫秒默认值：86400000最小值为86400000ms（1天）", "example": "60000" }, { "name": "MaxMessageBytes", "type": "integer", "required": false, "description": "主题消息最大值取值范围：[1024, 12582912]单位：Bytes", "example": "1048576" }, { "name": "SegmentMs", "type": "integer", "required": false, "description": "Segment 分片滚动的时长单位：毫秒最小值为86400000ms（1天）", "example": "86400000" }, { "name": "CleanUpPolicy", "type": "string", "required": false, "description": "消息删除策略，可以选择delete 或者compact", "example": "delete" }, { "name": "IpWhiteList", "type": "array", "required": false, "description": "Ip白名单列表，配额限制，enableWhileList=1时必选", "example": "[\"10.0.0.5\",\"10.0.0.6\"]", "item_type": "string" }, { "name": "EnableAclRule", "type": "integer", "required": false, "description": "预设ACL规则, 1:打开 0:关闭，默认不打开", "example": "0" }, { "name": "AclRuleName", "type": "string", "required": false, "description": "ACL规则名", "example": "rulename-test" }, { "name": "RetentionBytes", "type": "integer", "required": false, "description": "可选, 保留文件大小取值范围：[1073741824, 1099511627776]单位：Bytes默认值：-1特殊值：-1表示无限制", "example": "-1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的key", "example": "tagkey-test" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "tagvalue-test" } ] }, { "name": "QuotaProducerByteRate", "type": "integer", "required": false, "description": "生产限流，单位 MB/s；设置为-1，则生产不限流", "example": "30" }, { "name": "QuotaConsumerByteRate", "type": "integer", "required": false, "description": "消费限流，单位 MB/s；设置为-1，则消费不限流", "example": "30" }, { "name": "ReplicaNum", "type": "integer", "required": false, "description": "topic副本数 最小值 1,最大值 3", "example": "2" }, { "name": "LogMsgTimestampType", "type": "string", "required": false, "description": "消息保存的时间类型：CreateTime/LogAppendTime", "example": "LogAppendTime" } ], "required": [ "InstanceId", "TopicName" ] }, { "name": "PauseDatahubTask", "description": "暂停Dip任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" } ], "required": [ "TaskId" ] }, { "name": "RenewCkafkaInstance", "description": "续费Ckafka实例, 目前只支持国内站包年包月实例续费", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id,可通过DescribeInstances接口获取", "example": "ckafka-test" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "续费时长, 默认为1, 单位是月", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "RestartDatahubTask", "description": "Datahub任务异常时，重启Datahub任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" } ], "required": [ "TaskId" ] }, { "name": "ResumeDatahubTask", "description": "恢复Dip任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "task-test" } ], "required": [ "TaskId" ] }, { "name": "SendMessage", "description": "通过HTTP接入层发送消息", "status": "online", "parameters": [ { "name": "DataHubId", "type": "string", "required": true, "description": "DataHub接入ID", "example": "datahubId" }, { "name": "Message", "type": "array", "required": true, "description": "发送消息内容(单次请求最多500条)", "example": "无", "item_type": "object", "children": [ { "name": "Body", "type": "string", "required": true, "description": "发送的消息体", "example": "body-test" }, { "name": "Key", "type": "string", "required": false, "description": "发送消息的键名", "example": "key-test" } ] } ], "required": [ "DataHubId", "Message" ] }, { "name": "UpgradeBrokerVersion", "description": "broker版本升级", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "ckafka集群实例Id", "example": "ckafka-test" }, { "name": "Type", "type": "integer", "required": true, "description": "1.平滑升配.2.垂直升配", "example": "1" }, { "name": "SourceVersion", "type": "string", "required": true, "description": "版本号", "example": "v2.8.1_r1.1.7" }, { "name": "TargetVersion", "type": "string", "required": true, "description": "版本号", "example": "v2.8.1_r1.1.8" }, { "name": "DelayTimeStamp", "type": "string", "required": false, "description": "延迟时间", "example": "2020-08-21 11:15:54" } ], "required": [ "InstanceId", "Type", "SourceVersion", "TargetVersion" ] } ] }