{ "name": "dlc", "display_name": "数据湖计算 DLC", "description": "介绍如何通过API接口创/删数据库及表，提交SQL作业分析数据等", "domain": "database", "api_version": "2021-01-25", "endpoint": "dlc.tencentcloudapi.com", "actions": [ { "name": "AddDMSPartitions", "description": "DMS元数据新增分区", "status": "online", "parameters": [ { "name": "Partitions", "type": "array", "required": false, "description": "分区", "example": "无", "item_type": "object", "children": [ { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "11" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据目录名称", "example": "schema1" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "table1" }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "分区名称", "example": "partition1" }, { "name": "Values", "type": "array", "required": false, "description": "值列表", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-05-08 16:43:16" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-05-08 16:43:16" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-05-08 16:43:16" }, { "name": "Params", "type": "array", "required": false, "description": "附件属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ] } ], "required": [] }, { "name": "AddOptimizerEngines", "description": "添加数据优化资源", "status": "online", "parameters": [ { "name": "Catalog", "type": "string", "required": true, "description": "数据目录名称", "example": "DataLakeCatalog" }, { "name": "Engines", "type": "array", "required": true, "description": "引擎信息列表", "example": "无", "item_type": "object", "children": [ { "name": "HouseName", "type": "string", "required": true, "description": "引擎资源名称", "example": "test_engine" }, { "name": "HouseId", "type": "string", "required": true, "description": "引擎资源ID", "example": "DataEngine-123456" }, { "name": "HouseSize", "type": "integer", "required": false, "description": "该参数仅针对spark作业引擎有效，用于执行数据优化任务的资源大小，不填时将采用该引擎所有资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "36" } ] }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "test_db" }, { "name": "Table", "type": "string", "required": false, "description": "数据表名称", "example": "test_tb" } ], "required": [ "Catalog", "Engines" ] }, { "name": "AddUsersToWorkGroup", "description": "添加用户到工作组", "status": "online", "parameters": [ { "name": "AddInfo", "type": "object", "required": true, "description": "要操作的工作组和用户信息", "example": "无", "children": [ { "name": "WorkGroupId", "type": "integer", "required": true, "description": "工作组Id", "example": "1" }, { "name": "UserIds", "type": "array", "required": true, "description": "用户Id集合，和CAM侧Uin匹配", "example": "[\"12345678\"]", "item_type": "string" } ] } ], "required": [ "AddInfo" ] }, { "name": "AlterDMSDatabase", "description": "DMS元数据更新库", "status": "online", "parameters": [ { "name": "CurrentName", "type": "string", "required": false, "description": "当前名称", "example": "anme" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "DataLakeCatalog" }, { "name": "Location", "type": "string", "required": false, "description": "路径", "example": "cosn://aaa" }, { "name": "Asset", "type": "object", "required": false, "description": "基础对象", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "Guid", "type": "string", "required": false, "description": "对象GUID值 注意：此字段可能返回 null，表示取不到有效值。", "example": "xxxx-xxxx-xxx-xxx" }, { "name": "Catalog", "type": "string", "required": false, "description": "数据目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "DataLakeCatalog" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "desc" }, { "name": "Owner", "type": "string", "required": false, "description": "对象owner", "example": "root" }, { "name": "OwnerAccount", "type": "string", "required": false, "description": "对象owner账户", "example": "root" }, { "name": "PermValues", "type": "array", "required": false, "description": "权限", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "附加业务属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-01-01 12:12:12" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-01-01 12:12:12" }, { "name": "DatasourceId", "type": "integer", "required": false, "description": "数据源主键", "example": "1" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "AlterDMSPartition", "description": "DMS元数据更新分区", "status": "online", "parameters": [ { "name": "CurrentDbName", "type": "string", "required": true, "description": "当前名称，变更前db名称", "example": "db1" }, { "name": "CurrentTableName", "type": "string", "required": true, "description": "当前名称，变更前table名称", "example": "tbl1" }, { "name": "CurrentValues", "type": "string", "required": true, "description": "当前名称，变更前Part名称", "example": "[\"part1\", \"part2\"]" }, { "name": "Partition", "type": "object", "required": false, "description": "分区", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "11" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据目录名称", "example": "schema1" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "table1" }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "分区名称", "example": "partition1" }, { "name": "Values", "type": "array", "required": false, "description": "值列表", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-05-08 16:43:16" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-05-08 16:43:16" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-05-08 16:43:16" }, { "name": "Params", "type": "array", "required": false, "description": "附件属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [ "CurrentDbName", "CurrentTableName", "CurrentValues" ] }, { "name": "AlterDMSTable", "description": "DMS元数据更新表", "status": "online", "parameters": [ { "name": "CurrentName", "type": "string", "required": true, "description": "当前名称", "example": "name1" }, { "name": "CurrentDbName", "type": "string", "required": true, "description": "当前数据库名称", "example": "db1" }, { "name": "Asset", "type": "object", "required": false, "description": "基础对象", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "Guid", "type": "string", "required": false, "description": "对象GUID值 注意：此字段可能返回 null，表示取不到有效值。", "example": "xxxx-xxxx-xxx-xxx" }, { "name": "Catalog", "type": "string", "required": false, "description": "数据目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "DataLakeCatalog" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "desc" }, { "name": "Owner", "type": "string", "required": false, "description": "对象owner", "example": "root" }, { "name": "OwnerAccount", "type": "string", "required": false, "description": "对象owner账户", "example": "root" }, { "name": "PermValues", "type": "array", "required": false, "description": "权限", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "附加业务属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-01-01 12:12:12" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-01-01 12:12:12" }, { "name": "DatasourceId", "type": "integer", "required": false, "description": "数据源主键", "example": "1" } ] }, { "name": "Type", "type": "string", "required": false, "description": "表类型", "example": "EXTERNAL" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "LifeTime", "type": "integer", "required": false, "description": "生命周期", "example": "10" }, { "name": "DataUpdateTime", "type": "string", "required": false, "description": "数据更新时间", "example": "2021-01-01 12:12:12" }, { "name": "StructUpdateTime", "type": "string", "required": false, "description": "结构更新时间", "example": "2021-01-01 12:12:12" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-01-01 12:12:12" }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "Columns", "type": "array", "required": false, "description": "列", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "PartitionKeys", "type": "array", "required": false, "description": "分区键值", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "ViewOriginalText", "type": "string", "required": false, "description": "视图文本", "example": "select 1" }, { "name": "ViewExpandedText", "type": "string", "required": false, "description": "视图文本", "example": "select 1" }, { "name": "Partitions", "type": "array", "required": false, "description": "分区", "example": "无", "item_type": "object", "children": [ { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "11" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据目录名称", "example": "schema1" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "table1" }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "分区名称", "example": "partition1" }, { "name": "Values", "type": "array", "required": false, "description": "值列表", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-05-08 16:43:16" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-05-08 16:43:16" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-05-08 16:43:16" }, { "name": "Params", "type": "array", "required": false, "description": "附件属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ] }, { "name": "Name", "type": "string", "required": false, "description": "当前表名", "example": "table1" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [ "CurrentName", "CurrentDbName" ] }, { "name": "AssignMangedTableProperties", "description": "分配原生表表属性", "status": "online", "parameters": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "表基本信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略" } ] } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] }, { "name": "Columns", "type": "array", "required": true, "description": "表字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "column1" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "test comment" }, { "name": "Default", "type": "string", "required": false, "description": "字段默认值", "example": "ddefault value" }, { "name": "NotNull", "type": "boolean", "required": false, "description": "字段是否是非空", "example": "true" }, { "name": "Precision", "type": "integer", "required": false, "description": "表示整个 numeric 的长度,取值1-38", "example": "10" }, { "name": "Scale", "type": "integer", "required": false, "description": "表示小数部分的长度 Scale小于Precision", "example": "2" }, { "name": "Position", "type": "integer", "required": false, "description": "字段位置，小的在前", "example": "1" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否为分区字段", "example": "false" } ] }, { "name": "Partitions", "type": "array", "required": false, "description": "表分区信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "patition1" }, { "name": "Type", "type": "string", "required": false, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "default comment" }, { "name": "PartitionType", "type": "string", "required": false, "description": "分区类型（已废弃）", "example": "string" }, { "name": "PartitionFormat", "type": "string", "required": false, "description": "分区格式（已废弃）", "example": "bucket" }, { "name": "PartitionDot", "type": "integer", "required": false, "description": "分区分隔数（已废弃）", "example": "2" }, { "name": "Transform", "type": "string", "required": false, "description": "分区转换策略", "example": "bucket" }, { "name": "TransformArgs", "type": "array", "required": false, "description": "策略参数", "example": "2", "item_type": "string" } ] }, { "name": "Properties", "type": "array", "required": false, "description": "表属性信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性key名称。", "example": "owner" }, { "name": "Value", "type": "string", "required": true, "description": "属性key对应的value。", "example": "create by zhangsan" } ] }, { "name": "UpsertKeys", "type": "array", "required": false, "description": "V2 upsert表 upsert键", "example": "[\"col1\",col2\"\"]", "item_type": "string" } ], "required": [ "TableBaseInfo", "Columns" ] }, { "name": "AssociateDatasourceHouse", "description": "绑定数据源和队列", "status": "online", "parameters": [ { "name": "DatasourceConnectionName", "type": "string", "required": true, "description": "网络配置名称", "example": "test" }, { "name": "DatasourceConnectionType", "type": "string", "required": true, "description": "数据源类型", "example": "无" }, { "name": "DatasourceConnectionConfig", "type": "object", "required": true, "description": "数据源网络配置", "example": "无", "children": [ { "name": "Mysql", "type": "object", "required": false, "description": "Mysql数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "JdbcUrl", "type": "string", "required": true, "description": "连接mysql的jdbc url", "example": "jdbc:mysql://ip:port" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "root" }, { "name": "Password", "type": "string", "required": true, "description": "mysql密码", "example": "******" }, { "name": "Location", "type": "object", "required": true, "description": "mysql数据源的网络信息", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "MetaDb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdb-xxxxx" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据库实例名称，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "mySql" } ] }, { "name": "Hive", "type": "object", "required": false, "description": "Hive数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MetaStoreUrl", "type": "string", "required": true, "description": "hive metastore的地址", "example": "thrift://127.0.0.1:9083" }, { "name": "Type", "type": "string", "required": true, "description": "hive数据源类型，代表数据储存的位置，COS或者HDFS", "example": "COS" }, { "name": "Location", "type": "object", "required": true, "description": "数据源所在的私有网络信息", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "User", "type": "string", "required": false, "description": "如果类型为HDFS，需要传一个用户名", "example": "hadoop" }, { "name": "HighAvailability", "type": "boolean", "required": false, "description": "如果类型为HDFS，需要选择是否高可用", "example": "false" }, { "name": "BucketUrl", "type": "string", "required": false, "description": "如果类型为COS，需要填写COS桶连接", "example": "cosn://bucketname/path" }, { "name": "HdfsProperties", "type": "string", "required": false, "description": "json字符串。如果类型为HDFS，需要填写该字段", "example": "fs.defaultFS=hdfs://ip:port" }, { "name": "Mysql", "type": "object", "required": false, "description": "Hive的元数据库信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "JdbcUrl", "type": "string", "required": true, "description": "连接mysql的jdbc url", "example": "jdbc:mysql://ip:port" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "root" }, { "name": "Password", "type": "string", "required": true, "description": "mysql密码", "example": "******" }, { "name": "Location", "type": "object", "required": true, "description": "mysql数据源的网络信息", "example": "无" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "MetaDb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdb-xxxxx" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据库实例名称，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "mySql" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "emr集群Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "emr-adp0c9v8" }, { "name": "InstanceName", "type": "string", "required": false, "description": "emr集群名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "testEmr" }, { "name": "HiveVersion", "type": "string", "required": false, "description": "EMR集群中hive组件的版本号", "example": "2.3.7" }, { "name": "KerberosInfo", "type": "object", "required": false, "description": "Kerberos详细信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Krb5Conf", "type": "string", "required": false, "description": "Krb5Conf文件值", "example": "文件内容" }, { "name": "KeyTab", "type": "string", "required": false, "description": "KeyTab文件值", "example": "文件内容" }, { "name": "ServicePrincipal", "type": "string", "required": false, "description": "服务主体", "example": "Kerberos principa" } ] }, { "name": "KerberosEnable", "type": "boolean", "required": false, "description": "是否开启Kerberos 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "Kafka", "type": "object", "required": false, "description": "Kafka数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "kafka实例Id", "example": "***" }, { "name": "Location", "type": "object", "required": true, "description": "kafka数据源的网络信息", "example": "{\"VpcId\":\"vpc-***\",\"VpcCidrBlock\":\"10.0.0.0/16\",\"SubnetId\":\"subn", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] } ] }, { "name": "OtherDatasourceConnection", "type": "object", "required": false, "description": "其他数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Location", "type": "object", "required": true, "description": "网络参数", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] } ] }, { "name": "PostgreSql", "type": "object", "required": false, "description": "PostgreSQL数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "SqlServer", "type": "object", "required": false, "description": "SQLServer数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "ClickHouse", "type": "object", "required": false, "description": "ClickHouse数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "Elasticsearch", "type": "object", "required": false, "description": "Elasticsearch数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "User", "type": "string", "required": false, "description": "用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "asdfcjaidf-=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "ServiceInfo", "type": "array", "required": false, "description": "访问Elasticsearch的ip、端口信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": false, "description": "ip信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "192.*.*.*" }, { "name": "Port", "type": "integer", "required": false, "description": "端口信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" } ] } ] }, { "name": "TDSQLPostgreSql", "type": "object", "required": false, "description": "TDSQL-PostgreSQL数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "TCHouseD", "type": "object", "required": false, "description": "Doris数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源名称", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC", "example": "jdbc:mysql//" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名", "example": "default" }, { "name": "AccessInfo", "type": "string", "required": false, "description": "访问信息", "example": "\"[{\\\"address\\\":\\\"10.0.0.6:9030\\\",\\\"protocol\\\":\\\"tcp\\\"},{\\\"address\\\":\\\"10.0.0.6:8030\\\",\\\"protocol\\\":\\\"http\\\"},{\\\"address\\\":\\\"10.0.0.6:8040\\\",\\\"protocol\\\":\\\"be_http\\\"}]\"" } ] }, { "name": "TccHive", "type": "object", "required": false, "description": "TccHive数据目录连接信息", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "tcc-wiot2q1i" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "测试实例" }, { "name": "EndpointServiceId", "type": "string", "required": false, "description": "终端节点服务ID", "example": "vpcs-9shj2xs1" }, { "name": "MetaStoreUrl", "type": "string", "required": false, "description": "thrift连接地址", "example": "thrift://127.0.0.1:7004" }, { "name": "HiveVersion", "type": "string", "required": false, "description": "hive版本", "example": "3.1.3" }, { "name": "TccConnection", "type": "object", "required": false, "description": "网络信息", "example": "复杂类型", "children": [ { "name": "ClbIp", "type": "string", "required": false, "description": "服务clbip", "example": "127.0.0.1" }, { "name": "ClbPort", "type": "string", "required": false, "description": "服务clbPort", "example": "11808" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc实例id", "example": "vpc-test" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "vpc网段", "example": "10.0.0.1/12" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例id", "example": "subnet-test" }, { "name": "SubnetCidrBlock", "type": "string", "required": false, "description": "子网网段", "example": "10.0.0.1/24" } ] }, { "name": "HmsEndpointServiceId", "type": "string", "required": false, "description": "Hms终端节点服务ID", "example": "vpcsvc-6jsiek7s" } ] }, { "name": "MongoDB", "type": "object", "required": false, "description": "MongoDB 数据源", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] } ] }, { "name": "DataEngineNames", "type": "array", "required": true, "description": "引擎名称，只允许绑定一个引擎", "example": "无", "item_type": "string" }, { "name": "NetworkConnectionType", "type": "integer", "required": true, "description": "网络类型，2-跨源型，4-增强型", "example": "无" }, { "name": "NetworkConnectionDesc", "type": "string", "required": false, "description": "网络配置描述", "example": "无" } ], "required": [ "DatasourceConnectionName", "DatasourceConnectionType", "DatasourceConnectionConfig", "DataEngineNames", "NetworkConnectionType" ] }, { "name": "AttachDataMaskPolicy", "description": "绑定数据脱敏策略", "status": "online", "parameters": [ { "name": "DataMaskStrategyPolicySet", "type": "array", "required": false, "description": "要绑定的数据脱敏策略权限对象集合", "example": "无", "item_type": "object", "children": [ { "name": "PolicyInfo", "type": "object", "required": false, "description": "数据脱敏权限对象 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] }, { "name": "DataMaskStrategyId", "type": "string", "required": false, "description": "数据脱敏策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1123-12a-31231" }, { "name": "ColumnType", "type": "string", "required": false, "description": "绑定字段类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "int" } ] } ], "required": [] }, { "name": "AttachUserPolicy", "description": "绑定鉴权策略到用户", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户Id，和子用户uin相同，需要先使用CreateUser接口创建用户。可以使用DescribeUsers接口查看。", "example": "10401463674518" }, { "name": "PolicySet", "type": "array", "required": false, "description": "鉴权策略集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [ "UserId" ] }, { "name": "AttachWorkGroupPolicy", "description": "绑定鉴权策略到工作组", "status": "online", "parameters": [ { "name": "WorkGroupId", "type": "integer", "required": true, "description": "工作组Id", "example": "1" }, { "name": "PolicySet", "type": "array", "required": false, "description": "要绑定的策略集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] } ], "required": [ "WorkGroupId" ] }, { "name": "BindWorkGroupsToUser", "description": "绑定工作组到用户", "status": "online", "parameters": [ { "name": "AddInfo", "type": "object", "required": true, "description": "绑定的用户和工作组信息", "example": "无", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户Id，和CAM侧Uin匹配", "example": "“12345678”" }, { "name": "WorkGroupIds", "type": "array", "required": true, "description": "工作组Id集合", "example": "[1,2,3]", "item_type": "integer" } ] } ], "required": [ "AddInfo" ] }, { "name": "CancelNotebookSessionStatement", "description": "本接口（CancelNotebookSessionStatement）用于取消session中执行的任务", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "StatementId", "type": "string", "required": true, "description": "Session Statement唯一标识", "example": "d3018ad4-9a7e-4f64-a3dj-f38507c697dj" } ], "required": [ "SessionId", "StatementId" ] }, { "name": "CancelNotebookSessionStatementBatch", "description": "本接口（CancelNotebookSessionStatementBatch）用于批量取消Session 中执行的任务", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "BatchId", "type": "string", "required": true, "description": "批任务唯一标识", "example": "dses8ad4-9a7e-4f64-a3dj-f38507c697dj" } ], "required": [ "SessionId", "BatchId" ] }, { "name": "CancelSparkSessionBatchSQL", "description": "本接口（CancelSparkSessionBatchSQL）用于取消Spark SQL批任务。", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "批任务唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "CustomKey", "type": "string", "required": false, "description": "用户自定义主键，若不为空，则使用该值进行查询", "example": "dje8ed4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "BatchId" ] }, { "name": "CancelTask", "description": "本接口（CancelTask），用于取消任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务Id，全局唯一", "example": "8548111ce1611ef8bb45254006a8683" } ], "required": [ "TaskId" ] }, { "name": "CancelTasks", "description": "批量取消任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "array", "required": true, "description": "任务Id数组，全局唯一", "example": "[\"aaa\"]", "item_type": "string" }, { "name": "Config", "type": "array", "required": false, "description": "配置信息，key-value数组，对外不可见。key1：AuthorityRole（鉴权角色，默认传SubUin，base64加密，仅在jdbc提交任务时使用）", "example": "[{AuthorityRole:100019868890}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ], "required": [ "TaskId" ] }, { "name": "CheckDataEngineConfigPairsValidity", "description": "本接口（CheckDataEngineConfigPairsValidity）用于检查引擎用户自定义参数的有效性", "status": "online", "parameters": [ { "name": "ChildImageVersionId", "type": "string", "required": false, "description": "引擎小版本ID", "example": "dfa996c5-719c-4177-8096-d2562d6ad8b3" }, { "name": "DataEngineConfigPairs", "type": "array", "required": false, "description": "用户自定义参数", "example": "[“ConfigItem”:\"key\",\"ConfigValue\":\"value\"]", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] }, { "name": "ImageVersionId", "type": "string", "required": false, "description": "引擎大版本ID，存在小版本ID时仅需传入小版本ID，不存在时会获取当前大版本下最新的小版本ID。", "example": "dfdsadc5-719c-4177-8096-d2562d6ad8b3" } ], "required": [] }, { "name": "CheckDataEngineImageCanBeRollback", "description": "本接口（CheckDataEngineImageCanBeRollback）用于查看集群是否能回滚。", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎唯一id", "example": "DataEngine-1" } ], "required": [ "DataEngineId" ] }, { "name": "CheckDataEngineImageCanBeUpgrade", "description": "本接口（CheckDataEngineImageCanBeUpgrade）用于查看集群镜像是否能够升级。", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "集群id", "example": "DataEngine-1" } ], "required": [ "DataEngineId" ] }, { "name": "CheckLockMetaData", "description": "元数据锁检查", "status": "online", "parameters": [ { "name": "LockId", "type": "integer", "required": true, "description": "锁ID", "example": "1" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称", "example": "DataLakeCatalog" }, { "name": "TxnId", "type": "integer", "required": false, "description": "事务ID", "example": "1" }, { "name": "ElapsedMs", "type": "integer", "required": false, "description": "过期时间ms", "example": "100" } ], "required": [ "LockId" ] }, { "name": "CreateCHDFSBindingProduct", "description": "此接口（CreateCHDFSBindingProduct）用于创建元数据加速桶和产品绑定关系", "status": "online", "parameters": [ { "name": "MountPoint", "type": "string", "required": true, "description": "需要绑定的元数据加速桶名", "example": "dlc-xxx" }, { "name": "BucketType", "type": "string", "required": true, "description": "桶的类型，分为cos和lakefs", "example": "lakefs" }, { "name": "ProductName", "type": "string", "required": true, "description": "产品名称", "example": "DLC" }, { "name": "EngineName", "type": "string", "required": false, "description": "引擎名称，ProductName选择DLC产品时，必传此参数。其他产品可不传", "example": "guiyin" }, { "name": "VpcInfo", "type": "array", "required": false, "description": "vpc信息，产品名称为other时必传此参数", "example": "无", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "vpc Id", "example": "vpc-f37xxxx" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "vpc子网", "example": "10.*.*.*/*" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则Id", "example": "4549" }, { "name": "AccessGroupId", "type": "string", "required": false, "description": "权限组Id", "example": "ag-cj91234e" } ] } ], "required": [ "MountPoint", "BucketType", "ProductName" ] }, { "name": "CreateDMSDatabase", "description": "DMS元数据创建库", "status": "online", "parameters": [ { "name": "Asset", "type": "object", "required": false, "description": "基础元数据对象", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "Guid", "type": "string", "required": false, "description": "对象GUID值 注意：此字段可能返回 null，表示取不到有效值。", "example": "xxxx-xxxx-xxx-xxx" }, { "name": "Catalog", "type": "string", "required": false, "description": "数据目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "DataLakeCatalog" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "desc" }, { "name": "Owner", "type": "string", "required": false, "description": "对象owner", "example": "root" }, { "name": "OwnerAccount", "type": "string", "required": false, "description": "对象owner账户", "example": "root" }, { "name": "PermValues", "type": "array", "required": false, "description": "权限", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "附加业务属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-01-01 12:12:12" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-01-01 12:12:12" }, { "name": "DatasourceId", "type": "integer", "required": false, "description": "数据源主键", "example": "1" } ] }, { "name": "SchemaName", "type": "string", "required": false, "description": "Schema目录", "example": "Schema1" }, { "name": "Location", "type": "string", "required": false, "description": "Db存储路径", "example": "cosn://bucket-1" }, { "name": "Name", "type": "string", "required": false, "description": "数据库名称", "example": "DatabaseName" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "CreateDMSTable", "description": "DMS元数据创建表", "status": "online", "parameters": [ { "name": "Asset", "type": "object", "required": false, "description": "基础对象", "example": "无", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "Guid", "type": "string", "required": false, "description": "对象GUID值 注意：此字段可能返回 null，表示取不到有效值。", "example": "xxxx-xxxx-xxx-xxx" }, { "name": "Catalog", "type": "string", "required": false, "description": "数据目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "DataLakeCatalog" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "desc" }, { "name": "Owner", "type": "string", "required": false, "description": "对象owner", "example": "root" }, { "name": "OwnerAccount", "type": "string", "required": false, "description": "对象owner账户", "example": "root" }, { "name": "PermValues", "type": "array", "required": false, "description": "权限", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "附加业务属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-01-01 12:12:12" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-01-01 12:12:12" }, { "name": "DatasourceId", "type": "integer", "required": false, "description": "数据源主键", "example": "1" } ] }, { "name": "Type", "type": "string", "required": false, "description": "表类型：EXTERNAL_TABLE, VIRTUAL_VIEW, MATERIALIZED_VIEW", "example": "EXTERNAL" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "LifeTime", "type": "integer", "required": false, "description": "生命周期", "example": "10" }, { "name": "DataUpdateTime", "type": "string", "required": false, "description": "数据更新时间", "example": "2021-01-01 12:12:12" }, { "name": "StructUpdateTime", "type": "string", "required": false, "description": "结构更新时间", "example": "2021-01-01 12:12:12" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-01-01 12:12:12" }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "Columns", "type": "array", "required": false, "description": "列", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "PartitionKeys", "type": "array", "required": false, "description": "分区键值", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "ViewOriginalText", "type": "string", "required": false, "description": "视图文本", "example": "select 1" }, { "name": "ViewExpandedText", "type": "string", "required": false, "description": "视图文本", "example": "select 1" }, { "name": "Partitions", "type": "array", "required": false, "description": "分区", "example": "无", "item_type": "object", "children": [ { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "11" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据目录名称", "example": "schema1" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "table1" }, { "name": "DataVersion", "type": "integer", "required": false, "description": "数据版本", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "分区名称", "example": "partition1" }, { "name": "Values", "type": "array", "required": false, "description": "值列表", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "存储大小", "example": "1" }, { "name": "RecordCount", "type": "integer", "required": false, "description": "记录数量", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2021-05-08 16:43:16" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "修改时间", "example": "2021-05-08 16:43:16" }, { "name": "LastAccessTime", "type": "string", "required": false, "description": "最后访问时间", "example": "2021-05-08 16:43:16" }, { "name": "Params", "type": "array", "required": false, "description": "附件属性", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Sds", "type": "object", "required": false, "description": "存储对象", "example": "无", "children": [ { "name": "Location", "type": "string", "required": false, "description": "存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://aaa" }, { "name": "InputFormat", "type": "string", "required": false, "description": "输入格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "InputFormat" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "输出格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "OutputFormat" }, { "name": "NumBuckets", "type": "integer", "required": false, "description": "bucket数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Compressed", "type": "boolean", "required": false, "description": "是是否压缩 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "StoredAsSubDirectories", "type": "boolean", "required": false, "description": "是否有子目录 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SerdeLib", "type": "string", "required": false, "description": "序列化lib 注意：此字段可能返回 null，表示取不到有效值。", "example": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, { "name": "SerdeName", "type": "string", "required": false, "description": "序列化名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "serde1" }, { "name": "BucketCols", "type": "array", "required": false, "description": "桶名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "SerdeParams", "type": "array", "required": false, "description": "序列化参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SortCols", "type": "object", "required": false, "description": "列排序(Expired) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Cols", "type": "array", "required": false, "description": "列 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "name1" }, { "name": "Description", "type": "string", "required": false, "description": "描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "desc1" }, { "name": "Type", "type": "string", "required": false, "description": "类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "EXTERNAL" }, { "name": "Position", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Params", "type": "array", "required": false, "description": "附加参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "BizParams", "type": "array", "required": false, "description": "业务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否分区 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "SortColumns", "type": "array", "required": false, "description": "列排序字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Col", "type": "string", "required": false, "description": "列名 注意：此字段可能返回 null，表示取不到有效值。", "example": "col1" }, { "name": "Order", "type": "integer", "required": false, "description": "排序 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ] }, { "name": "Name", "type": "string", "required": false, "description": "表名称", "example": "表名称" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "CreateDataEngine", "description": "为用户创建数据引擎", "status": "online", "parameters": [ { "name": "EngineType", "type": "string", "required": true, "description": "引擎类型spark/presto", "example": "spark" }, { "name": "DataEngineName", "type": "string", "required": true, "description": "虚拟集群名称", "example": "at_data_engine_spark_jar" }, { "name": "ClusterType", "type": "string", "required": true, "description": "集群类型 spark_private/presto_private/presto_cu/spark_cu", "example": "presto_cu/spark_cu" }, { "name": "Mode", "type": "integer", "required": true, "description": "计费模式 0=共享模式 1=按量计费 2=包年包月", "example": "0" }, { "name": "AutoResume", "type": "boolean", "required": true, "description": "是否自动启动集群", "example": "true" }, { "name": "MinClusters", "type": "integer", "required": false, "description": "最小资源", "example": "1" }, { "name": "MaxClusters", "type": "integer", "required": false, "description": "最大资源", "example": "10" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "VPC网段", "example": "10.10.0.0/16" }, { "name": "Message", "type": "string", "required": false, "description": "描述信息", "example": "at_data_engine_spark_jar" }, { "name": "Size", "type": "integer", "required": false, "description": "集群规模", "example": "64" }, { "name": "PayMode", "type": "integer", "required": false, "description": "计费类型，后付费：0，预付费：1。当前只支持后付费，不填默认为后付费。", "example": "0" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "资源使用时长，后付费：固定填1，预付费：最少填1，代表购买资源一个月，最长不超过120。默认1", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "资源使用时长的单位，后付费：h，预付费：m。默认为h", "example": "s" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "资源的自动续费标志。后付费无需续费，固定填0；预付费下：0表示手动续费、1代表自动续费、2代表不续费，在0下如果是大客户，会自动帮大客户续费。默认为0", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "创建资源的时候需要绑定的标签信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "tagKey1" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagValue1" } ] }, { "name": "AutoSuspend", "type": "boolean", "required": false, "description": "是否自定挂起集群：false（默认）：不自动挂起、true：自动挂起", "example": "false" }, { "name": "CrontabResumeSuspend", "type": "integer", "required": false, "description": "定时启停集群策略：0（默认）：关闭定时策略、1：开启定时策略（注：定时启停策略与自动挂起策略互斥）", "example": "1" }, { "name": "CrontabResumeSuspendStrategy", "type": "object", "required": false, "description": "定时启停策略，复杂类型：包含启停时间、挂起集群策略", "example": "无", "children": [ { "name": "ResumeTime", "type": "string", "required": false, "description": "定时拉起时间：如：周一\u0026周三8点", "example": "0000101-08:00:00" }, { "name": "SuspendTime", "type": "string", "required": false, "description": "定时挂起时间：如：周一\u0026周三20点", "example": "0000101-20:00:00" }, { "name": "SuspendStrategy", "type": "integer", "required": false, "description": "挂起配置：0（默认）：等待任务结束后挂起、1：强制挂起", "example": "0" } ] }, { "name": "EngineExecType", "type": "string", "required": false, "description": "引擎执行任务类型，有效值：SQL/BATCH，标准引擎默认为BATCH", "example": "SQL/BATCH" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "单个集群最大并发任务数，默认5", "example": "5" }, { "name": "TolerableQueueTime", "type": "integer", "required": false, "description": "可容忍的排队时间，默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0，则表示一旦有任务排队就可能立即触发扩容。", "example": "0" }, { "name": "AutoSuspendTime", "type": "integer", "required": false, "description": "集群自动挂起时间，默认10分钟", "example": "10" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型。Standard_CU：标准型；Memory_CU：内存型", "example": "Standard_CU" }, { "name": "DataEngineConfigPairs", "type": "array", "required": false, "description": "集群高级配置", "example": "无", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] }, { "name": "ImageVersionName", "type": "string", "required": false, "description": "集群镜像版本名字。如SuperSQL-P 1.1;SuperSQL-S 3.2等,不传，默认创建最新镜像版本的集群", "example": "SuperSQL-P 1.1" }, { "name": "MainClusterName", "type": "string", "required": false, "description": "主集群名称，创建容灾集群时指定", "example": "MainCluster" }, { "name": "ElasticSwitch", "type": "boolean", "required": false, "description": "spark jar 包年包月集群是否开启弹性", "example": "false" }, { "name": "ElasticLimit", "type": "integer", "required": false, "description": "spark jar 包年包月集群弹性上限", "example": "0" }, { "name": "SessionResourceTemplate", "type": "object", "required": false, "description": "spark作业集群session资源配置模板", "example": "无", "children": [ { "name": "DriverSize", "type": "string", "required": false, "description": "driver规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "executor规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorNums", "type": "integer", "required": false, "description": "指定executor数量，最小值为1，最大值小于集群规格", "example": "1" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定executor max数量（动态配置场景下），最小值为1，最大值小于集群规格（当ExecutorMaxNumbers小于ExecutorNums时，改值设定为ExecutorNums）", "example": "1" }, { "name": "RunningTimeParameters", "type": "array", "required": false, "description": "运行时参数", "example": "复杂类型", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] } ] }, { "name": "AutoAuthorization", "type": "boolean", "required": false, "description": "自动授权", "example": "true" }, { "name": "EngineNetworkId", "type": "string", "required": false, "description": "引擎网络ID", "example": "DataEngine-Network-xxx" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎世代，SuperSQL：代表supersql引擎，Native：代表标准引擎。默认值为SuperSQL", "example": "superSQL" } ], "required": [ "EngineType", "DataEngineName", "ClusterType", "Mode", "AutoResume" ] }, { "name": "CreateDataMaskStrategy", "description": "创建数据脱敏策略", "status": "online", "parameters": [ { "name": "Strategy", "type": "object", "required": false, "description": "数据脱敏策略详情", "example": "无", "children": [ { "name": "StrategyName", "type": "string", "required": false, "description": "策略名称", "example": "策略1" }, { "name": "StrategyType", "type": "string", "required": false, "description": "MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等", "example": "MASK_SHOW_FIRST_4" }, { "name": "StrategyDesc", "type": "string", "required": false, "description": "策略描述", "example": "for testing purpose" }, { "name": "Groups", "type": "array", "required": false, "description": "用户组策略列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "WorkGroupId", "type": "integer", "required": false, "description": "用户组ID", "example": "212123" }, { "name": "StrategyType", "type": "string", "required": false, "description": "策略类型", "example": "MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等" } ] }, { "name": "Users", "type": "string", "required": false, "description": "用户子账号uin列表，按;拼接", "example": "12312314112;1231231231" }, { "name": "StrategyId", "type": "string", "required": false, "description": "策略Id", "example": "1" } ] } ], "required": [] }, { "name": "CreateDatabase", "description": "本接口（CreateDatabase）用于生成建库SQL语句。", "status": "online", "parameters": [ { "name": "DatabaseInfo", "type": "object", "required": true, "description": "数据库基础信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名称，长度0~128，支持数字、字母下划线，不允许数字大头，统一转换为小写。", "example": "database1" }, { "name": "Comment", "type": "string", "required": false, "description": "数据库描述信息，长度 0~500。 注意：此字段可能返回 null，表示取不到有效值。", "example": "create by zhangsan" }, { "name": "Properties", "type": "array", "required": false, "description": "数据库属性列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性key名称。", "example": "owner" }, { "name": "Value", "type": "string", "required": true, "description": "属性key对应的value。", "example": "create by zhangsan" } ] }, { "name": "Location", "type": "string", "required": false, "description": "数据库cos路径", "example": "cosn://" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称，默认为DataLakeCatalog", "example": "DataLakeCatalog" } ], "required": [ "DatabaseInfo" ] }, { "name": "CreateDatasourceConnection", "description": "创建数据源", "status": "online", "parameters": [ { "name": "DatasourceConnectionName", "type": "string", "required": true, "description": "数据连接名称", "example": "datasource001" }, { "name": "DatasourceConnectionType", "type": "string", "required": true, "description": "数据连接类型", "example": "Mysql/Kafka" }, { "name": "DatasourceConnectionConfig", "type": "object", "required": true, "description": "数据连接属性", "example": "无", "children": [ { "name": "Mysql", "type": "object", "required": false, "description": "Mysql数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "JdbcUrl", "type": "string", "required": true, "description": "连接mysql的jdbc url", "example": "jdbc:mysql://ip:port" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "root" }, { "name": "Password", "type": "string", "required": true, "description": "mysql密码", "example": "******" }, { "name": "Location", "type": "object", "required": true, "description": "mysql数据源的网络信息", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "MetaDb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdb-xxxxx" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据库实例名称，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "mySql" } ] }, { "name": "Hive", "type": "object", "required": false, "description": "Hive数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MetaStoreUrl", "type": "string", "required": true, "description": "hive metastore的地址", "example": "thrift://127.0.0.1:9083" }, { "name": "Type", "type": "string", "required": true, "description": "hive数据源类型，代表数据储存的位置，COS或者HDFS", "example": "COS" }, { "name": "Location", "type": "object", "required": true, "description": "数据源所在的私有网络信息", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "User", "type": "string", "required": false, "description": "如果类型为HDFS，需要传一个用户名", "example": "hadoop" }, { "name": "HighAvailability", "type": "boolean", "required": false, "description": "如果类型为HDFS，需要选择是否高可用", "example": "false" }, { "name": "BucketUrl", "type": "string", "required": false, "description": "如果类型为COS，需要填写COS桶连接", "example": "cosn://bucketname/path" }, { "name": "HdfsProperties", "type": "string", "required": false, "description": "json字符串。如果类型为HDFS，需要填写该字段", "example": "fs.defaultFS=hdfs://ip:port" }, { "name": "Mysql", "type": "object", "required": false, "description": "Hive的元数据库信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "JdbcUrl", "type": "string", "required": true, "description": "连接mysql的jdbc url", "example": "jdbc:mysql://ip:port" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "root" }, { "name": "Password", "type": "string", "required": true, "description": "mysql密码", "example": "******" }, { "name": "Location", "type": "object", "required": true, "description": "mysql数据源的网络信息", "example": "无" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "MetaDb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdb-xxxxx" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据库实例名称，和数据库侧保持一致 注意：此字段可能返回 null，表示取不到有效值。", "example": "mySql" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "emr集群Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "emr-adp0c9v8" }, { "name": "InstanceName", "type": "string", "required": false, "description": "emr集群名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "testEmr" }, { "name": "HiveVersion", "type": "string", "required": false, "description": "EMR集群中hive组件的版本号", "example": "2.3.7" }, { "name": "KerberosInfo", "type": "object", "required": false, "description": "Kerberos详细信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Krb5Conf", "type": "string", "required": false, "description": "Krb5Conf文件值", "example": "文件内容" }, { "name": "KeyTab", "type": "string", "required": false, "description": "KeyTab文件值", "example": "文件内容" }, { "name": "ServicePrincipal", "type": "string", "required": false, "description": "服务主体", "example": "Kerberos principa" } ] }, { "name": "KerberosEnable", "type": "boolean", "required": false, "description": "是否开启Kerberos 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "Kafka", "type": "object", "required": false, "description": "Kafka数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "kafka实例Id", "example": "***" }, { "name": "Location", "type": "object", "required": true, "description": "kafka数据源的网络信息", "example": "{\"VpcId\":\"vpc-***\",\"VpcCidrBlock\":\"10.0.0.0/16\",\"SubnetId\":\"subn", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] } ] }, { "name": "OtherDatasourceConnection", "type": "object", "required": false, "description": "其他数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Location", "type": "object", "required": true, "description": "网络参数", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] } ] }, { "name": "PostgreSql", "type": "object", "required": false, "description": "PostgreSQL数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "SqlServer", "type": "object", "required": false, "description": "SQLServer数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "ClickHouse", "type": "object", "required": false, "description": "ClickHouse数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "Elasticsearch", "type": "object", "required": false, "description": "Elasticsearch数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "User", "type": "string", "required": false, "description": "用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "asdfcjaidf-=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "ServiceInfo", "type": "array", "required": false, "description": "访问Elasticsearch的ip、端口信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": false, "description": "ip信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "192.*.*.*" }, { "name": "Port", "type": "integer", "required": false, "description": "端口信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "8080" } ] } ] }, { "name": "TDSQLPostgreSql", "type": "object", "required": false, "description": "TDSQL-PostgreSQL数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] }, { "name": "TCHouseD", "type": "object", "required": false, "description": "Doris数据源连接的属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源名称", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC", "example": "jdbc:mysql//" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名", "example": "default" }, { "name": "AccessInfo", "type": "string", "required": false, "description": "访问信息", "example": "\"[{\\\"address\\\":\\\"10.0.0.6:9030\\\",\\\"protocol\\\":\\\"tcp\\\"},{\\\"address\\\":\\\"10.0.0.6:8030\\\",\\\"protocol\\\":\\\"http\\\"},{\\\"address\\\":\\\"10.0.0.6:8040\\\",\\\"protocol\\\":\\\"be_http\\\"}]\"" } ] }, { "name": "TccHive", "type": "object", "required": false, "description": "TccHive数据目录连接信息", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "tcc-wiot2q1i" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "测试实例" }, { "name": "EndpointServiceId", "type": "string", "required": false, "description": "终端节点服务ID", "example": "vpcs-9shj2xs1" }, { "name": "MetaStoreUrl", "type": "string", "required": false, "description": "thrift连接地址", "example": "thrift://127.0.0.1:7004" }, { "name": "HiveVersion", "type": "string", "required": false, "description": "hive版本", "example": "3.1.3" }, { "name": "TccConnection", "type": "object", "required": false, "description": "网络信息", "example": "复杂类型", "children": [ { "name": "ClbIp", "type": "string", "required": false, "description": "服务clbip", "example": "127.0.0.1" }, { "name": "ClbPort", "type": "string", "required": false, "description": "服务clbPort", "example": "11808" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc实例id", "example": "vpc-test" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "vpc网段", "example": "10.0.0.1/12" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例id", "example": "subnet-test" }, { "name": "SubnetCidrBlock", "type": "string", "required": false, "description": "子网网段", "example": "10.0.0.1/24" } ] }, { "name": "HmsEndpointServiceId", "type": "string", "required": false, "description": "Hms终端节点服务ID", "example": "vpcsvc-6jsiek7s" } ] }, { "name": "MongoDB", "type": "object", "required": false, "description": "MongoDB 数据源", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "数据源实例的唯一ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "datasource-test" }, { "name": "InstanceName", "type": "string", "required": false, "description": "数据源的名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_datasource" }, { "name": "JdbcUrl", "type": "string", "required": false, "description": "数据源的JDBC访问链接 注意：此字段可能返回 null，表示取不到有效值。", "example": "jdbc:postgresql://ip:port/" }, { "name": "User", "type": "string", "required": false, "description": "用于访问数据源的用户名 注意：此字段可能返回 null，表示取不到有效值。", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "数据源访问密码，需要base64编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "xaskdowq+=" }, { "name": "Location", "type": "object", "required": false, "description": "数据源的VPC和子网信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "数据连接所在Vpc实例Id，如“vpc-azd4dt1c”。", "example": "“vpc-azd4dt1c”" }, { "name": "VpcCidrBlock", "type": "string", "required": true, "description": "Vpc的IPv4 CIDR", "example": "“10.0.0.0/24”" }, { "name": "SubnetId", "type": "string", "required": true, "description": "数据连接所在子网的实例Id，如“subnet-bthucmmy”", "example": "“subnet-bthucmmy”" }, { "name": "SubnetCidrBlock", "type": "string", "required": true, "description": "Subnet的IPv4 CIDR", "example": "“10.0.0.0/24”" } ] }, { "name": "DbName", "type": "string", "required": false, "description": "默认数据库名 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" } ] } ] }, { "name": "ServiceType", "type": "string", "required": true, "description": "数据连接所属服务", "example": "DLC" }, { "name": "DatasourceConnectionDesc", "type": "string", "required": false, "description": "数据连接描述", "example": "datasource test" }, { "name": "DataEngineNames", "type": "array", "required": false, "description": "数据引擎名称数组", "example": "[\"test\"]", "item_type": "string" }, { "name": "NetworkConnectionName", "type": "string", "required": false, "description": "网络连接名称", "example": "test" }, { "name": "NetworkConnectionDesc", "type": "string", "required": false, "description": "网络连接描述", "example": "test" }, { "name": "NetworkConnectionType", "type": "integer", "required": false, "description": "网络连接类型 （2-夸源型，4-增强型）", "example": "2" }, { "name": "CustomConfig", "type": "array", "required": false, "description": "自定义配置", "example": "无", "item_type": "object", "children": [ { "name": "ConfigKey", "type": "string", "required": false, "description": "自定义参数名", "example": "hive.iceberg-catalog-name" }, { "name": "ConfigValue", "type": "string", "required": false, "description": "自定义参数值", "example": "prod_iceberg" } ] } ], "required": [ "DatasourceConnectionName", "DatasourceConnectionType", "DatasourceConnectionConfig", "ServiceType" ] }, { "name": "CreateExportTask", "description": "该接口（CreateExportTask）用于创建导出任务", "status": "online", "parameters": [ { "name": "InputType", "type": "string", "required": true, "description": "数据来源，lakefsStorage、taskResult", "example": "lakefsStorage、taskResult" }, { "name": "InputConf", "type": "array", "required": true, "description": "导出任务输入配置", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "OutputConf", "type": "array", "required": true, "description": "导出任务输出配置", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "OutputType", "type": "string", "required": false, "description": "目标数据源的类型，目前支持导出到cos", "example": "cos" } ], "required": [ "InputType", "InputConf", "OutputConf" ] }, { "name": "CreateImportTask", "description": "该接口（CreateImportTask）用于创建导入任务", "status": "online", "parameters": [ { "name": "InputType", "type": "string", "required": true, "description": "数据来源，cos", "example": "cos" }, { "name": "InputConf", "type": "array", "required": true, "description": "输入配置", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "OutputConf", "type": "array", "required": true, "description": "输出配置", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "OutputType", "type": "string", "required": false, "description": "目标数据源的类型，目前支持导入到托管存储，即lakefsStorage", "example": "lakefsStorage" } ], "required": [ "InputType", "InputConf", "OutputConf" ] }, { "name": "CreateInternalTable", "description": "创建托管存储内表（该接口已废弃）", "status": "online", "parameters": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "表基本信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略" } ] } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] }, { "name": "Columns", "type": "array", "required": true, "description": "表字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "column1" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "test comment" }, { "name": "Default", "type": "string", "required": false, "description": "字段默认值", "example": "ddefault value" }, { "name": "NotNull", "type": "boolean", "required": false, "description": "字段是否是非空", "example": "true" }, { "name": "Precision", "type": "integer", "required": false, "description": "表示整个 numeric 的长度,取值1-38", "example": "10" }, { "name": "Scale", "type": "integer", "required": false, "description": "表示小数部分的长度 Scale小于Precision", "example": "2" }, { "name": "Position", "type": "integer", "required": false, "description": "字段位置，小的在前", "example": "1" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否为分区字段", "example": "false" } ] }, { "name": "Partitions", "type": "array", "required": false, "description": "表分区信息", "example": "0", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "patition1" }, { "name": "Type", "type": "string", "required": false, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "default comment" }, { "name": "PartitionType", "type": "string", "required": false, "description": "分区类型（已废弃）", "example": "string" }, { "name": "PartitionFormat", "type": "string", "required": false, "description": "分区格式（已废弃）", "example": "bucket" }, { "name": "PartitionDot", "type": "integer", "required": false, "description": "分区分隔数（已废弃）", "example": "2" }, { "name": "Transform", "type": "string", "required": false, "description": "分区转换策略", "example": "bucket" }, { "name": "TransformArgs", "type": "array", "required": false, "description": "策略参数", "example": "2", "item_type": "string" } ] }, { "name": "Properties", "type": "array", "required": false, "description": "表属性信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性key名称。", "example": "owner" }, { "name": "Value", "type": "string", "required": true, "description": "属性key对应的value。", "example": "create by zhangsan" } ] } ], "required": [ "TableBaseInfo", "Columns" ] }, { "name": "CreateNotebookSession", "description": "本接口（CreateNotebookSession）用于创建交互式session（notebook）", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "Session名称", "example": "session1" }, { "name": "Kind", "type": "string", "required": true, "description": "类型，当前支持：spark、pyspark、sparkr、sql", "example": "spark" }, { "name": "DataEngineName", "type": "string", "required": true, "description": "DLC Spark作业引擎名称", "example": "data_engine_1" }, { "name": "ProgramDependentFiles", "type": "array", "required": false, "description": "session文件地址，当前支持：cosn://和lakefs://两种路径", "example": "[cosn://xxx]", "item_type": "string" }, { "name": "ProgramDependentJars", "type": "array", "required": false, "description": "依赖的jar程序地址，当前支持：cosn://和lakefs://两种路径", "example": "[cosn://xxx]", "item_type": "string" }, { "name": "ProgramDependentPython", "type": "array", "required": false, "description": "依赖的python程序地址，当前支持：cosn://和lakefs://两种路径", "example": "[cosn://xxx]", "item_type": "string" }, { "name": "ProgramArchives", "type": "array", "required": false, "description": "依赖的pyspark虚拟环境地址，当前支持：cosn://和lakefs://两种路径", "example": "[cosn://xxx]", "item_type": "string" }, { "name": "DriverSize", "type": "string", "required": false, "description": "指定的Driver规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "指定的Executor规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "ExecutorNumbers", "type": "integer", "required": false, "description": "指定的Executor数量，默认为1", "example": "1" }, { "name": "Arguments", "type": "array", "required": false, "description": "Session相关配置，当前支持： 1. dlc.eni: 用户配置的eni网关信息，可以通过该字段设置； 2. dlc.role.arn: 用户配置的roleArn鉴权策略配置信息，可以通过该字段设置； 3. dlc.sql.set.config: 用户配置的集群配置信息，可以通过该字段设置；", "example": "[\"eni\":\"test_eni\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "ProxyUser", "type": "string", "required": false, "description": "代理用户，默认为root", "example": "root" }, { "name": "TimeoutInSecond", "type": "integer", "required": false, "description": "指定的Session超时时间，单位秒，默认3600秒", "example": "3600" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定的Executor数量（最大值），默认为1，当开启动态分配有效，若未开启，则该值等于ExecutorNumbers", "example": "1" }, { "name": "SparkImage", "type": "string", "required": false, "description": "指定spark版本名称，当前任务使用该spark镜像运行", "example": "pyspark 3.2" }, { "name": "IsInherit", "type": "integer", "required": false, "description": "是否继承集群的资源类配置：0：自定义（默认），1：继承集群；", "example": "0" } ], "required": [ "Name", "Kind", "DataEngineName" ] }, { "name": "CreateNotebookSessionStatement", "description": "本接口（CreateNotebookSessionStatement）用于在session中执行代码片段", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "Code", "type": "string", "required": true, "description": "执行的代码", "example": "select 1" }, { "name": "Kind", "type": "string", "required": true, "description": "类型，当前支持：spark、pyspark、sparkr、sql", "example": "sql" } ], "required": [ "SessionId", "Code", "Kind" ] }, { "name": "CreateNotebookSessionStatementSupportBatchSQL", "description": "本接口（CreateNotebookSessionStatementSupportBatchSQL）用于创建交互式session并执行SQL任务", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "Code", "type": "string", "required": true, "description": "执行的代码", "example": "select 1;" }, { "name": "Kind", "type": "string", "required": true, "description": "类型，当前支持：sql", "example": "sql" }, { "name": "SaveResult", "type": "boolean", "required": true, "description": "是否保存运行结果", "example": "true" } ], "required": [ "SessionId", "Code", "Kind", "SaveResult" ] }, { "name": "CreateResultDownload", "description": "创建查询结果下载任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "查询结果任务Id", "example": "123abc456" }, { "name": "Format", "type": "string", "required": true, "description": "下载格式", "example": "CSV" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否重新生成下载文件，仅当之前任务状态为 timeout | error 时有效", "example": "true" } ], "required": [ "TaskId", "Format" ] }, { "name": "CreateScript", "description": "该接口（CreateScript）用于创建sql脚本。", "status": "online", "parameters": [ { "name": "ScriptName", "type": "string", "required": true, "description": "脚本名称，最大不能超过255个字符。", "example": "Script1" }, { "name": "SQLStatement", "type": "string", "required": true, "description": "base64编码后的sql语句", "example": "U0VMRUNUICogRlJPTSBgdGVzdGA7" }, { "name": "ScriptDesc", "type": "string", "required": false, "description": "脚本描述， 不能超过50个字符", "example": "create by zhangsan" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "database1" } ], "required": [ "ScriptName", "SQLStatement" ] }, { "name": "CreateSparkApp", "description": "创建spark作业", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "spark作业名", "example": "app-test" }, { "name": "AppType", "type": "integer", "required": true, "description": "spark作业类型，1代表spark jar作业，2代表spark streaming作业", "example": "1" }, { "name": "DataEngine", "type": "string", "required": true, "description": "执行spark作业的数据引擎名称", "example": "spark-engine" }, { "name": "AppFile", "type": "string", "required": true, "description": "spark作业程序包文件路径", "example": "test.jar" }, { "name": "RoleArn", "type": "integer", "required": true, "description": "数据访问策略，CAM Role arn，控制台通过数据作业—\u003e作业配置获取，SDK通过DescribeUserRoles接口获取对应的值；", "example": "12" }, { "name": "AppDriverSize", "type": "string", "required": true, "description": "指定的Driver规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "AppExecutorSize", "type": "string", "required": true, "description": "指定的Executor规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "AppExecutorNums", "type": "integer", "required": true, "description": "spark作业executor个数", "example": "1" }, { "name": "Eni", "type": "string", "required": false, "description": "该字段已下线，请使用字段Datasource", "example": "kafka-datasource" }, { "name": "IsLocal", "type": "string", "required": false, "description": "spark作业程序包是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "MainClass", "type": "string", "required": false, "description": "spark作业主类", "example": "org.test.WordCount" }, { "name": "AppConf", "type": "string", "required": false, "description": "spark配置，以换行符分隔", "example": "spark.default.parallelism=2000" }, { "name": "IsLocalJars", "type": "string", "required": false, "description": "spark 作业依赖jar包是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppJars", "type": "string", "required": false, "description": "spark 作业依赖jar包（--jars），以逗号分隔", "example": "com.test.jar" }, { "name": "IsLocalFiles", "type": "string", "required": false, "description": "spark作业依赖文件资源是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppFiles", "type": "string", "required": false, "description": "spark作业依赖文件资源（--files）（非jar、zip），以逗号分隔", "example": "spark-default.properties" }, { "name": "CmdArgs", "type": "string", "required": false, "description": "spark作业程序入参，空格分割", "example": "10" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数，只对spark流任务生效", "example": "1" }, { "name": "DataSource", "type": "string", "required": false, "description": "数据源名称", "example": "kafka-datasource" }, { "name": "IsLocalPythonFiles", "type": "string", "required": false, "description": "pyspark：依赖上传方式，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppPythonFiles", "type": "string", "required": false, "description": "pyspark作业依赖python资源（--py-files），支持py/zip/egg等归档格式，多文件以逗号分隔", "example": "test.py" }, { "name": "IsLocalArchives", "type": "string", "required": false, "description": "spark作业依赖archives资源是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppArchives", "type": "string", "required": false, "description": "spark作业依赖archives资源（--archives），支持tar.gz/tgz/tar等归档格式，以逗号分隔", "example": "file1.tar.gz#abc" }, { "name": "SparkImage", "type": "string", "required": false, "description": "Spark Image 版本号", "example": "1.0" }, { "name": "SparkImageVersion", "type": "string", "required": false, "description": "Spark Image 版本名称", "example": "spark:3.2.1-java " }, { "name": "AppExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定的Executor数量（最大值），默认为1，当开启动态分配有效，若未开启，则该值等于AppExecutorNums", "example": "1" }, { "name": "SessionId", "type": "string", "required": false, "description": "关联dlc查询脚本id", "example": "djskjd-12ssad-dsadx-eksjs-ewdm2" }, { "name": "IsInherit", "type": "integer", "required": false, "description": "任务资源配置是否继承集群模板，0（默认）不继承，1：继承", "example": "0" }, { "name": "IsSessionStarted", "type": "boolean", "required": false, "description": "是否使用session脚本的sql运行任务：false：否，true：是", "example": "false" }, { "name": "DependencyPackages", "type": "array", "required": false, "description": "依赖包信息", "example": "无", "item_type": "object", "children": [ { "name": "PackageSource", "type": "string", "required": false, "description": "依赖包类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "Maven" }, { "name": "MavenPackage", "type": "string", "required": false, "description": "依赖包信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "com.hedera.hashgraph:hapi:0.61.3" }, { "name": "MavenRepository", "type": "string", "required": false, "description": "依赖包仓库 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://mirrors.cloud.tencent.com/nexus/repository/maven-public" }, { "name": "MavenExclusion", "type": "string", "required": false, "description": "maven包exclusion信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "json:json" }, { "name": "PypiPackage", "type": "string", "required": false, "description": "pypi包信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "requests" }, { "name": "PypiIndexUrl", "type": "string", "required": false, "description": "pypi索引地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://pypi.org/simple" }, { "name": "PackageType", "type": "string", "required": false, "description": "文件包的类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "jar" }, { "name": "PackagePath", "type": "string", "required": false, "description": "文件包的路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://a/b/c.jar" } ] } ], "required": [ "AppName", "AppType", "DataEngine", "AppFile", "RoleArn", "AppDriverSize", "AppExecutorSize", "AppExecutorNums" ] }, { "name": "CreateSparkAppTask", "description": "启动Spark作业", "status": "online", "parameters": [ { "name": "JobName", "type": "string", "required": true, "description": "spark作业名", "example": "spark-test-app" }, { "name": "CmdArgs", "type": "string", "required": false, "description": "spark作业程序入参，以空格分隔；一般用于周期性调用使用", "example": "10" }, { "name": "SourceInfo", "type": "array", "required": false, "description": "任务来源信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ], "required": [ "JobName" ] }, { "name": "CreateSparkSessionBatchSQL", "description": "本接口（CreateSparkSessionBatchSQL）用于向Spark作业引擎提交Spark SQL批任务。", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "DLC Spark作业引擎名称", "example": "data_engine_1" }, { "name": "ExecuteSQL", "type": "string", "required": true, "description": "运行sql，需要base64编码。", "example": "select 1;" }, { "name": "DriverSize", "type": "string", "required": false, "description": "指定的Driver规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "指定的Executor规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "ExecutorNumbers", "type": "integer", "required": false, "description": "指定的Executor数量，默认为1", "example": "1" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定的Executor数量（最大值），默认为1，当开启动态分配有效，若未开启，则该值等于ExecutorNumbers", "example": "1" }, { "name": "TimeoutInSecond", "type": "integer", "required": false, "description": "指定的Session超时时间，单位秒，默认3600秒", "example": "10" }, { "name": "SessionId", "type": "string", "required": false, "description": "Session唯一标识，当指定sessionid，则使用该session运行任务。", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "SessionName", "type": "string", "required": false, "description": "指定要创建的session名称", "example": "testSession" }, { "name": "Arguments", "type": "array", "required": false, "description": "Session相关配置，当前支持：1.dlc.eni：用户配置的eni网关信息，可以用过该字段设置； 2.dlc.role.arn：用户配置的roleArn鉴权策略配置信息，可以用过该字段设置； 3.dlc.sql.set.config：用户配置的集群配置信息，可以用过该字段设置；", "example": "[\"eni\":\"test_eni\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "IsInherit", "type": "integer", "required": false, "description": "是否继承集群的资源类配置：0：不继承（默认），1：继承集群；", "example": "0" }, { "name": "CustomKey", "type": "string", "required": false, "description": "用户自定义主键，需唯一", "example": "dje8ed4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "SourceInfo", "type": "array", "required": false, "description": "任务来源信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ], "required": [ "DataEngineName", "ExecuteSQL" ] }, { "name": "CreateSparkSubmitTask", "description": "本接口（CreateSparkSubmitTask）用于提交SparkSbumit批流任务。", "status": "online", "parameters": [ { "name": "TaskName", "type": "string", "required": true, "description": "任务名称", "example": "testName" }, { "name": "TaskType", "type": "integer", "required": true, "description": "任务类型：当前支持1: BatchType, 2: StreamingType, 4: SQLType", "example": "1" }, { "name": "DataEngineName", "type": "string", "required": true, "description": "引擎名称，当前仅支持Spark批作业集群", "example": "testEngine" }, { "name": "PackagePath", "type": "string", "required": true, "description": "指定运行的程序脚本路径，当前仅支持jar和py，对于SQLType该值设为空字符串", "example": "cosn://xxx.jar" }, { "name": "RoleArn", "type": "integer", "required": true, "description": "指定的鉴权信息", "example": "1" }, { "name": "IsInherit", "type": "integer", "required": true, "description": "运行任务所需资源是否继承自集群上配置资源信息，0（默认，不继承）、1（继承，当设置为该值，则任务级资源配置可不额外指定）", "example": "0" }, { "name": "MainClass", "type": "string", "required": false, "description": "jar任务时需要指定主程序", "example": "Main" }, { "name": "DriverSize", "type": "string", "required": false, "description": "当前DriverSize规格仅支持（内存型集群则使用m前缀的枚举值）: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "当前ExecutorSize规格仅支持（内存型集群则使用m前缀的枚举值）: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge", "example": "small" }, { "name": "ExecutorNumbers", "type": "integer", "required": false, "description": "指定使用的executor数量，最小为1", "example": "1" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定使用的executor最大数量, 当该值大于ExecutorNums则自动开启动态", "example": "5" }, { "name": "CmdArgs", "type": "array", "required": false, "description": "提交任务的附加配置集合，当前支持Key包含：MAINARGS：程序入口参数，空格分割(SqlType任务通过该值指定base64加密后的sql)、SPARKCONFIG：Spark配置，以换行符分隔、ENI：Eni连接信息、DEPENDENCYPACKAGEPATH：依赖的程序包（--jars、--py-files:支持py/zip/egg等归档格式），多文件以逗号分隔、DEPENDENCYFILEPATH：依赖文件资源（--files: 非jar、zip），多文件以逗号分隔、DEPENDENCYARCHIVESPATH：依赖archives\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "SourceInfo", "type": "array", "required": false, "description": "任务来源信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "ai资源组名称", "example": "ai-resource" } ], "required": [ "TaskName", "TaskType", "DataEngineName", "PackagePath", "RoleArn", "IsInherit" ] }, { "name": "CreateStandardEngineResourceGroup", "description": "创建标准引擎资源组", "status": "online", "parameters": [ { "name": "EngineResourceGroupName", "type": "string", "required": true, "description": "标准引擎资源组名称", "example": "rg-demo" }, { "name": "DataEngineName", "type": "string", "required": true, "description": "标准引擎名称", "example": "house-demo" }, { "name": "AutoLaunch", "type": "integer", "required": false, "description": "自动启动，（任务提交自动拉起资源组）0-自动启动，1-不自动启动", "example": "0" }, { "name": "AutoPause", "type": "integer", "required": false, "description": "自动挂起资源组。0-自动挂起，1-不自动挂起", "example": "0" }, { "name": "DriverCuSpec", "type": "string", "required": false, "description": "driver的cu规格： 当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu），内存型cu为cpu：men=1:8，m.small（1cu内存型）、m.medium（2cu内存型）、m.large（4cu内存型）、m.xlarge（8cu内存型）", "example": "2" }, { "name": "ExecutorCuSpec", "type": "string", "required": false, "description": "executor的cu规格： 当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu），内存型cu为cpu：men=1:8，m.small（1cu内存型）、m.medium（2cu内存型）、m.large（4cu内存型）、m.xlarge（8cu内存型）", "example": "16" }, { "name": "MinExecutorNums", "type": "integer", "required": false, "description": "executor最小数量，", "example": "1" }, { "name": "MaxExecutorNums", "type": "integer", "required": false, "description": "executor最大数量", "example": "1" }, { "name": "IsLaunchNow", "type": "integer", "required": false, "description": "创建资源组后是否直接拉起，0-拉起，1-不拉起", "example": "1" }, { "name": "AutoPauseTime", "type": "integer", "required": false, "description": "自动挂起时间，单位分钟，取值范围在1-999（在无任务AutoPauseTime后，资源组自动挂起）", "example": "1" }, { "name": "StaticConfigPairs", "type": "array", "required": false, "description": "资源组静态参数，需要重启资源组生效", "example": "无", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "DynamicConfigPairs", "type": "array", "required": false, "description": "资源组动态参数，下一个任务生效。", "example": "无", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置项的值 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "任务并发数，默人是5个", "example": "1" }, { "name": "NetworkConfigNames", "type": "array", "required": false, "description": "网络配置名称", "example": "[\"connectionName\"]", "item_type": "string" }, { "name": "PublicDomain", "type": "string", "required": false, "description": "自定义镜像域名", "example": "dlctcr.tencentcloud.com" }, { "name": "RegistryId", "type": "string", "required": false, "description": "自定义镜像实例id", "example": "tcr-xxx" }, { "name": "FrameType", "type": "string", "required": false, "description": "AI类型资源组的框架类型，machine-learning，python，spark-ml，不填默认为machine-learning", "example": "machine-learning" }, { "name": "ImageType", "type": "string", "required": false, "description": "镜像类型，bulit-in：内置，custom：自定义，不填默认为bulit-in", "example": "bulit-in" }, { "name": "ImageName", "type": "string", "required": false, "description": "镜像名称", "example": "image-xxx，若使用内置镜像，即ImageType为bulit-in，则不同框架对应的ImageName为machine-learning: pytorch-v2.5.1, scikit-learn-v1.6.0, tensorflow-v2.18.0 python: python-v3.10 spark-m: Standard-S 1.1" }, { "name": "ImageVersion", "type": "string", "required": false, "description": "镜像id", "example": "Imageid-xxxx" }, { "name": "Size", "type": "integer", "required": false, "description": "AI资源组有效，资源组可用资源上限，该值需要小于引擎资源上限", "example": "64" }, { "name": "ResourceGroupScene", "type": "string", "required": false, "description": "资源组场景", "example": "SparkSQL" }, { "name": "RegionName", "type": "string", "required": false, "description": "自定义镜像所在地域", "example": "ap-beijing" }, { "name": "PythonCuSpec", "type": "string", "required": false, "description": "python类型资源组python单机节点资源上限，该值要小于资源组的资源上限.small:1cu medium:2cu large:4cu xlarge:8cu 4xlarge:16cu 8xlarge:32cu 16xlarge:64cu，如果是高内存型资源，在类型前面加上m.", "example": "small" }, { "name": "SparkSpecMode", "type": "string", "required": false, "description": "仅SQL资源组资源配置模式，fast：快速模式，custom：自定义模式", "example": "custom" }, { "name": "SparkSize", "type": "integer", "required": false, "description": "仅SQL资源组资源上限，仅用于快速模块", "example": "64" }, { "name": "DriverGPUSpec", "type": "integer", "required": false, "description": "GPUDriver规格", "example": "1" }, { "name": "ExecutorGPUSpec", "type": "integer", "required": false, "description": "GPUExecutor规格", "example": "1" }, { "name": "GPULimitSize", "type": "integer", "required": false, "description": "GPU上限", "example": "1" }, { "name": "GPUSize", "type": "integer", "required": false, "description": "GPU规格", "example": "1" }, { "name": "PythonGPUSpec", "type": "integer", "required": false, "description": "Pod GPU规格上限", "example": "1" } ], "required": [ "EngineResourceGroupName", "DataEngineName" ] }, { "name": "CreateStoreLocation", "description": "该接口（CreateStoreLocation）新增或覆盖计算结果存储位置。", "status": "online", "parameters": [ { "name": "StoreLocation", "type": "string", "required": true, "description": "计算结果存储cos路径，如：cosn://bucketname/", "example": "cosn://bucketname/" } ], "required": [ "StoreLocation" ] }, { "name": "CreateTable", "description": "本接口（CreateTable）用于生成建表SQL。", "status": "online", "parameters": [ { "name": "TableInfo", "type": "object", "required": true, "description": "数据表配置信息", "example": "无", "children": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "数据表配置信息。", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] }, { "name": "DataFormat", "type": "object", "required": true, "description": "数据表格式。每次入参可选如下其一的KV结构，[TextFile，CSV，Json, Parquet, ORC, AVRD]。", "example": "无", "children": [ { "name": "TextFile", "type": "object", "required": false, "description": "文本格式，TextFile。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "文本类型，本参数取值为TextFile。", "example": "TextFile" }, { "name": "Regex", "type": "string", "required": false, "description": "处理文本用的正则表达式。", "example": "\"(\\\"[^\\]]*\\\") (\\\"[0-9]*\\\") (-|[^ ]*)\" " } ] }, { "name": "CSV", "type": "object", "required": false, "description": "文本格式，CSV。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CodeCompress", "type": "string", "required": false, "description": "压缩格式，[\"Snappy\", \"Gzip\", \"None\"选一]。", "example": "Snappy" }, { "name": "CSVSerde", "type": "object", "required": false, "description": "CSV序列化及反序列化数据结构。", "example": "无" }, { "name": "HeadLines", "type": "integer", "required": false, "description": "标题行，默认为0。", "example": "1" }, { "name": "Format", "type": "string", "required": false, "description": "格式，默认值为CSV", "example": "CSV" } ] }, { "name": "Json", "type": "object", "required": false, "description": "文本格式，Json。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "枚举类型，默认值为Json，可选值为[Json, Parquet, ORC, AVRD]之一。", "example": "Json" } ] }, { "name": "Parquet", "type": "object", "required": false, "description": "Parquet格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "枚举类型，默认值为Json，可选值为[Json, Parquet, ORC, AVRD]之一。", "example": "Json" } ] }, { "name": "ORC", "type": "object", "required": false, "description": "ORC格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "枚举类型，默认值为Json，可选值为[Json, Parquet, ORC, AVRD]之一。", "example": "Json" } ] }, { "name": "AVRO", "type": "object", "required": false, "description": "AVRO格式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "枚举类型，默认值为Json，可选值为[Json, Parquet, ORC, AVRD]之一。", "example": "Json" } ] } ] }, { "name": "Columns", "type": "array", "required": true, "description": "数据表列信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "列名称，不区分大小写，最大支持25个字符。", "example": "col1" }, { "name": "Type", "type": "string", "required": true, "description": "string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|binary|array|map|struct|uniontype", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "对该类的注释。 注意：此字段可能返回 null，表示取不到有效值。", "example": "create by zhangsan" }, { "name": "Precision", "type": "integer", "required": false, "description": "表示整个 numeric 的长度", "example": "5" }, { "name": "Scale", "type": "integer", "required": false, "description": "表示小数部分的长度", "example": "2" }, { "name": "Nullable", "type": "string", "required": false, "description": "是否为null", "example": "Nullable" }, { "name": "Position", "type": "integer", "required": false, "description": "字段位置，小的在前", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "字段创建时间", "example": "2021-09-07 06:19:23" }, { "name": "ModifiedTime", "type": "string", "required": false, "description": "字段修改时间", "example": "2021-09-07 06:19:23" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否为分区字段", "example": "false" }, { "name": "DataMaskStrategyInfo", "type": "object", "required": false, "description": "数据脱敏策略信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "StrategyName", "type": "string", "required": false, "description": "策略名称", "example": "策略1" }, { "name": "StrategyType", "type": "string", "required": false, "description": "MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等", "example": "MASK_SHOW_FIRST_4" }, { "name": "StrategyDesc", "type": "string", "required": false, "description": "策略描述", "example": "for testing purpose" }, { "name": "Groups", "type": "array", "required": false, "description": "用户组策略列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Users", "type": "string", "required": false, "description": "用户子账号uin列表，按;拼接", "example": "12312314112;1231231231" }, { "name": "StrategyId", "type": "string", "required": false, "description": "策略Id", "example": "1" } ] } ] }, { "name": "Partitions", "type": "array", "required": true, "description": "数据表分块信息。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "分区列名。", "example": "col1" }, { "name": "Type", "type": "string", "required": false, "description": "分区类型。", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "对分区的描述。", "example": "create by zhangsan" }, { "name": "Transform", "type": "string", "required": false, "description": "隐式分区转换策略", "example": "truncate" }, { "name": "TransformArgs", "type": "array", "required": false, "description": "转换策略参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"3\"]", "item_type": "string" }, { "name": "CreateTime", "type": "integer", "required": false, "description": "创建时间", "example": "100000" } ] }, { "name": "Location", "type": "string", "required": true, "description": "数据存储路径。当前仅支持cos路径，格式如下：cosn://bucket-name/filepath。", "example": "cosn://test-bucket-1123423/csvdata/" } ] } ], "required": [ "TableInfo" ] }, { "name": "CreateTask", "description": "本接口（CreateTask）用于创建并执行SQL任务。（推荐使用CreateTasks接口）", "status": "online", "parameters": [ { "name": "Task", "type": "object", "required": true, "description": "计算任务，该参数中包含任务类型及其相关配置信息", "example": "无", "children": [ { "name": "SQLTask", "type": "object", "required": false, "description": "SQL查询任务", "example": "无", "children": [ { "name": "SQL", "type": "string", "required": true, "description": "base64加密后的SQL语句", "example": "U0VMRUNUICogRlJPTSBgdGVzdGA7" }, { "name": "Config", "type": "array", "required": false, "description": "任务的配置信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ] }, { "name": "SparkSQLTask", "type": "object", "required": false, "description": "Spark SQL查询任务", "example": "无", "children": [ { "name": "SQL", "type": "string", "required": true, "description": "base64加密后的SQL语句", "example": "U0VMRUNUICogRlJPTSBgdGVzdGA7" }, { "name": "Config", "type": "array", "required": false, "description": "任务的配置信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ] } ] }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称。如果SQL语句中有数据库名称，优先使用SQL语句中的数据库，否则使用该参数指定的数据库（注：当提交建库sql时，该字段传空字符串）。", "example": "database1" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "默认数据源名称。", "example": "CosDataCatalog" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，不填提交到默认集群", "example": "public-engine" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "标准spark执行任务resourceGroupName", "example": "ResourceGroup01" }, { "name": "SourceInfo", "type": "array", "required": false, "description": "任务来源信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ], "required": [ "Task" ] }, { "name": "CreateTasks", "description": "本接口（CreateTasks），用于批量创建并执行SQL任务", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名称。如果SQL语句中有数据库名称，优先使用SQL语句中的数据库，否则使用该参数指定的数据库（注：当提交建库sql时，该字段传空字符串）。", "example": "database1" }, { "name": "Tasks", "type": "object", "required": true, "description": "SQL任务信息", "example": "无", "children": [ { "name": "TaskType", "type": "string", "required": true, "description": "任务类型，SQLTask：SQL查询任务。SparkSQLTask：Spark SQL查询任务", "example": "SQLTask" }, { "name": "FailureTolerance", "type": "string", "required": true, "description": "容错策略。Proceed：前面任务出错/取消后继续执行后面的任务。Terminate：前面的任务出错/取消之后终止后面任务的执行，后面的任务全部标记为已取消。", "example": "Proceed" }, { "name": "SQL", "type": "string", "required": true, "description": "base64加密后的SQL语句，用\";\"号分隔每个SQL语句，一次最多提交50个任务。严格按照前后顺序执行", "example": "U0VMRUNUICogRlJPTSBgdGVzdGA7" }, { "name": "Config", "type": "array", "required": false, "description": "任务的配置信息，当前仅支持SparkSQLTask任务。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "任务的用户自定义参数信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称，默认为DataLakeCatalog", "example": "DataLakeCatalog" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "计算引擎名称，不填任务提交到默认集群", "example": "shared_presto" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "spark集群资源组名称", "example": "resourceGroup01" }, { "name": "IsMultiStatement", "type": "boolean", "required": false, "description": "是否使用multi- statement方式运行一批次任务，true: 是，false: 否", "example": "false" }, { "name": "SourceInfo", "type": "array", "required": false, "description": "任务来源信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ], "required": [ "DatabaseName", "Tasks" ] }, { "name": "CreateTasksInOrder", "description": "废弃接口，申请下线 按顺序创建任务（已经废弃，后期不再维护，请使用接口CreateTasks）", "status": "deprecated", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名称。如果SQL语句中有数据库名称，优先使用SQL语句中的数据库，否则使用该参数指定的数据库。", "example": "database1" }, { "name": "Tasks", "type": "object", "required": true, "description": "SQL任务信息", "example": "无", "children": [ { "name": "TaskType", "type": "string", "required": true, "description": "任务类型，SQLTask：SQL查询任务。SparkSQLTask：Spark SQL查询任务", "example": "SQLTask" }, { "name": "FailureTolerance", "type": "string", "required": true, "description": "容错策略。Proceed：前面任务出错/取消后继续执行后面的任务。Terminate：前面的任务出错/取消之后终止后面任务的执行，后面的任务全部标记为已取消。", "example": "Proceed" }, { "name": "SQL", "type": "string", "required": true, "description": "base64加密后的SQL语句，用\";\"号分隔每个SQL语句，一次最多提交50个任务。严格按照前后顺序执行", "example": "U0VMRUNUICogRlJPTSBgdGVzdGA7" }, { "name": "Config", "type": "array", "required": false, "description": "任务的配置信息，当前仅支持SparkSQLTask任务。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "Params", "type": "array", "required": false, "description": "任务的用户自定义参数信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称，默认为COSDataCatalog", "example": "COSDataCatalog" } ], "required": [ "DatabaseName", "Tasks" ] }, { "name": "CreateTcIcebergTable", "description": "创建TIceberg表", "status": "online", "parameters": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "表基本信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略" } ] } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] }, { "name": "Columns", "type": "array", "required": true, "description": "表字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "column1" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "test comment" }, { "name": "Default", "type": "string", "required": false, "description": "字段默认值", "example": "ddefault value" }, { "name": "NotNull", "type": "boolean", "required": false, "description": "字段是否是非空", "example": "true" }, { "name": "Precision", "type": "integer", "required": false, "description": "表示整个 numeric 的长度,取值1-38", "example": "10" }, { "name": "Scale", "type": "integer", "required": false, "description": "表示小数部分的长度 Scale小于Precision", "example": "2" }, { "name": "Position", "type": "integer", "required": false, "description": "字段位置，小的在前", "example": "1" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否为分区字段", "example": "false" } ] }, { "name": "DryRun", "type": "boolean", "required": true, "description": "为true时只获取sql而不执行", "example": "false" }, { "name": "Partitions", "type": "array", "required": false, "description": "表分区信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "patition1" }, { "name": "Type", "type": "string", "required": false, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "default comment" }, { "name": "PartitionType", "type": "string", "required": false, "description": "分区类型（已废弃）", "example": "string" }, { "name": "PartitionFormat", "type": "string", "required": false, "description": "分区格式（已废弃）", "example": "bucket" }, { "name": "PartitionDot", "type": "integer", "required": false, "description": "分区分隔数（已废弃）", "example": "2" }, { "name": "Transform", "type": "string", "required": false, "description": "分区转换策略", "example": "bucket" }, { "name": "TransformArgs", "type": "array", "required": false, "description": "策略参数", "example": "2", "item_type": "string" } ] }, { "name": "Properties", "type": "array", "required": false, "description": "表属性信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性key名称。", "example": "owner" }, { "name": "Value", "type": "string", "required": true, "description": "属性key对应的value。", "example": "create by zhangsan" } ] } ], "required": [ "TableBaseInfo", "Columns", "DryRun" ] }, { "name": "CreateUser", "description": "创建用户", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "需要授权的子用户uin，可以通过腾讯云控制台右上角 → “账号信息” → “账号ID进行查看”。", "example": "700099912413" }, { "name": "UserDescription", "type": "string", "required": false, "description": "用户描述信息，方便区分不同用户", "example": "for test" }, { "name": "PolicySet", "type": "array", "required": false, "description": "绑定到用户的权限集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型。ADMIN：管理员 COMMON：一般用户。当用户类型为管理员的时候，不能设置权限集合和绑定的工作组集合，管理员默认拥有所有权限。该参数不填默认为COMMON", "example": "Admin" }, { "name": "WorkGroupIds", "type": "array", "required": false, "description": "绑定到用户的工作组ID集合。", "example": "[221636,213967]", "item_type": "integer" }, { "name": "UserAlias", "type": "string", "required": false, "description": "用户别名，字符长度小50", "example": "testname" }, { "name": "AccountType", "type": "string", "required": false, "description": "账号类型，UserAccount：用户账号 RoleAccount：角色账号，默认为用户账号", "example": "UserAccount" } ], "required": [ "UserId" ] }, { "name": "CreateUserVpcConnection", "description": "创建用户vpc连接到指定引擎网络", "status": "online", "parameters": [ { "name": "UserVpcId", "type": "string", "required": true, "description": "用户vpcid", "example": "vpc-dk19yfxx" }, { "name": "UserSubnetId", "type": "string", "required": true, "description": "用户子网", "example": "subnet-gne3mgxx" }, { "name": "UserVpcEndpointName", "type": "string", "required": true, "description": "用户终端节点名称", "example": "rickytest" }, { "name": "EngineNetworkId", "type": "string", "required": true, "description": "引擎网络ID", "example": "DataEngine-Network-xxx" }, { "name": "UserVpcEndpointVip", "type": "string", "required": false, "description": "手动指定vip，不填自动分配子网下的一个ip", "example": "10.0.0.13" } ], "required": [ "UserVpcId", "UserSubnetId", "UserVpcEndpointName", "EngineNetworkId" ] }, { "name": "CreateWorkGroup", "description": "创建工作组", "status": "online", "parameters": [ { "name": "WorkGroupName", "type": "string", "required": true, "description": "工作组名称", "example": "workgroup1" }, { "name": "WorkGroupDescription", "type": "string", "required": false, "description": "工作组描述", "example": "for test" }, { "name": "PolicySet", "type": "array", "required": false, "description": "工作组绑定的鉴权策略集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] }, { "name": "UserIds", "type": "array", "required": false, "description": "需要绑定到工作组的用户Id集合", "example": "[\"213609\",\"214508\"]", "item_type": "string" } ], "required": [ "WorkGroupName" ] }, { "name": "DeleteCHDFSBindingProduct", "description": "此接口（DeleteCHDFSBindingProduct）用于删除元数据加速桶和产品绑定关系", "status": "online", "parameters": [ { "name": "MountPoint", "type": "string", "required": true, "description": "需要解绑的元数据加速桶名", "example": "dlc8519-*-*-*-*" }, { "name": "BucketType", "type": "string", "required": true, "description": "桶的类型，分为cos和lakefs", "example": "lakefs" }, { "name": "ProductName", "type": "string", "required": true, "description": "产品名称", "example": "other" }, { "name": "EngineName", "type": "string", "required": false, "description": "引擎名称，ProductName选择DLC产品时，必传此参数。其他产品可不传", "example": "dlc-saprk" }, { "name": "VpcInfo", "type": "array", "required": false, "description": "vpc信息，ProductName选择other时，必传此参数", "example": "无", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "vpc Id", "example": "vpc-f37xxxx" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "vpc子网", "example": "10.*.*.*/*" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则Id", "example": "4549" }, { "name": "AccessGroupId", "type": "string", "required": false, "description": "权限组Id", "example": "ag-cj91234e" } ] } ], "required": [ "MountPoint", "BucketType", "ProductName" ] }, { "name": "DeleteDataEngine", "description": "删除数据引擎", "status": "online", "parameters": [ { "name": "DataEngineNames", "type": "array", "required": true, "description": "删除虚拟集群的名称数组", "example": "[\"xxx\"]", "item_type": "string" } ], "required": [ "DataEngineNames" ] }, { "name": "DeleteDataMaskStrategy", "description": "删除数据脱敏策略", "status": "online", "parameters": [ { "name": "StrategyId", "type": "string", "required": false, "description": "数据脱敏策略Id", "example": "1" } ], "required": [] }, { "name": "DeleteNativeSparkSession", "description": "根据spark session名称销毁eg spark session", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": false, "description": "引擎id", "example": "DataEngine-tyyxbgs" }, { "name": "ResourceGroupId", "type": "string", "required": false, "description": "资源组id", "example": "rg-kldiothgf" }, { "name": "EngineSessionName", "type": "string", "required": false, "description": "spark session名称", "example": "session-test" } ], "required": [] }, { "name": "DeleteNotebookSession", "description": "本接口（DeleteNotebookSession）用于删除交互式session（notebook）", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "SessionId" ] }, { "name": "DeleteScript", "description": "该接口（DeleteScript）用于删除sql脚本。", "status": "online", "parameters": [ { "name": "ScriptIds", "type": "array", "required": true, "description": "脚本id，其可以通过DescribeScripts接口提取", "example": "[\"89570c65-49de-4bbd-ac0a-a67c724fc80f\"]", "item_type": "string" } ], "required": [ "ScriptIds" ] }, { "name": "DeleteSparkApp", "description": "删除spark作业", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "spark作业名", "example": "spark-app" } ], "required": [ "AppName" ] }, { "name": "DeleteStandardEngineResourceGroup", "description": "删除标准引擎资源组", "status": "online", "parameters": [ { "name": "EngineResourceGroupName", "type": "string", "required": true, "description": "标准引擎资源组名称", "example": "无" } ], "required": [ "EngineResourceGroupName" ] }, { "name": "DeleteTable", "description": "删除表", "status": "online", "parameters": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "表基本信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略" } ] } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] } ], "required": [ "TableBaseInfo" ] }, { "name": "DeleteThirdPartyAccessUser", "description": "本接口（RegisterThirdPartyAccessUser）用于移除第三方平台访问", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteUser", "description": "删除用户", "status": "online", "parameters": [ { "name": "UserIds", "type": "array", "required": true, "description": "需要删除的用户的Id", "example": "[\"100****7401\"]", "item_type": "string" }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [ "UserIds" ] }, { "name": "DeleteUserVpcConnection", "description": "删除用户vpc到引擎网络的连接", "status": "online", "parameters": [ { "name": "EngineNetworkId", "type": "string", "required": true, "description": "引擎网络ID", "example": "无" }, { "name": "UserVpcEndpointId", "type": "string", "required": true, "description": "终端节点ID", "example": "无" } ], "required": [ "EngineNetworkId", "UserVpcEndpointId" ] }, { "name": "DeleteUsersFromWorkGroup", "description": "从工作组中删除用户", "status": "online", "parameters": [ { "name": "AddInfo", "type": "object", "required": true, "description": "要删除的用户信息", "example": "无", "children": [ { "name": "WorkGroupId", "type": "integer", "required": true, "description": "工作组Id", "example": "1" }, { "name": "UserIds", "type": "array", "required": true, "description": "用户Id集合，和CAM侧Uin匹配", "example": "[\"12345678\"]", "item_type": "string" } ] } ], "required": [ "AddInfo" ] }, { "name": "DeleteWorkGroup", "description": "删除工作组", "status": "online", "parameters": [ { "name": "WorkGroupIds", "type": "array", "required": true, "description": "要删除的工作组Id集合", "example": "[0,1]", "item_type": "integer" } ], "required": [ "WorkGroupIds" ] }, { "name": "DescribeAdvancedStoreLocation", "description": "查询sql查询界面高级设置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeClusterMonitorInfos", "description": "查询任务监控指标信息", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎Id", "example": "DataEngine-b7pgx1ci" }, { "name": "TimeStart", "type": "string", "required": false, "description": "任务创建时间的起始时间", "example": "20250301" }, { "name": "TimeEnd", "type": "string", "required": false, "description": "任务创建时间的结束时间", "example": "20250302" }, { "name": "MetricName", "type": "string", "required": false, "description": "指标名称", "example": "cluster_cpu_usage_average" } ], "required": [ "DataEngineId" ] }, { "name": "DescribeDLCCatalogAccess", "description": "查询DLC Catalog授权列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "显示条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录数量", "example": "10" }, { "name": "Filter", "type": "object", "required": false, "description": "过滤条件", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDMSDatabase", "description": "DMS元数据获取库", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "数据库名称", "example": "name" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "Pattern", "type": "string", "required": false, "description": "匹配规则，只支持填*", "example": "无" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "DescribeDMSPartitions", "description": "DMS元数据获取分区", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "table1" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "name1" }, { "name": "Values", "type": "array", "required": false, "description": "单个分区名称，精准匹配", "example": "[\"aa\", \"bb\"]", "item_type": "string" }, { "name": "PartitionNames", "type": "array", "required": false, "description": "多个分区名称，精准匹配", "example": "[\"a1\", \"b1\"]", "item_type": "string" }, { "name": "PartValues", "type": "array", "required": false, "description": "多个分区字段的匹配，模糊匹配", "example": "[\"a2\", \"a3\"]", "item_type": "string" }, { "name": "Filter", "type": "string", "required": false, "description": "过滤SQL", "example": "a = 1 and b =2" }, { "name": "MaxParts", "type": "integer", "required": false, "description": "最大分区数量", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页跳过数量", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "页面数量", "example": "10" }, { "name": "Expression", "type": "string", "required": false, "description": "表达式", "example": "base64()" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [ "DatabaseName", "TableName" ] }, { "name": "DescribeDMSTable", "description": "DMS元数据获取表", "status": "online", "parameters": [ { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据库schema名称", "example": "schemaName1" }, { "name": "Name", "type": "string", "required": false, "description": "表名称", "example": "tbl1" }, { "name": "Catalog", "type": "string", "required": false, "description": "catalog类型", "example": "hive" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键词", "example": "ta" }, { "name": "Pattern", "type": "string", "required": false, "description": "查询模式，只支持填*", "example": "无" }, { "name": "Type", "type": "string", "required": false, "description": "表类型", "example": "EXTERNAL" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "DescribeDMSTables", "description": "DMS元数据获取表列表", "status": "online", "parameters": [ { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据库schema名称", "example": "schemaName1" }, { "name": "Name", "type": "string", "required": false, "description": "表名称", "example": "tbl1" }, { "name": "Catalog", "type": "string", "required": false, "description": "catalog类型", "example": "hive" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键词", "example": "ta" }, { "name": "Pattern", "type": "string", "required": false, "description": "查询模式，只支持填*", "example": "无" }, { "name": "Type", "type": "string", "required": false, "description": "表类型", "example": "EXTERNAL" }, { "name": "StartTime", "type": "string", "required": false, "description": "筛选参数：更新开始时间", "example": "2006-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "筛选参数：更新结束时间", "example": "2006-01-02 15:04:05" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数", "example": "0" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段：create_time：创建时间", "example": "create_time" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序字段：true：升序（默认），false：降序", "example": "true" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "DescribeDataEngine", "description": "本接口根据名称用于获取数据引擎详细信息", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "House名称", "example": "testHouse" } ], "required": [ "DataEngineName" ] }, { "name": "DescribeDataEngineEvents", "description": "查询数据引擎事件", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "虚拟集群名称", "example": "云盘批处理任务" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "10" }, { "name": "SessionId", "type": "string", "required": false, "description": "资源组id", "example": "session_123" } ], "required": [ "DataEngineName" ] }, { "name": "DescribeDataEngineImageVersions", "description": "本接口（DescribeDataEngineImageVersions）用于获取独享集群大版本镜像列表。", "status": "online", "parameters": [ { "name": "EngineType", "type": "string", "required": true, "description": "引擎类型：SparkSQL、PrestoSQL、SparkBatch、StandardSpark、StandardPresto", "example": "SQL" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段: InsertTime（插入时间，默认），UpdateTime（更新时间）", "example": "InsertTime" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序方式：false（降序，默认），true（升序）", "example": "false" } ], "required": [ "EngineType" ] }, { "name": "DescribeDataEnginePythonSparkImages", "description": "本接口（DescribeDataEnginePythonSparkImages）用于获取PYSPARK镜像列表", "status": "online", "parameters": [ { "name": "ChildImageVersionId", "type": "string", "required": true, "description": "集群镜像小版本ID", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "ChildImageVersionId" ] }, { "name": "DescribeDataEngineSessionParameters", "description": "本接口（DescribeDataEngineSessionParameters）用于获取指定小版本下的Session配置。", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎id", "example": "DataEngine-1" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "引擎名称，当指定引擎名称后优先使用名称获取配置", "example": "DataEngine-Name" } ], "required": [ "DataEngineId" ] }, { "name": "DescribeDataEngines", "description": "本接口（DescribeDataEngines）用于查询DataEngines信息列表.", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤类型，支持如下的过滤类型，传参Name应为以下其中一个, data-engine-name - String（数据引擎名称）：engine-type - String（引擎类型：spark：spark 引擎，presto：presto引擎），state - String (数据引擎状态 -2已删除 -1失败 0初始化中 1挂起 2运行中 3准备删除 4删除中) ， mode - String（计费模式 0共享模式 1按量计费 2包年包月） ， create-time - String（创建时间，10位时间戳） message - String （描述...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc。", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "已废弃，请使用DatasourceConnectionNameSet", "example": "数据目录名称" }, { "name": "ExcludePublicEngine", "type": "boolean", "required": false, "description": "是否不返回共享引擎，true不返回共享引擎，false可以返回共享引擎", "example": "false" }, { "name": "AccessTypes", "type": "array", "required": false, "description": "参数应该为引擎权限类型，有效类型：\"USE\", \"MODIFY\", \"OPERATE\", \"MONITOR\", \"DELETE\"", "example": "[\"USE\"]", "item_type": "string" }, { "name": "EngineExecType", "type": "string", "required": false, "description": "引擎执行任务类型，有效值：SQL/BATCH，默认为SQL", "example": "SQL" }, { "name": "EngineType", "type": "string", "required": false, "description": "引擎类型，有效值：spark/presto/kyuubi，为空时默认获取非kyuubi引擎（网关引擎）", "example": "spark" }, { "name": "DatasourceConnectionNameSet", "type": "array", "required": false, "description": "网络配置列表，若传入该参数，则返回网络配置关联的计算引擎", "example": "[\"DLC_Kafka\"]", "item_type": "string" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎版本，有效值：Native/SuperSQL，为空时默认获取SuperSQL引擎", "example": "Native" }, { "name": "EngineTypeDetail", "type": "string", "required": false, "description": "引擎类型，支持：SparkSQL、SparkBatch、PrestoSQL、Kyuubi", "example": "SparkSQL" }, { "name": "ListHasListener", "type": "boolean", "required": false, "description": "默认 false, 为 true 时仅列出具有洞察 listener 的引擎", "example": "false" } ], "required": [] }, { "name": "DescribeDataEnginesScaleDetail", "description": "查询引擎规格详情", "status": "online", "parameters": [ { "name": "DataEngineNames", "type": "array", "required": false, "description": "引擎名称列表", "example": "[\"engine_id\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，时间格式：yyyy-MM-dd HH:mm:ss，最长查询一个月内的记录", "example": "2024-06-07 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，时间格式：yyyy-MM-dd HH:mm:ss，最长查询一个月内的记录", "example": "2024-06-08 00:00:00" } ], "required": [] }, { "name": "DescribeDataMaskStrategies", "description": "查询数据脱敏列表接口", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，单页返回数据量，默认10", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，数据便偏移量，默认0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤字段，strategy-name: 按策略名称搜索", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDatabases", "description": "本接口（DescribeDatabases）用于查询数据库列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始，默认为0。", "example": "0" }, { "name": "KeyWord", "type": "string", "required": false, "description": "模糊匹配，库名关键字。", "example": "\"data\"" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源唯名称，该名称可以通过DescribeDatasourceConnection接口查询到。默认为DataLakeCatalog", "example": "DataLakeCatalog" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，CreateTime：创建时间，Name：数据库名称", "example": "DatabaseName" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序类型：false：降序（默认）、true：升序", "example": "false" }, { "name": "DescribeType", "type": "string", "required": false, "description": "查询类型：all：全部数据（默认）、permission：有权限的数据 注意：此字段需要开启白名单使用，如果需要使用，请提交工单联系我们。", "example": "default" } ], "required": [] }, { "name": "DescribeDatasourceConnection", "description": "本接口（DescribeDatasourceConnection）用于查询数据源信息", "status": "online", "parameters": [ { "name": "DatasourceConnectionIds", "type": "array", "required": false, "description": "连接ID列表，指定要查询的连接ID", "example": "[\"datasource-testid1\",\"datasource-testid2\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，当前支持的过滤键为：DatasourceConnectionName（数据源连接名）。 DatasourceConnectionType （数据源连接连接类型）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值100", "example": "10" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time（默认，创建时间）、update-time（更新时间）", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为desc", "example": "asc" }, { "name": "StartTime", "type": "string", "required": false, "description": "筛选字段：起始时间", "example": "2006-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "筛选字段：截止时间", "example": "2006-01-02 15:04:05" }, { "name": "DatasourceConnectionNames", "type": "array", "required": false, "description": "连接名称列表，指定要查询的连接名称", "example": "['name']", "item_type": "string" }, { "name": "DatasourceConnectionTypes", "type": "array", "required": false, "description": "连接类型，支持Mysql/HiveCos/Kafka/DataLakeCatalog", "example": "['Mysql']", "item_type": "string" }, { "name": "HiveVersion", "type": "array", "required": false, "description": "返回指定hive版本的数据源，该参数指定后，会过滤掉该参数指定版本以外的hive数据源，非hive数据源正常返回", "example": "['2.3.5']", "item_type": "string" } ], "required": [] }, { "name": "DescribeEngineNetworks", "description": "查询引擎网络信息", "status": "online", "parameters": [ { "name": "SortBy", "type": "string", "required": false, "description": "排序字段", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "升序，降序", "example": "desc，asc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件可选，engine-network-id--引擎网络ID，engine-network-state--引擎网络状态", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "数据条数", "example": "无" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "无" } ], "required": [] }, { "name": "DescribeEngineNodeSpec", "description": "查询引擎可用的节点规格", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": false, "description": "引擎名称", "example": "test" } ], "required": [] }, { "name": "DescribeEngineUsageInfo", "description": "本接口根据引擎ID查询数据引擎资源使用情况", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "数据引擎ID", "example": "DataEngine-r0xxxkls" } ], "required": [ "DataEngineId" ] }, { "name": "DescribeForbiddenTablePro", "description": "本接口（DescribeForbiddenTablePro）用于查询被禁用的表属性列表（新）", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLakeFsDirSummary", "description": "查询托管存储指定目录的Summary", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLakeFsInfo", "description": "查询用户的托管存储信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLakeFsTaskResult", "description": "获取LakeFs上task执行结果访问信息", "status": "online", "parameters": [ { "name": "FsPath", "type": "string", "required": true, "description": "需要访问的任务结果路径", "example": "lakefs://*/.system/result/20250109/*" } ], "required": [ "FsPath" ] }, { "name": "DescribeNativeSparkSessions", "description": "根据资源组获取spark session列表", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": false, "description": "引擎ID", "example": "DataEngine-a4wvak8f" }, { "name": "ResourceGroupId", "type": "string", "required": false, "description": "资源组ID", "example": "rg-7w5ex1i20y" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID", "example": "3065409964877832192" }, { "name": "UserUin", "type": "string", "required": false, "description": "用户Uin", "example": "700002273047" } ], "required": [] }, { "name": "DescribeNetworkConnections", "description": "查询网络配置列表", "status": "online", "parameters": [ { "name": "NetworkConnectionType", "type": "integer", "required": false, "description": "网络配置类型", "example": "无" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "计算引擎名称", "example": "无" }, { "name": "DatasourceConnectionVpcId", "type": "string", "required": false, "description": "数据源vpcid", "example": "无" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "NetworkConnectionName", "type": "string", "required": false, "description": "网络配置名称", "example": "test" } ], "required": [] }, { "name": "DescribeNotebookSession", "description": "本接口（DescribeNotebookSession）用于查询交互式 session详情信息", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "SessionId" ] }, { "name": "DescribeNotebookSessionLog", "description": "本接口（DescribeNotebookSessionLog）用于查询交互式 session日志", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，默认200", "example": "200" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，默认0", "example": "0" } ], "required": [ "SessionId" ] }, { "name": "DescribeNotebookSessionStatement", "description": "本接口（DescribeNotebookSessionStatement）用于查询session 中执行任务的详情", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "StatementId", "type": "string", "required": true, "description": "Session Statement唯一标识", "example": "d3018ad4-9a7e-4f64-a3dj-f38507c697dj" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务唯一标识", "example": "d3018ad4-9a7e-4f64-a3dj-f38507c697dj" } ], "required": [ "SessionId", "StatementId" ] }, { "name": "DescribeNotebookSessionStatementSqlResult", "description": "本接口（DescribeNotebookSessionStatementSqlResult）用于获取statement运行结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务唯一ID", "example": "fdd9c5fa21ca11eca6fb5254006c64af" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "返回结果的最大行数，范围0~1000，默认为1000.", "example": "1000" }, { "name": "NextToken", "type": "string", "required": false, "description": "上一次请求响应返回的分页信息。第一次可以不带，从头开始返回数据，每次返回MaxResults字段设置的数据量。", "example": "nextMarker=\\u0026nextKey=test/DLCQueryResults/2021/10/15/2c60388" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次Id", "example": "82544cc2-116f-4f4e-93e3-d23e7f2437f2" }, { "name": "DataFieldCutLen", "type": "integer", "required": false, "description": "返回结果集中字段值长度截取，如果超过该长度则截取到该长度", "example": "200" } ], "required": [ "TaskId" ] }, { "name": "DescribeNotebookSessionStatements", "description": "本接口（DescribeNotebookSessionStatements）用于查询Session中执行的任务列表", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "Session唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "BatchId", "type": "string", "required": true, "description": "批任务id", "example": "dks18ad4-9a7e-4f64-a3dj-f38507c697dj" } ], "required": [ "SessionId", "BatchId" ] }, { "name": "DescribeNotebookSessions", "description": "本接口（DescribeNotebookSessions）用于查询交互式 session列表", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "DLC Spark作业引擎名称", "example": "data_engine_1" }, { "name": "State", "type": "array", "required": false, "description": "Session状态，包含：not_started（未启动）、starting（已启动）、idle（等待输入）、busy(正在运行statement)、shutting_down（停止）、error（异常）、dead（已退出）、killed（被杀死）、success（正常停止）", "example": "[“not_started”]", "item_type": "string" }, { "name": "SortFields", "type": "array", "required": false, "description": "排序字段（默认按创建时间）", "example": "[\"createTime\"]", "item_type": "string" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序字段：true：升序、false：降序（默认）", "example": "true" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，默认10", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，默认0", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤类型，支持如下的过滤类型，传参Name应为以下其中一个, engine-generation - String（引擎时代： supersql：supersql引擎，native：标准引擎）：notebook-keyword - String（数据引擎名称或sessionid或sessionname的模糊搜索）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [ "DataEngineName" ] }, { "name": "DescribeOtherCHDFSBindingList", "description": "此接口（DescribeOtherCHDFSBindingList）用于查询其他产品元数据加速桶绑定列表", "status": "online", "parameters": [ { "name": "BucketId", "type": "string", "required": true, "description": "桶名", "example": "dlc-buckeid" } ], "required": [ "BucketId" ] }, { "name": "DescribeResourceGroupUsageInfo", "description": "本接口根据资源组ID查询资源组CU使用情况", "status": "online", "parameters": [ { "name": "SessionId", "type": "string", "required": true, "description": "资源组ID", "example": "rg-5ga6u6gxxx" } ], "required": [ "SessionId" ] }, { "name": "DescribeResultDownload", "description": "查询结果下载任务", "status": "online", "parameters": [ { "name": "DownloadId", "type": "string", "required": true, "description": "查询任务Id", "example": "11123" } ], "required": [ "DownloadId" ] }, { "name": "DescribeScripts", "description": "该接口（DescribeScripts）用于查询SQL脚本列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "SortBy", "type": "string", "required": false, "description": "按字段排序，支持如下字段类型，update-time", "example": "update-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序，默认asc", "example": "desc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为其一 script-id - String - （过滤条件）script-id取值形如：157de0d1-26b4-4df2-a2d0-b64afc406c25。 script-name-keyword - String - （过滤条件）数据表名称,形如：script-test。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeSessionImageVersion", "description": "获取指定大版本下所有小版本的所有内置镜像", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎Id", "example": "DataEngine-e482ijv6" }, { "name": "FrameworkType", "type": "string", "required": true, "description": "框架类型：machine-learning、python、spark-ml", "example": "machine-learning" } ], "required": [ "DataEngineId", "FrameworkType" ] }, { "name": "DescribeSparkAppJob", "description": "查询spark作业信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "spark作业Id，与JobName同时存在时，JobName无效，JobId与JobName至少存在一个", "example": "batch_133e005d-6486-4517-8ea7-b6b97b183a6b" }, { "name": "JobName", "type": "string", "required": false, "description": "spark作业名", "example": "spark_app" } ], "required": [] }, { "name": "DescribeSparkAppJobs", "description": "查询spark作业列表", "status": "online", "parameters": [ { "name": "SortBy", "type": "string", "required": false, "description": "返回结果按照该字段排序", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "正序或者倒序，例如：desc", "example": "desc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为其一:spark-job-name（作业名称），spark-job-id（作业id），spark-app-type（作业类型，1：批任务，2：流任务，4：SQL作业），user-name（创建人），key-word（作业名称或ID关键词模糊搜索）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "更新时间起始点，支持格式：yyyy-MM-dd HH:mm:ss", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "更新时间截止点，支持格式：yyyy-MM-dd HH:mm:ss", "example": "2022-01-02 00:00:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量, 默认值0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表限制数量, 默认值100", "example": "10" } ], "required": [] }, { "name": "DescribeSparkAppTasks", "description": "查询Spark作业的运行任务列表", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "spark作业Id", "example": "batch_133e005d-6486-4517-8ea7-b6b97b183a6b" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询Limit", "example": "10" }, { "name": "TaskId", "type": "string", "required": false, "description": "执行实例id", "example": "20241028204024629" }, { "name": "StartTime", "type": "string", "required": false, "description": "更新时间起始点，支持格式：yyyy-MM-dd HH:mm:ss", "example": "2022-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "更新时间截止点，支持格式：yyyy-MM-dd HH:mm:ss", "example": "2022-01-02 00:00:00" }, { "name": "Filters", "type": "array", "required": false, "description": "按照该参数过滤,支持task-state", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [ "JobId" ] }, { "name": "DescribeSparkSessionBatchSQL", "description": "本接口（DescribeSparkSessionBatchSQL）用于查询Spark SQL批任务运行状态", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "SparkSQL唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "CustomKey", "type": "string", "required": false, "description": "用户自定义主键, 若不为空，则按照该值查询", "example": "d39ijsd4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "BatchId" ] }, { "name": "DescribeSparkSessionBatchSQLCost", "description": "本接口（DescribeSparkSessionBatchSQLCost）用于查询Spark SQL批任务消耗", "status": "online", "parameters": [ { "name": "BatchIds", "type": "array", "required": false, "description": "SparkSQL唯一标识", "example": "[\"d3018ad4-9a7e-4f64-a3f4-f38507c69742\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeSparkSessionBatchSqlLog", "description": "本接口（DescribeSparkSessionBatchSqlLog）用于查询Spark SQL批任务日志", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "SparkSQL唯一标识", "example": "d3018ad4-9a7e-4f64-a3f4-f38507c69742" }, { "name": "CustomKey", "type": "string", "required": false, "description": "用户自定义主键，若不为空，则按照该值进行查询", "example": "dje8ed4-9a7e-4f64-a3f4-f38507c69742" } ], "required": [ "BatchId" ] }, { "name": "DescribeStandardEngineResourceGroupConfigInfo", "description": "查询标准引擎资源组信息", "status": "online", "parameters": [ { "name": "SortBy", "type": "string", "required": false, "description": "排序字段", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "升序，降序", "example": "desc，asc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件可选，engine-resource-group-id--引擎资源组ID，engine-id---引擎ID", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "数据条数，默认10", "example": "无，" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "无，" } ], "required": [] }, { "name": "DescribeStandardEngineResourceGroups", "description": "查询标准引擎资源组信息", "status": "online", "parameters": [ { "name": "SortBy", "type": "string", "required": false, "description": "排序字段", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "升序，降序", "example": "desc，asc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件可选，app-id--用户appID，engine-resource-group-id--引擎资源组ID，data-engine-name--引擎名称，engine-resource-group-name---引擎资源组名称（模糊查询），engine-resource-group-state---引擎资源组状态engine-resource-group-name-unique --引擎资源组名称（完全匹配）", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "数据条数，默认10", "example": "无，" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "无，" } ], "required": [] }, { "name": "DescribeStoreLocation", "description": "查询计算结果存储位置。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSubUserAccessPolicy", "description": "本接口（DescribeSubUserAccessPolicy）用于开通了第三方平台访问的用户，查询其子用户的访问策略", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeTable", "description": "本接口（DescribeTable），用于查询单个表的详细信息。", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "查询对象表名称", "example": "table1" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "查询表所在的数据库名称。", "example": "database1" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "查询表所在的数据源名称", "example": "DataLakeCatalog" } ], "required": [ "TableName", "DatabaseName" ] }, { "name": "DescribeTablePartitions", "description": "本接口（DescribeTablePartitions）用于查询数据表分区信息", "status": "online", "parameters": [ { "name": "Catalog", "type": "string", "required": true, "description": "数据目录名称", "example": "DataLakeCatalog" }, { "name": "Database", "type": "string", "required": true, "description": "数据库名称", "example": "test_db" }, { "name": "Table", "type": "string", "required": true, "description": "数据表名称", "example": "test_tb" }, { "name": "Offset", "type": "integer", "required": true, "description": "查询偏移位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "当次查询的数量限制", "example": "10" }, { "name": "FuzzyPartition", "type": "string", "required": false, "description": "模糊查询的分区名称", "example": "2023-12-23" }, { "name": "Sorts", "type": "array", "required": false, "description": "排序信息", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": true, "description": "排序字段", "example": "create_time" }, { "name": "Asc", "type": "boolean", "required": true, "description": "是否按照ASC排序，否则DESC排序", "example": "true" } ] }, { "name": "Cursor", "type": "string", "required": false, "description": "分页查询的游标信息", "example": "pt=name" } ], "required": [ "Catalog", "Database", "Table", "Offset", "Limit" ] }, { "name": "DescribeTables", "description": "本接口（DescribeTables）用于查询数据表列表。", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "列出该数据库下所属数据表。", "example": "database1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为其一 table-name - String - （过滤条件）数据表名称,形如：table-001。 table-id - String - （过滤条件）table id形如：12342。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "指定查询的数据源名称，默认为DataLakeCatalog", "example": "DataLakeCatalog" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS", "example": "2006-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "终止时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS", "example": "2006-01-02 15:04:05" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，支持：CreateTime（创建时间）、UpdateTime（更新时间）、StorageSize（存储空间）、RecordCount（行数）、Name（表名称）（不传则默认按name升序）", "example": "UpdateTime" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序字段，false：降序（默认）；true：升序", "example": "false" }, { "name": "TableType", "type": "string", "required": false, "description": "table type，表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW", "example": "Table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "筛选字段-表格式：不传（默认）为查全部；LAKEFS：托管表；ICEBERG：非托管iceberg表；HIVE：非托管hive表；OTHER：非托管其它；", "example": "HIVE" }, { "name": "DescribeType", "type": "string", "required": false, "description": "查询类型：all：全部数据（默认）、permission：有权限的数据 注意：此字段需要开启白名单使用，如果需要使用，请提交工单联系我们。", "example": "all" } ], "required": [ "DatabaseName" ] }, { "name": "DescribeTablesName", "description": "本接口（DescribeTables）用于查询数据表名称列表", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "列出该数据库下所属数据表。", "example": "database1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为其一 table-name - String - （过滤条件）数据表名称,形如：table-001。 table-id - String - （过滤条件）table id形如：12342。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "指定查询的数据源名称，默认为DataLakeCatalog", "example": "DataLakeCatalog" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS", "example": "2006-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "终止时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS", "example": "2006-01-02 15:04:05" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，支持：CreateTime（创建时间）、UpdateTime（更新时间）、StorageSize（存储空间）、RecordCount（行数）、Name（表名称）（不传则默认按name升序）", "example": "UpdateTime" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序字段，false：降序（默认）；true：升序", "example": "false" }, { "name": "TableType", "type": "string", "required": false, "description": "table type，表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW", "example": "Table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "筛选字段-表格式：不传（默认）为查全部；LAKEFS：托管表；ICEBERG：非托管iceberg表；HIVE：非托管hive表；OTHER：非托管其它；", "example": "HIVE" } ], "required": [ "DatabaseName" ] }, { "name": "DescribeTaskList", "description": "该接口（DescribleTasks）用于查询任务列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个,其中task-id支持最大50个过滤个数，其他过滤参数支持的总数不超过5个。 task-id - String - （任务ID准确过滤）task-id取值形如：e386471f-139a-4e59-877f-50ece8135b99。 task-state - String - （任务状态过滤）取值范围 0(初始化)， 1(运行中)， 2(成功)， -1(失败)。 task-sql-keyword - String - （SQL语句关键字模糊过滤）取值形如：DROP TABLE。 task-op...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time（创建时间，默认）、update-time（更新时间）", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc。", "example": "desc" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻", "example": "2019-01-21 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近45天数据查询。默认为当前时刻", "example": "2019-01-22 00:00:00" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，用于筛选", "example": "shared_presto" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "spark引擎资源组名称", "example": "ResourceGroupName1" }, { "name": "HouseIds", "type": "array", "required": false, "description": "引擎id列表", "example": "[\"DataEngine-18j7ot11\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeTaskLog", "description": "本接口（DescribeTaskLog）用于获取spark 作业任务日志详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "列表返回的Id", "example": "eks-1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始运行时间，unix时间戳（毫秒）", "example": "165234344221" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束运行时间，unix时间戳（毫秒）", "example": "165234344221" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，最大1000，配合Context一起使用", "example": "100" }, { "name": "Context", "type": "string", "required": false, "description": "下一次分页参数，第一次传空。透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。", "example": "下一次分页参数" }, { "name": "Asc", "type": "boolean", "required": false, "description": "是否升序排列，true:升序排序，false:倒序，默认false，倒序排列", "example": "false" }, { "name": "Filters", "type": "array", "required": false, "description": "预览日志的通用过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "BatchId", "type": "string", "required": false, "description": "SparkSQL任务唯一ID", "example": "dsaj-dasjw-cxask-dasad" } ], "required": [ "TaskId", "StartTime", "EndTime", "Limit" ] }, { "name": "DescribeTaskMonitorInfos", "description": "查询任务监控指标信息", "status": "online", "parameters": [ { "name": "TaskIdList", "type": "array", "required": false, "description": "任务ID列表，上限50个", "example": "[\"bba8a49efe4911ef9e535254001a35f3\",\"bba8a49efe4911ef9e535254001a3523]", "item_type": "string" }, { "name": "HouseName", "type": "string", "required": false, "description": "引擎名称", "example": "uanalysis_dlc_presto_512s" }, { "name": "CreateTimeStart", "type": "string", "required": false, "description": "任务创建时间的起始时间", "example": "20250301" }, { "name": "CreateTimeEnd", "type": "string", "required": false, "description": "任务创建时间的结束时间", "example": "20250302" }, { "name": "Limit", "type": "integer", "required": false, "description": "每一页条数", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "100" } ], "required": [] }, { "name": "DescribeTaskResourceUsage", "description": "返回任务洞察资源用量", "status": "online", "parameters": [ { "name": "TaskInstanceId", "type": "string", "required": true, "description": "任务 id", "example": "87edc6a2-94a2-47fb-8044-3fdda2243c01" } ], "required": [ "TaskInstanceId" ] }, { "name": "DescribeTaskResult", "description": "查询任务结果，仅支持30天以内的任务查询结果，且返回数据大小超过近50M会进行截断。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务唯一ID，仅支持30天内的任务", "example": "fdd9c5fa21ca11eca6fb5254006c64af" }, { "name": "NextToken", "type": "string", "required": false, "description": "上一次请求响应返回的分页信息。第一次可以不带，从头开始返回数据，每次返回MaxResults字段设置的数据量。", "example": "nextToken=\\u0026nextKey=test/DLCQueryResults/2021/10/15/******" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "返回结果的最大行数，范围0~1000，默认为1000.", "example": "500" }, { "name": "IsTransformDataType", "type": "boolean", "required": false, "description": "是否转化数据类型", "example": "false" }, { "name": "DataFieldCutLen", "type": "integer", "required": false, "description": "返回结果集中字段长度截取，如果字段值长度超过该长度则截取到该长度", "example": "200" } ], "required": [ "TaskId" ] }, { "name": "DescribeTasks", "description": "该接口（DescribleTasks）用于查询任务列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个,其中task-id支持最大50个过滤个数，其他过滤参数支持的总数不超过5个。 task-id - String - （任务ID准确过滤）task-id取值形如：e386471f-139a-4e59-877f-50ece8135b99。 task-state - String - （任务状态过滤）取值范围 0(初始化)， 1(运行中)， 2(成功)， -1(失败)。 task-sql-keyword - String - （SQL语句关键字模糊过滤）取值形如：DROP TABLE。 task-op...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time（创建时间，默认）、update-time（更新时间）", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc。", "example": "desc" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻", "example": "2019-01-21 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近45天数据查询。默认为当前时刻", "example": "2019-01-22 00:00:00" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，用于筛选", "example": "shared_presto" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "spark引擎资源组名称", "example": "ResourceGroupName1" } ], "required": [] }, { "name": "DescribeTasksAnalysis", "description": "该接口用于洞察分析列表", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，用于筛选", "example": "shared_presto" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个: task-id - String - （任务ID准确过滤）task-id 取值形如：e386471f-139a-4e59-877f-50ece8135b99。task-state - String - （任务状态过滤）取值范围 0(初始化)， 1(运行中)， 2(成功)， -1(失败)，rule-id - String - （洞察类型）取值范围 SPARK-StageScheduleDelay（资源抢占）, SPARK-ShuffleFailure（Shuffle异常）, SPARK-SlowTask（慢task）, SPARK-DataSkew（数据倾斜\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，instance-start-time (任务开始时间）,job-time-sum （单位毫秒，引擎内执行耗时）,task-time-sum （CU资源消耗，单位秒）,input-bytes-sum（数据扫描总大小，单位bytes）,shuffle-read-bytes-sum（数据shuffle总大小，单位bytes）", "example": "instance-start-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc。", "example": "desc" }, { "name": "StartTime", "type": "string", "required": false, "description": "任务开始时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近30天数据查询。默认为当前时刻", "example": "2019-01-21 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近30天数据查询。默认为当前时刻", "example": "2019-01-22 00:00:00" } ], "required": [] }, { "name": "DescribeTasksCostInfo", "description": "该接口（DescribeTasksCostInfo）用于查询任务消耗", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个,其中task-id支持最大50个过滤个数，其他过滤参数支持的总数不超过5个。 task-id - String - （任务ID准确过滤）task-id取值形如：e386471f-139a-4e59-877f-50ece8135b99。 task-state - String - （任务状态过滤）取值范围 0(初始化)， 1(运行中)， 2(成功)， -1(失败)。 task-sql-keyword - String - （SQL语句关键字模糊过滤）取值形如：DROP TABLE。 task-op...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻", "example": "2019-01-21 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近45天数据查询。默认为当前时刻", "example": "2019-01-22 00:00:00" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，用于筛选", "example": "shared_presto" }, { "name": "SearchAfter", "type": "string", "required": false, "description": "下一页的标识", "example": "上一次返回的searchafter值" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页的大小", "example": "10000" } ], "required": [] }, { "name": "DescribeTasksOverview", "description": "查看任务概览页", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2022-08-30 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2022-08-30 00:00:002022-08-30 00:00:00" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "DataEngineName", "type": "string", "required": false, "description": "引擎名", "example": "dataengine-xx" }, { "name": "HouseIds", "type": "array", "required": false, "description": "DataEngine-dm8bjs29", "example": "[\"DataEngine-xx\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeThirdPartyAccessUser", "description": "本接口（RegisterThirdPartyAccessUser）查询开通第三方平台访问的用户信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeUDFPolicy", "description": "获取UDF权限信息", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "udf名称", "example": "udf1" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名(全局UDF：global-function)", "example": "database1" }, { "name": "CatalogName", "type": "string", "required": true, "description": "数据目录名", "example": "catalog1" } ], "required": [ "Name", "DatabaseName", "CatalogName" ] }, { "name": "DescribeUpdatableDataEngines", "description": "查询可更新配置的引擎列表", "status": "online", "parameters": [ { "name": "DataEngineConfigCommand", "type": "string", "required": true, "description": "引擎配置操作命令，UpdateSparkSQLLakefsPath 更新托管表路径，UpdateSparkSQLResultPath 更新结果桶路径", "example": "UpdateSparkSQLLakefsPath" }, { "name": "UseLakeFs", "type": "boolean", "required": false, "description": "是否使用托管存储作为结果存储", "example": "false" }, { "name": "CustomResultPath", "type": "string", "required": false, "description": "用户自定义结果存储路径", "example": "cosn://test-bucket/dir" } ], "required": [ "DataEngineConfigCommand" ] }, { "name": "DescribeUserDataEngineConfig", "description": "查询用户自定义引擎参数", "status": "online", "parameters": [ { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示倒序，asc表示正序", "example": "asc" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time", "example": "create-time" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个,每种过滤参数支持的过滤值不超过5个。 app-id - String - （appid过滤） engine-id - String - （引擎ID过滤）", "example": "[{\"Name\":\"engine-id\",\"Values\":[\"DataEngine-houseid\"]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeUserInfo", "description": "获取用户详细信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": false, "description": "用户Id", "example": "123098736" }, { "name": "Type", "type": "string", "required": false, "description": "必传字段，查询的信息类型，Group：工作组 DataAuth：数据权限 EngineAuth:引擎权限 RowFilter：行级别权限", "example": "Group" }, { "name": "Filters", "type": "array", "required": false, "description": "查询的过滤条件。 当Type为Group时，支持Key为workgroup-name的模糊搜索； 当Type为DataAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 data-name：库表的模糊搜索。 当Type为EngineAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 engine-name：库表的模糊搜索。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段。 当Type为Group时，支持create-time、group-name 当Type为DataAuth时，支持create-time 当Type为EngineAuth时，支持create-time", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [] }, { "name": "DescribeUserRegisterTime", "description": "该接口（DescribeUserRegisterTime）用于查询当前用户注册时间，并判断是否是老用户。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeUserRoles", "description": "列举用户角色信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "列举的数量限制", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "列举的偏移位置", "example": "0" }, { "name": "Fuzzy", "type": "string", "required": false, "description": "按照arn模糊列举", "example": "1" }, { "name": "SortBy", "type": "string", "required": false, "description": "返回结果按照该字段排序", "example": "modify-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "正序或者倒序，例如：desc", "example": "desc" }, { "name": "IsDefault", "type": "integer", "required": false, "description": "是否设置为常驻：1非常驻（默认）、2常驻（仅能设置一个常驻）", "example": "2" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeUserType", "description": "获取用户类型", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": false, "description": "用户ID（UIN），如果不填默认为调用方的子UIN", "example": "71109991241195" }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [] }, { "name": "DescribeUserVpcConnection", "description": "查询用户vpc到引擎网络的连接", "status": "online", "parameters": [ { "name": "EngineNetworkId", "type": "string", "required": true, "description": "引擎网络ID", "example": "DataEngine-Network-xxx" }, { "name": "DataEngineIds", "type": "array", "required": false, "description": "引擎ID集合", "example": "[\"DataEngine-mjmxxx\"]", "item_type": "string" }, { "name": "UserVpcEndpointIds", "type": "array", "required": false, "description": "终端节点ID集合", "example": "[\"vpce-h4czuhxx\"]", "item_type": "string" } ], "required": [ "EngineNetworkId" ] }, { "name": "DescribeUsers", "description": "获取用户列表信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": false, "description": "指定查询的子用户uin，用户需要通过CreateUser接口创建。", "example": "71109991241195" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值100", "example": "20" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc", "example": "desc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，支持如下字段类型，user-type：根据用户类型过滤。user-keyword：根据用户名称过滤", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [] }, { "name": "DescribeViews", "description": "本接口（DescribeViews）用于查询数据视图列表。", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "列出该数据库下所属数据表。", "example": "database1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，从0开始，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为其一 view-name - String - （过滤条件）数据表名称,形如：view-001。 view-id - String - （过滤条件）view id形如：12342。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据库所属的数据源名称", "example": "COSDataCatalog" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段", "example": "asc" }, { "name": "Asc", "type": "boolean", "required": false, "description": "排序规则，true:升序；false:降序", "example": "false" }, { "name": "StartTime", "type": "string", "required": false, "description": "按视图更新时间筛选，开始时间，如2021-11-11 00:00:00", "example": "2021-11-11 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "按视图更新时间筛选，结束时间，如2021-11-12 00:00:00", "example": "2021-11-11 00:00:00" }, { "name": "DescribeType", "type": "string", "required": false, "description": "查询类型：all：全部数据（默认）、permission：有权限的数据 注意：此字段需要开启白名单使用，如果需要使用，请提交工单联系我们。", "example": "all" } ], "required": [ "DatabaseName" ] }, { "name": "DescribeWorkGroupInfo", "description": "获取工作组详细信息", "status": "online", "parameters": [ { "name": "WorkGroupId", "type": "integer", "required": false, "description": "工作组Id", "example": "21" }, { "name": "Type", "type": "string", "required": false, "description": "查询信息类型：User：用户信息 DataAuth：数据权限 EngineAuth：引擎权限", "example": "User" }, { "name": "Filters", "type": "array", "required": false, "description": "查询的过滤条件。 当Type为User时，支持Key为user-name的模糊搜索； 当Type为DataAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 data-name：库表的模糊搜索。 当Type为EngineAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 engine-name：库表的模糊搜索。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段。 当Type为User时，支持create-time、user-name 当Type为DataAuth时，支持create-time 当Type为EngineAuth时，支持create-time", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" } ], "required": [] }, { "name": "DescribeWorkGroups", "description": "获取工作组列表", "status": "online", "parameters": [ { "name": "WorkGroupId", "type": "integer", "required": false, "description": "查询的工作组Id，不填或填0表示不过滤。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，当前仅支持按照工作组名称进行模糊搜索。Key为workgroup-name", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值100", "example": "20" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，支持如下字段类型，create-time", "example": "create-time" }, { "name": "Sorting", "type": "string", "required": false, "description": "排序方式，desc表示正序，asc表示反序， 默认为asc", "example": "desc" } ], "required": [] }, { "name": "DetachUserPolicy", "description": "解绑用户鉴权策略", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户Id，和CAM侧Uin匹配", "example": "andr*****@tencent.com" }, { "name": "PolicySet", "type": "array", "required": false, "description": "解绑的权限集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [ "UserId" ] }, { "name": "DetachWorkGroupPolicy", "description": "解绑工作组鉴权策略", "status": "online", "parameters": [ { "name": "WorkGroupId", "type": "integer", "required": true, "description": "工作组Id", "example": "1" }, { "name": "PolicySet", "type": "array", "required": false, "description": "解绑的权限集合", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] } ], "required": [ "WorkGroupId" ] }, { "name": "DropDMSDatabase", "description": "DMS元数据删除库", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "DeleteData", "type": "boolean", "required": false, "description": "是否删除数据", "example": "true" }, { "name": "Cascade", "type": "boolean", "required": false, "description": "是否级联删除", "example": "true" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [ "Name" ] }, { "name": "DropDMSPartitions", "description": "DMS元数据删除分区", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "SchemaName", "type": "string", "required": false, "description": "数据库Schema名称", "example": "schema1" }, { "name": "TableName", "type": "string", "required": false, "description": "数据表名称", "example": "table1" }, { "name": "Name", "type": "string", "required": false, "description": "分区名称", "example": "name1" }, { "name": "Values", "type": "array", "required": false, "description": "单个分区名称", "example": "[\"1\", \"2\"]", "item_type": "string" }, { "name": "DeleteData", "type": "boolean", "required": false, "description": "是否删除分区数据", "example": "false" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源连接名", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "DropDMSTable", "description": "DMS元数据删除表", "status": "online", "parameters": [ { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" }, { "name": "Name", "type": "string", "required": false, "description": "表名称", "example": "table1" }, { "name": "DeleteData", "type": "boolean", "required": false, "description": "是否删除数据", "example": "false" }, { "name": "EnvProps", "type": "object", "required": false, "description": "环境属性", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "配置的key值", "example": "format-version" }, { "name": "Value", "type": "string", "required": true, "description": "配置的value值", "example": "1" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据目录信息", "example": "DataLakeCatalog" } ], "required": [] }, { "name": "GenerateCreateMangedTableSql", "description": "生成创建托管表语句", "status": "online", "parameters": [ { "name": "TableBaseInfo", "type": "object", "required": true, "description": "表基本信息", "example": "无", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "该数据表所属数据库名字", "example": "database1" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表名字", "example": "table" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "该数据表所属数据源名字", "example": "CosDataCatalog" }, { "name": "TableComment", "type": "string", "required": false, "description": "该数据表备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "tb1501 描述aaa" }, { "name": "Type", "type": "string", "required": false, "description": "具体类型，表or视图", "example": "table" }, { "name": "TableFormat", "type": "string", "required": false, "description": "数据格式类型，hive，iceberg等", "example": "hive" }, { "name": "UserAlias", "type": "string", "required": false, "description": "建表用户昵称", "example": "aliaName" }, { "name": "UserSubUin", "type": "string", "required": false, "description": "建表用户ID", "example": "100019878767" }, { "name": "SmartPolicy", "type": "object", "required": false, "description": "智能数据治理配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略" } ] } ] }, { "name": "PrimaryKeys", "type": "array", "required": false, "description": "T-ICEBERG表的主键 注意：此字段可能返回 null，表示取不到有效值。", "example": "id", "item_type": "string" } ] }, { "name": "Columns", "type": "array", "required": true, "description": "表字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "column1" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "test comment" }, { "name": "Default", "type": "string", "required": false, "description": "字段默认值", "example": "ddefault value" }, { "name": "NotNull", "type": "boolean", "required": false, "description": "字段是否是非空", "example": "true" }, { "name": "Precision", "type": "integer", "required": false, "description": "表示整个 numeric 的长度,取值1-38", "example": "10" }, { "name": "Scale", "type": "integer", "required": false, "description": "表示小数部分的长度 Scale小于Precision", "example": "2" }, { "name": "Position", "type": "integer", "required": false, "description": "字段位置，小的在前", "example": "1" }, { "name": "IsPartition", "type": "boolean", "required": false, "description": "是否为分区字段", "example": "false" } ] }, { "name": "Partitions", "type": "array", "required": false, "description": "表分区信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "patition1" }, { "name": "Type", "type": "string", "required": false, "description": "字段类型", "example": "string" }, { "name": "Comment", "type": "string", "required": false, "description": "字段描述", "example": "default comment" }, { "name": "PartitionType", "type": "string", "required": false, "description": "分区类型（已废弃）", "example": "string" }, { "name": "PartitionFormat", "type": "string", "required": false, "description": "分区格式（已废弃）", "example": "bucket" }, { "name": "PartitionDot", "type": "integer", "required": false, "description": "分区分隔数（已废弃）", "example": "2" }, { "name": "Transform", "type": "string", "required": false, "description": "分区转换策略", "example": "bucket" }, { "name": "TransformArgs", "type": "array", "required": false, "description": "策略参数", "example": "2", "item_type": "string" } ] }, { "name": "Properties", "type": "array", "required": false, "description": "表属性信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性key名称。", "example": "owner" }, { "name": "Value", "type": "string", "required": true, "description": "属性key对应的value。", "example": "create by zhangsan" } ] }, { "name": "UpsertKeys", "type": "array", "required": false, "description": "V2 upsert表 upsert键", "example": "[\"col1\",col2\"\"]", "item_type": "string" } ], "required": [ "TableBaseInfo", "Columns" ] }, { "name": "GetOptimizerPolicy", "description": "GetOptimizerPolicy", "status": "online", "parameters": [ { "name": "SmartPolicy", "type": "object", "required": true, "description": "策略描述", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "AttributionType", "type": "string", "required": false, "description": "归属类型", "example": "group" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型", "example": "spark-sql" }, { "name": "Name", "type": "string", "required": false, "description": "引擎名称", "example": "引擎名称" }, { "name": "Instance", "type": "string", "required": false, "description": "如资源类型为spark-sql 取值为Name, 如为spark-batch 取值为session app_name", "example": "spark-sql" }, { "name": "Favor", "type": "array", "required": false, "description": "亲和性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Status", "type": "integer", "required": false, "description": "状态", "example": "1" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "标准引擎资源组信息", "example": "rg-test" }, { "name": "ResourceConf", "type": "object", "required": false, "description": "资源配置信息", "example": "无" } ] }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "WrittenEnable", "type": "string", "required": false, "description": "none/enable/disable/default", "example": "enable" }, { "name": "AdvancePolicy", "type": "object", "required": false, "description": "用户自定义高级参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LifecycleEnable", "type": "string", "required": false, "description": "生命周期启用", "example": "none/enable/disable/default" }, { "name": "Expiration", "type": "integer", "required": false, "description": "过期时间", "example": "100" }, { "name": "ExpiredField", "type": "string", "required": false, "description": "过期字段", "example": "pt" }, { "name": "ExpiredFieldFormat", "type": "string", "required": false, "description": "过期字段格式", "example": "yyyy-MM-dd" } ] }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "IndexEnable", "type": "string", "required": false, "description": "开启索引", "example": "none/enable/disable/default" } ] }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "DataRetentionTime", "type": "integer", "required": false, "description": "change表的数据保存时间，单位为天", "example": "8" } ] }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用策略", "example": "true" }, { "name": "Expiration", "type": "integer", "required": true, "description": "表过期时间，单位：天", "example": "30" } ] } ] } ] } ], "required": [ "SmartPolicy" ] }, { "name": "GrantDLCCatalogAccess", "description": "授权访问DLC Catalog", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "授权VpcId", "example": "vpc-123456" }, { "name": "Product", "type": "string", "required": true, "description": "产品(EMR|DLC|Doris|Inlong|Wedata)", "example": "EMR" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "生产环境" }, { "name": "VpcUin", "type": "string", "required": false, "description": "VPC所属账号UIN", "example": "12345678" }, { "name": "VpcAppId", "type": "integer", "required": false, "description": "VPC所属账号AppId", "example": "12345678" } ], "required": [ "VpcId", "Product" ] }, { "name": "LaunchStandardEngineResourceGroups", "description": "启动标准引擎资源组", "status": "online", "parameters": [ { "name": "EngineResourceGroupNames", "type": "array", "required": true, "description": "标准引擎资源组名称", "example": "无", "item_type": "string" } ], "required": [ "EngineResourceGroupNames" ] }, { "name": "ListTaskJobLogDetail", "description": "本接口（ListTaskJobLogDetail）用于获取spark 作业任务日志详情", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始运行时间，unix时间戳（毫秒）", "example": "165234344221" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束运行时间，unix时间戳（毫秒）", "example": "165234344221" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，最大1000，配合Context一起使用", "example": "100" }, { "name": "Context", "type": "string", "required": true, "description": "下一次分页参数，第一次传空", "example": "null" }, { "name": "TaskId", "type": "string", "required": false, "description": "列表返回的Id", "example": "eks-1" }, { "name": "Asc", "type": "boolean", "required": false, "description": "最近1000条日志是否升序排列，true:升序排序，false:倒序，默认false，倒序排列", "example": "false" }, { "name": "Filters", "type": "array", "required": false, "description": "预览日志的通用过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "BatchId", "type": "string", "required": false, "description": "SparkSQL任务唯一ID", "example": "dsaj-dasjw-cxask-dasad" }, { "name": "DataEngineId", "type": "string", "required": false, "description": "引擎id", "example": "DataEngine-lhfhljx" }, { "name": "ResourceGroupId", "type": "string", "required": false, "description": "资源组id", "example": "rg-jlfhtlv" } ], "required": [ "StartTime", "EndTime", "Limit", "Context" ] }, { "name": "ListTaskJobLogName", "description": "本接口（ListTaskJobLogName）用于获取spark-jar日志名称列表", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "查询的taskId", "example": "eks-1" }, { "name": "BatchId", "type": "string", "required": false, "description": "SparkSQL批任务唯一ID", "example": "dsdde-dsada-xxsda-sdask2" } ], "required": [ "TaskId" ] }, { "name": "LockMetaData", "description": "元数据锁", "status": "online", "parameters": [ { "name": "LockComponentList", "type": "array", "required": true, "description": "加锁内容", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "数据库名称", "example": "db" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "table" }, { "name": "Partition", "type": "string", "required": false, "description": "分区", "example": "part" }, { "name": "LockType", "type": "string", "required": false, "description": "锁类型：SHARED_READ、SHARED_WRITE、EXCLUSIVE", "example": "SHARED_READ" }, { "name": "LockLevel", "type": "string", "required": false, "description": "锁级别：DB、TABLE、PARTITION", "example": "DB" }, { "name": "DataOperationType", "type": "string", "required": false, "description": "锁操作：SELECT,INSERT,UPDATE,DELETE,UNSET,NO_TXN", "example": "SELECT" }, { "name": "IsAcid", "type": "boolean", "required": false, "description": "是否保持Acid", "example": "false" }, { "name": "IsDynamicPartitionWrite", "type": "boolean", "required": false, "description": "是否动态分区写", "example": "false" } ] }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称", "example": "DataLakeCatalog" }, { "name": "TxnId", "type": "integer", "required": false, "description": "事务id", "example": "1" }, { "name": "AgentInfo", "type": "string", "required": false, "description": "客户端信息", "example": "Unknown" }, { "name": "Hostname", "type": "string", "required": false, "description": "主机名", "example": "dlc" } ], "required": [ "LockComponentList" ] }, { "name": "ModifyAdvancedStoreLocation", "description": "修改sql查询界面高级设置。", "status": "online", "parameters": [ { "name": "StoreLocation", "type": "string", "required": true, "description": "查询结果保存cos路径", "example": "cosn://xx/xx/xx" }, { "name": "Enable", "type": "integer", "required": true, "description": "是否启用高级设置：0-否，1-是", "example": "1" } ], "required": [ "StoreLocation", "Enable" ] }, { "name": "ModifyDataEngineDescription", "description": "修改引擎描述信息", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "要修改的引擎的名称", "example": "DataEngine-xxx" }, { "name": "Message", "type": "string", "required": true, "description": "引擎的描述信息，最大长度为250", "example": "test-engine" } ], "required": [ "DataEngineName", "Message" ] }, { "name": "ModifyGovernEventRule", "description": "修改数据治理事件阈值", "status": "online", "parameters": [], "required": [] }, { "name": "ModifySparkApp", "description": "更新spark作业", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "spark作业名", "example": "app-test" }, { "name": "AppType", "type": "integer", "required": true, "description": "spark作业类型，1代表spark jar作业，2代表spark streaming作业", "example": "1,2" }, { "name": "DataEngine", "type": "string", "required": true, "description": "执行spark作业的数据引擎名称", "example": "spark-engine" }, { "name": "AppFile", "type": "string", "required": true, "description": "spark作业程序包文件路径", "example": "test.jar" }, { "name": "RoleArn", "type": "integer", "required": true, "description": "数据访问策略，CAM Role arn", "example": "12" }, { "name": "AppDriverSize", "type": "string", "required": true, "description": "指定的Driver规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "AppExecutorSize", "type": "string", "required": true, "description": "指定的Executor规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu）", "example": "small" }, { "name": "AppExecutorNums", "type": "integer", "required": true, "description": "spark作业executor个数", "example": "1" }, { "name": "SparkAppId", "type": "string", "required": true, "description": "spark作业Id", "example": "batch_ssta" }, { "name": "Eni", "type": "string", "required": false, "description": "该字段已下线，请使用字段Datasource", "example": "kafka-datasource" }, { "name": "IsLocal", "type": "string", "required": false, "description": "spark作业程序包是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "MainClass", "type": "string", "required": false, "description": "spark作业主类", "example": "org.test.WordCount" }, { "name": "AppConf", "type": "string", "required": false, "description": "spark配置，以换行符分隔", "example": "spark.default.parallelism=2000" }, { "name": "IsLocalJars", "type": "string", "required": false, "description": "spark 作业依赖jar包是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppJars", "type": "string", "required": false, "description": "spark 作业依赖jar包（--jars），以逗号分隔", "example": "com.test.jar" }, { "name": "IsLocalFiles", "type": "string", "required": false, "description": "spark作业依赖文件资源是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppFiles", "type": "string", "required": false, "description": "spark作业依赖文件资源（--files）（非jar、zip），以逗号分隔", "example": "spark-default.properties" }, { "name": "IsLocalPythonFiles", "type": "string", "required": false, "description": "pyspark：依赖上传方式，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppPythonFiles", "type": "string", "required": false, "description": "pyspark作业依赖python资源（--py-files），支持py/zip/egg等归档格式，多文件以逗号分隔", "example": "test.py" }, { "name": "CmdArgs", "type": "string", "required": false, "description": "spark作业程序入参", "example": "10" }, { "name": "MaxRetries", "type": "integer", "required": false, "description": "最大重试次数，只对spark流任务生效", "example": "1" }, { "name": "DataSource", "type": "string", "required": false, "description": "数据源名", "example": "kafka-datasource" }, { "name": "IsLocalArchives", "type": "string", "required": false, "description": "spark作业依赖archives资源是否本地上传，cos：存放与cos，lakefs：本地上传（控制台使用，该方式不支持直接接口调用）", "example": "cos" }, { "name": "AppArchives", "type": "string", "required": false, "description": "spark作业依赖archives资源（--archives），支持tar.gz/tgz/tar等归档格式，以逗号分隔", "example": "file1.tar.gz#abc" }, { "name": "SparkImage", "type": "string", "required": false, "description": "Spark Image 版本号", "example": "1.0" }, { "name": "SparkImageVersion", "type": "string", "required": false, "description": "Spark Image 版本名称", "example": "spark:3.2.1-java " }, { "name": "AppExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定的Executor数量（最大值），默认为1，当开启动态分配有效，若未开启，则该值等于AppExecutorNums", "example": "1" }, { "name": "SessionId", "type": "string", "required": false, "description": "关联dlc查询脚本", "example": "dshd-dsdw-deksa-2esd-edsaw" }, { "name": "IsInherit", "type": "integer", "required": false, "description": "任务资源配置是否继承集群配置模板：0（默认）不继承、1：继承", "example": "0" }, { "name": "IsSessionStarted", "type": "boolean", "required": false, "description": "是否使用session脚本的sql运行任务：false：否，true：是", "example": "false" }, { "name": "DependencyPackages", "type": "array", "required": false, "description": "标准引擎依赖包", "example": "无", "item_type": "object", "children": [ { "name": "PackageSource", "type": "string", "required": false, "description": "依赖包类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "Maven" }, { "name": "MavenPackage", "type": "string", "required": false, "description": "依赖包信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "com.hedera.hashgraph:hapi:0.61.3" }, { "name": "MavenRepository", "type": "string", "required": false, "description": "依赖包仓库 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://mirrors.cloud.tencent.com/nexus/repository/maven-public" }, { "name": "MavenExclusion", "type": "string", "required": false, "description": "maven包exclusion信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "json:json" }, { "name": "PypiPackage", "type": "string", "required": false, "description": "pypi包信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "requests" }, { "name": "PypiIndexUrl", "type": "string", "required": false, "description": "pypi索引地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://pypi.org/simple" }, { "name": "PackageType", "type": "string", "required": false, "description": "文件包的类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "jar" }, { "name": "PackagePath", "type": "string", "required": false, "description": "文件包的路径 注意：此字段可能返回 null，表示取不到有效值。", "example": "cosn://a/b/c.jar" } ] } ], "required": [ "AppName", "AppType", "DataEngine", "AppFile", "RoleArn", "AppDriverSize", "AppExecutorSize", "AppExecutorNums", "SparkAppId" ] }, { "name": "ModifySparkAppBatch", "description": "本接口（ModifySparkAppBatch）用于批量修改Spark作业参数配置", "status": "online", "parameters": [ { "name": "SparkAppId", "type": "array", "required": true, "description": "需要批量修改的Spark作业任务ID列表", "example": "batch_8ec20f53-999a-4ba5-aa6b-15945dssa4ae8,batch_f8a0aa7f-8ed8-4775-9ac0-0c2c9ke23b05d", "item_type": "string" }, { "name": "DataEngine", "type": "string", "required": false, "description": "引擎ID", "example": "DataEngine-dr6udevq" }, { "name": "AppDriverSize", "type": "string", "required": false, "description": "driver规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "AppExecutorSize", "type": "string", "required": false, "description": "executor规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "AppExecutorNums", "type": "integer", "required": false, "description": "指定executor数量，最小值为1，最大值小于集群规格", "example": "1" }, { "name": "AppExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定executor max数量（动态配置场景下），最小值为1，最大值小于集群规格（当ExecutorMaxNumbers小于ExecutorNums时，改值设定为ExecutorNums）", "example": "1" }, { "name": "IsInherit", "type": "integer", "required": false, "description": "任务资源配置是否继承集群模板，0（默认）不继承，1：继承", "example": "0" } ], "required": [ "SparkAppId" ] }, { "name": "ModifyUser", "description": "修改用户信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户Id，和CAM侧Uin匹配", "example": "1000xxxx8195" }, { "name": "UserDescription", "type": "string", "required": true, "description": "用户描述", "example": "for test" }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [ "UserId", "UserDescription" ] }, { "name": "ModifyUserType", "description": "修改用户类型。只有管理员用户能够调用该接口进行操作", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "182xxxxx342" }, { "name": "UserType", "type": "string", "required": true, "description": "用户要修改到的类型，ADMIN：管理员，COMMON：一般用户。", "example": "ADMIN" }, { "name": "AccountType", "type": "string", "required": false, "description": "用户来源类型TencentAccount（普通腾讯云用户） / EntraAccount（微软用户）", "example": "EntraAccount" } ], "required": [ "UserId", "UserType" ] }, { "name": "ModifyWorkGroup", "description": "修改工作组信息", "status": "online", "parameters": [ { "name": "WorkGroupId", "type": "integer", "required": true, "description": "工作组Id", "example": "1" }, { "name": "WorkGroupDescription", "type": "string", "required": true, "description": "工作组描述，最大字符数限制50", "example": "for test" } ], "required": [ "WorkGroupId", "WorkGroupDescription" ] }, { "name": "PauseStandardEngineResourceGroups", "description": "暂停标准引擎session", "status": "online", "parameters": [ { "name": "EngineResourceGroupNames", "type": "array", "required": true, "description": "标准引擎资源组名称", "example": "无", "item_type": "string" } ], "required": [ "EngineResourceGroupNames" ] }, { "name": "QueryInternalTableWarehouse", "description": "本接口（QueryInternalTableWarehouse）用于获取原生表warehouse路径", "status": "online", "parameters": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "库名", "example": "db_test" }, { "name": "TableName", "type": "string", "required": true, "description": "表名", "example": "tb_test" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "catalog名称", "example": "tb_catalog" } ], "required": [ "DatabaseName", "TableName" ] }, { "name": "QueryResult", "description": "获取任务结果查询", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "20210521195919442157" }, { "name": "NextToken", "type": "string", "required": false, "description": "objectListMarker={marker}\u0026lastReadFile={filename}\u0026lastReadOffsetlastReadFile为上一次读取的文件，lastReadOffset为上一次读取到的位置", "example": "objectListMarker={marker}\u0026lastReadFile={filename}\u0026lastReadOffset" } ], "required": [ "TaskId" ] }, { "name": "QueryTaskCostDetail", "description": "该接口（QueryTaskCostDetail）用于查询任务消耗明细", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，如下支持的过滤类型，传参Name应为以下其中一个,其中task-id支持最大50个过滤个数，其他过滤参数支持的总数不超过5个。 task-id - String - （任务ID准确过滤）task-id取值形如：e386471f-139a-4e59-877f-50ece8135b99。 task-state - String - （任务状态过滤）取值范围 0(初始化)， 1(运行中)， 2(成功)， -1(失败)。 task-sql-keyword - String - （SQL语句关键字模糊过滤）取值形如：DROP TABLE。 task-op...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑或（OR）关系。", "example": "house_name" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "dlc-engine", "item_type": "string" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻", "example": "2019-01-21 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近45天数据查询。默认为当前时刻", "example": "2019-01-22 00:00:00" }, { "name": "DataEngineName", "type": "string", "required": false, "description": "数据引擎名称，用于筛选", "example": "shared_presto" }, { "name": "SearchAfter", "type": "string", "required": false, "description": "下一页的标识", "example": "1739778196761" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页的大小", "example": "10000" } ], "required": [] }, { "name": "RegisterThirdPartyAccessUser", "description": "本接口（RegisterThirdPartyAccessUser）用于开通第三方平台访问", "status": "online", "parameters": [], "required": [] }, { "name": "RenewDataEngine", "description": "续费数据引擎", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "CU队列名称", "example": "test_engine" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "续费时长，单位月，最少续费1一个月", "example": "1" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费类型，默认为1，预付费", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "单位，默认m，仅能填m", "example": "m" }, { "name": "RenewFlag", "type": "integer", "required": false, "description": "自动续费标志，0，初始状态，默认不自动续费，若用户有预付费不停服特权，自动续费。1：自动续费。2：明确不自动续费。不传该参数默认为0", "example": "0" } ], "required": [ "DataEngineName", "TimeSpan" ] }, { "name": "ReportHeartbeatMetaData", "description": "上报元数据心跳", "status": "online", "parameters": [ { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称", "example": "DataLakeCatalog" }, { "name": "LockId", "type": "integer", "required": false, "description": "锁ID", "example": "1" }, { "name": "TxnId", "type": "integer", "required": false, "description": "事务ID", "example": "1" } ], "required": [] }, { "name": "RestartDataEngine", "description": "重启引擎", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎ID", "example": "DataEngine-xxx" }, { "name": "ForcedOperation", "type": "boolean", "required": false, "description": "是否强制重启，忽略任务", "example": "false" } ], "required": [ "DataEngineId" ] }, { "name": "RevokeDLCCatalogAccess", "description": "撤销DLC Catalog访问权限", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VpcID", "example": "vpc-12345678" } ], "required": [ "VpcId" ] }, { "name": "RollbackDataEngineImage", "description": "回滚引擎镜像版本", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎ID", "example": "DataEngine-eexf" }, { "name": "FromRecordId", "type": "string", "required": false, "description": "检查是否能回滚的接口返回的FromRecordId参数", "example": "a7ac834a-501d-486b-8c9b-128df3479382" }, { "name": "ToRecordId", "type": "string", "required": false, "description": "检查是否能回滚的接口返回的ToRecordId参数", "example": "fb544b43-30d2-4b56-a289-4819370a5bcc" } ], "required": [ "DataEngineId" ] }, { "name": "SetOptimizerPolicy", "description": "设置优化策略的接口", "status": "online", "parameters": [ { "name": "SmartPolicy", "type": "object", "required": true, "description": "优化策略", "example": "无", "children": [ { "name": "BaseInfo", "type": "object", "required": false, "description": "基础信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Uin", "type": "string", "required": true, "description": "用户uin", "example": "100011282005" }, { "name": "PolicyType", "type": "string", "required": false, "description": "Catalog/Database/Table", "example": "Table" }, { "name": "Catalog", "type": "string", "required": false, "description": "Catalog名称", "example": " DataLakeCatalog" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名称", "example": "dbtest" }, { "name": "Table", "type": "string", "required": false, "description": "表名称", "example": "tbtest" }, { "name": "AppId", "type": "string", "required": false, "description": "用户appid", "example": "1" } ] }, { "name": "Policy", "type": "object", "required": false, "description": "策略描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Inherit", "type": "string", "required": false, "description": "是否继承", "example": "true" }, { "name": "Resources", "type": "array", "required": false, "description": "数据治理资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "AttributionType", "type": "string", "required": false, "description": "归属类型", "example": "group" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型", "example": "spark-sql" }, { "name": "Name", "type": "string", "required": false, "description": "引擎名称", "example": "引擎名称" }, { "name": "Instance", "type": "string", "required": false, "description": "如资源类型为spark-sql 取值为Name, 如为spark-batch 取值为session app_name", "example": "spark-sql" }, { "name": "Favor", "type": "array", "required": false, "description": "亲和性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Status", "type": "integer", "required": false, "description": "状态", "example": "1" }, { "name": "ResourceGroupName", "type": "string", "required": false, "description": "标准引擎资源组信息", "example": "rg-test" }, { "name": "ResourceConf", "type": "object", "required": false, "description": "资源配置信息", "example": "无" } ] }, { "name": "Written", "type": "object", "required": false, "description": "数据重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "WrittenEnable", "type": "string", "required": false, "description": "none/enable/disable/default", "example": "enable" }, { "name": "AdvancePolicy", "type": "object", "required": false, "description": "用户自定义高级参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Lifecycle", "type": "object", "required": false, "description": "数据过期策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LifecycleEnable", "type": "string", "required": false, "description": "生命周期启用", "example": "none/enable/disable/default" }, { "name": "Expiration", "type": "integer", "required": false, "description": "过期时间", "example": "100" }, { "name": "ExpiredField", "type": "string", "required": false, "description": "过期字段", "example": "pt" }, { "name": "ExpiredFieldFormat", "type": "string", "required": false, "description": "过期字段格式", "example": "yyyy-MM-dd" } ] }, { "name": "Index", "type": "object", "required": false, "description": "SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "IndexEnable", "type": "string", "required": false, "description": "开启索引", "example": "none/enable/disable/default" } ] }, { "name": "ChangeTable", "type": "object", "required": false, "description": "SmartOptimizerChangeTablePolicy 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "DataRetentionTime", "type": "integer", "required": false, "description": "change表的数据保存时间，单位为天", "example": "8" } ] }, { "name": "TableExpiration", "type": "object", "required": false, "description": "表过期策略", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否启用策略", "example": "true" }, { "name": "Expiration", "type": "integer", "required": true, "description": "表过期时间，单位：天", "example": "30" } ] } ] } ] } ], "required": [ "SmartPolicy" ] }, { "name": "SuspendResumeDataEngine", "description": "本接口用于控制挂起或启动数据引擎", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "虚拟集群名称", "example": "testHouse" }, { "name": "Operate", "type": "string", "required": true, "description": "操作类型 suspend/resume", "example": "suspend" } ], "required": [ "DataEngineName", "Operate" ] }, { "name": "SwitchDataEngine", "description": "切换主备集群", "status": "online", "parameters": [ { "name": "DataEngineName", "type": "string", "required": true, "description": "主集群名称", "example": "dlc" }, { "name": "StartStandbyCluster", "type": "boolean", "required": true, "description": "是否开启备集群", "example": "false" } ], "required": [ "DataEngineName", "StartStandbyCluster" ] }, { "name": "SwitchDataEngineImage", "description": "切换引擎镜像版本", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎ID", "example": "DataEngine-kxxxxr13" }, { "name": "NewImageVersionId", "type": "string", "required": true, "description": "新镜像版本ID", "example": "7ac9cc78-bc95-440f-9768-4f4a79048755" } ], "required": [ "DataEngineId", "NewImageVersionId" ] }, { "name": "UnbindWorkGroupsFromUser", "description": "解绑用户上的用户组", "status": "online", "parameters": [ { "name": "AddInfo", "type": "object", "required": true, "description": "解绑的工作组Id和用户Id的关联关系", "example": "无", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户Id，和CAM侧Uin匹配", "example": "“12345678”" }, { "name": "WorkGroupIds", "type": "array", "required": true, "description": "工作组Id集合", "example": "[1,2,3]", "item_type": "integer" } ] } ], "required": [ "AddInfo" ] }, { "name": "UnboundDatasourceHouse", "description": "解绑数据源与队列", "status": "online", "parameters": [ { "name": "NetworkConnectionName", "type": "string", "required": false, "description": "网络配置名称", "example": "connection_tmp" } ], "required": [] }, { "name": "UnlockMetaData", "description": "元数据解锁", "status": "online", "parameters": [ { "name": "LockId", "type": "integer", "required": true, "description": "锁ID", "example": "1" }, { "name": "DatasourceConnectionName", "type": "string", "required": false, "description": "数据源名称", "example": "DataLakeCatalog" } ], "required": [ "LockId" ] }, { "name": "UpdateDataEngine", "description": "本接口用于更新数据引擎配置", "status": "online", "parameters": [ { "name": "Size", "type": "integer", "required": true, "description": "资源大小", "example": "10" }, { "name": "MinClusters", "type": "integer", "required": true, "description": "最小资源", "example": "1" }, { "name": "MaxClusters", "type": "integer", "required": true, "description": "最大资源", "example": "10" }, { "name": "AutoResume", "type": "boolean", "required": true, "description": "开启自动刷新：true：开启、false（默认）：关闭", "example": "true" }, { "name": "DataEngineName", "type": "string", "required": true, "description": "数据引擎名称", "example": "engine_presto\"" }, { "name": "Message", "type": "string", "required": true, "description": "相关信息", "example": "autotest_engine_test2" }, { "name": "AutoSuspend", "type": "boolean", "required": false, "description": "是否自定挂起集群：false（默认）：不自动挂起、true：自动挂起", "example": "false" }, { "name": "CrontabResumeSuspend", "type": "integer", "required": false, "description": "定时启停集群策略：0（默认）：关闭定时策略、1：开启定时策略（注：定时启停策略与自动挂起策略互斥）", "example": "1" }, { "name": "CrontabResumeSuspendStrategy", "type": "object", "required": false, "description": "定时启停策略，复杂类型：包含启停时间、挂起集群策略", "example": "无", "children": [ { "name": "ResumeTime", "type": "string", "required": false, "description": "定时拉起时间：如：周一\u0026周三8点", "example": "0000101-08:00:00" }, { "name": "SuspendTime", "type": "string", "required": false, "description": "定时挂起时间：如：周一\u0026周三20点", "example": "0000101-20:00:00" }, { "name": "SuspendStrategy", "type": "integer", "required": false, "description": "挂起配置：0（默认）：等待任务结束后挂起、1：强制挂起", "example": "0" } ] }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "单个集群最大并发任务数，默认5", "example": "5" }, { "name": "TolerableQueueTime", "type": "integer", "required": false, "description": "可容忍的排队时间，默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0，则表示一旦有任务排队就可能立即触发扩容。", "example": "0" }, { "name": "AutoSuspendTime", "type": "integer", "required": false, "description": "集群自动挂起时间", "example": "10" }, { "name": "ElasticSwitch", "type": "boolean", "required": false, "description": "spark jar 包年包月集群是否开启弹性", "example": "false" }, { "name": "ElasticLimit", "type": "integer", "required": false, "description": "spark jar 包年包月集群弹性上限", "example": "0" }, { "name": "SessionResourceTemplate", "type": "object", "required": false, "description": "Spark批作业集群Session资源配置模板", "example": "无", "children": [ { "name": "DriverSize", "type": "string", "required": false, "description": "driver规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "executor规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorNums", "type": "integer", "required": false, "description": "指定executor数量，最小值为1，最大值小于集群规格", "example": "1" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定executor max数量（动态配置场景下），最小值为1，最大值小于集群规格（当ExecutorMaxNumbers小于ExecutorNums时，改值设定为ExecutorNums）", "example": "1" }, { "name": "RunningTimeParameters", "type": "array", "required": false, "description": "运行时参数", "example": "复杂类型", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] } ] }, { "name": "ScheduleElasticityConf", "type": "object", "required": false, "description": "引擎资源弹性伸缩策略", "example": "无", "children": [ { "name": "ScheduledElasticityEnabled", "type": "boolean", "required": false, "description": "是否开启弹性伸缩：true/false", "example": "true" }, { "name": "ScheduleType", "type": "string", "required": false, "description": "调度类型：ONCE（一次性调度），DAILY（每日调度），WEEKLY（每周调度），MONTHLY（每月调度）", "example": "WEEKLY" }, { "name": "ScheduleDays", "type": "array", "required": false, "description": "调度日期：WEEKLY传：1~7； MONTHLY传:1~31；其它类型不传", "example": "[1]", "item_type": "integer" }, { "name": "TimeZone", "type": "string", "required": false, "description": "调度时区", "example": "UTC+08:00（北京）" }, { "name": "ElasticPlans", "type": "array", "required": false, "description": "弹性伸缩计划", "example": "无", "item_type": "object", "children": [ { "name": "MinElasticClusters", "type": "integer", "required": false, "description": "最小集群数", "example": "1" }, { "name": "MaxElasticClusters", "type": "integer", "required": false, "description": "最大集群数", "example": "10" }, { "name": "TolerableQueueTime", "type": "integer", "required": false, "description": "最大排队时间", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，Once格式：yyyy-MM-dd HH:mm:ss; 非Once格式： HH:mm:ss", "example": "21:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，Once格式：yyyy-MM-dd HH:mm:ss; 非Once格式： HH:mm:ss", "example": "22:00:00" }, { "name": "ElasticLimit", "type": "integer", "required": false, "description": "分时弹性上限", "example": "16" } ] } ] } ], "required": [ "Size", "MinClusters", "MaxClusters", "AutoResume", "DataEngineName", "Message" ] }, { "name": "UpdateDataEngineConfig", "description": "用户某种操作，触发引擎配置修改", "status": "online", "parameters": [ { "name": "DataEngineIds", "type": "array", "required": true, "description": "引擎ID", "example": "DataEngine-xxx", "item_type": "string" }, { "name": "DataEngineConfigCommand", "type": "string", "required": true, "description": "引擎配置命令，支持UpdateSparkSQLLakefsPath（更新原生表配置）、UpdateSparkSQLResultPath（更新结果路径配置）", "example": "UpdateSparkSQLLakefsPath" }, { "name": "UseLakeFs", "type": "boolean", "required": false, "description": "是否使用lakefs作为结果存储", "example": "false" }, { "name": "CustomResultPath", "type": "string", "required": false, "description": "用户自定义结果路径", "example": "cosn://test-bucket/dir" } ], "required": [ "DataEngineIds", "DataEngineConfigCommand" ] }, { "name": "UpdateDataMaskStrategy", "description": "更新数据脱敏策略", "status": "online", "parameters": [ { "name": "Strategy", "type": "object", "required": false, "description": "数据脱敏策略详情", "example": "无", "children": [ { "name": "StrategyName", "type": "string", "required": false, "description": "策略名称", "example": "策略1" }, { "name": "StrategyType", "type": "string", "required": false, "description": "MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等", "example": "MASK_SHOW_FIRST_4" }, { "name": "StrategyDesc", "type": "string", "required": false, "description": "策略描述", "example": "for testing purpose" }, { "name": "Groups", "type": "array", "required": false, "description": "用户组策略列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "WorkGroupId", "type": "integer", "required": false, "description": "用户组ID", "example": "212123" }, { "name": "StrategyType", "type": "string", "required": false, "description": "策略类型", "example": "MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等" } ] }, { "name": "Users", "type": "string", "required": false, "description": "用户子账号uin列表，按;拼接", "example": "12312314112;1231231231" }, { "name": "StrategyId", "type": "string", "required": false, "description": "策略Id", "example": "1" } ] } ], "required": [] }, { "name": "UpdateEngineResourceGroupNetworkConfigInfo", "description": "更新标准引擎资源组网络配置信息", "status": "online", "parameters": [ { "name": "EngineResourceGroupId", "type": "string", "required": true, "description": "引擎资源组ID", "example": "无" }, { "name": "IsEffectiveNow", "type": "integer", "required": true, "description": "是否立即重启资源组生效，0--立即生效，1--只保持不重启生效", "example": "无" }, { "name": "NetworkConfigNames", "type": "array", "required": false, "description": "资源组绑定的网络配置名称集合", "example": "无", "item_type": "string" } ], "required": [ "EngineResourceGroupId", "IsEffectiveNow" ] }, { "name": "UpdateNetworkConnection", "description": "更新网络配置", "status": "online", "parameters": [ { "name": "NetworkConnectionDesc", "type": "string", "required": false, "description": "网络配置描述", "example": "test" }, { "name": "NetworkConnectionName", "type": "string", "required": false, "description": "网络配置名称", "example": "test" } ], "required": [] }, { "name": "UpdateRowFilter", "description": "此接口用于更新行过滤规则。注意只能更新过滤规则，不能更新规格对象catalog，database和table。", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "行过滤策略的id，此值可以通过DescribeUserInfo或者DescribeWorkGroupInfo接口获取", "example": "1" }, { "name": "Policy", "type": "object", "required": true, "description": "新的过滤策略。", "example": "无", "children": [ { "name": "Database", "type": "string", "required": true, "description": "需要授权的数据库名，填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填 “*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。", "example": "test_database" }, { "name": "Catalog", "type": "string", "required": true, "description": "需要授权的数据源名称，管理员级别下只支持填 * （代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。", "example": "DataLakeCatalog" }, { "name": "Table", "type": "string", "required": true, "description": "需要授权的表名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "test_table" }, { "name": "Operation", "type": "string", "required": true, "description": "授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。", "example": "ALL" }, { "name": "PolicyType", "type": "string", "required": false, "description": "授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。", "example": "ADMIN" }, { "name": "Function", "type": "string", "required": false, "description": "需要授权的函数名，填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "fun1" }, { "name": "View", "type": "string", "required": false, "description": "需要授权的视图，填 * 代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。 注意：此字段可能返回 null，表示取不到有效值。", "example": "view1" }, { "name": "Column", "type": "string", "required": false, "description": "需要授权的列，填 * 代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "column1" }, { "name": "DataEngine", "type": "string", "required": false, "description": "需要授权的数据引擎，填 * 代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。", "example": "dataEngine1" }, { "name": "ReAuth", "type": "boolean", "required": false, "description": "用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组 注意：此字段可能返回 null，表示取不到有效值。", "example": "USER" }, { "name": "Mode", "type": "string", "required": false, "description": "授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "COMMON" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者，入参不填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "600000563084" }, { "name": "CreateTime", "type": "string", "required": false, "description": "权限创建的时间，入参不填 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-07-28 16:19:32" }, { "name": "SourceId", "type": "integer", "required": false, "description": "权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "SourceName", "type": "string", "required": false, "description": "权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test_group" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "EngineGeneration", "type": "string", "required": false, "description": "引擎类型", "example": "SuperSQL/Native" }, { "name": "Model", "type": "string", "required": false, "description": "需要授权的Model名，填 * 代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。", "example": "model1" }, { "name": "IsAdminPolicy", "type": "boolean", "required": false, "description": "权限来源是否为管理员", "example": "false" } ] } ], "required": [ "PolicyId", "Policy" ] }, { "name": "UpdateStandardEngineResourceGroupBaseInfo", "description": "更新标准引擎资源组基础信息", "status": "online", "parameters": [ { "name": "EngineResourceGroupName", "type": "string", "required": true, "description": "引擎资源组名称", "example": "无" }, { "name": "AutoLaunch", "type": "integer", "required": true, "description": "自动启动，（任务提交自动拉起资源组）0-自动启动，1-不自动启动", "example": "无" }, { "name": "AutoPause", "type": "integer", "required": true, "description": "自动挂起资源组。0-自动挂起，1-不自动挂起", "example": "无" }, { "name": "AutoPauseTime", "type": "integer", "required": false, "description": "自动挂起时间，单位分钟，取值范围在1-999（在无任务AutoPauseTime后，资源组自动挂起）", "example": "无" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "任务并发数", "example": "无" } ], "required": [ "EngineResourceGroupName", "AutoLaunch", "AutoPause" ] }, { "name": "UpdateStandardEngineResourceGroupConfigInfo", "description": "更新标准引擎资源组基础信息", "status": "online", "parameters": [ { "name": "EngineResourceGroupName", "type": "string", "required": true, "description": "引擎资源组名称", "example": "无" }, { "name": "UpdateConfContext", "type": "array", "required": true, "description": "需要更新的配置", "example": "无", "item_type": "object", "children": [ { "name": "ConfigType", "type": "string", "required": true, "description": "参数类型，可选：StaticConfigType，DynamicConfigType", "example": "StaticConfigType" }, { "name": "Params", "type": "array", "required": true, "description": "参数的配置数组", "example": "无", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": false, "description": "参数key，例如：", "example": "spark.sql.shuffle.partitions" }, { "name": "ConfigValue", "type": "string", "required": false, "description": "参数值", "example": "200" }, { "name": "Operate", "type": "string", "required": false, "description": "下发操作，支持：ADD、DELETE、MODIFY", "example": "ADD" } ] } ] }, { "name": "IsEffectiveNow", "type": "integer", "required": true, "description": "是否立即重启资源组生效，0--立即生效，1--只保持不重启生效", "example": "无" } ], "required": [ "EngineResourceGroupName", "UpdateConfContext", "IsEffectiveNow" ] }, { "name": "UpdateStandardEngineResourceGroupResourceInfo", "description": "更新标准引擎资源组基础信息", "status": "online", "parameters": [ { "name": "EngineResourceGroupName", "type": "string", "required": true, "description": "引擎资源组名称", "example": "rg-1" }, { "name": "DriverCuSpec", "type": "string", "required": false, "description": "driver的cu规格： 当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu），内存型cu为cpu：men=1:8，m.small（1cu内存型）、m.medium（2cu内存型）、m.large（4cu内存型）、m.xlarge（8cu内存型）", "example": "small" }, { "name": "ExecutorCuSpec", "type": "string", "required": false, "description": "executor的cu规格： 当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu），内存型cu为cpu：men=1:8，m.small（1cu内存型）、m.medium（2cu内存型）、m.large（4cu内存型）、m.xlarge（8cu内存型）", "example": "small" }, { "name": "MinExecutorNums", "type": "integer", "required": false, "description": "executor最小数量，", "example": "1" }, { "name": "MaxExecutorNums", "type": "integer", "required": false, "description": "executor最大数量", "example": "1" }, { "name": "IsEffectiveNow", "type": "integer", "required": false, "description": "是否立即重启资源组生效，0--立即生效，1--只保持不重启生效", "example": "1" }, { "name": "Size", "type": "integer", "required": false, "description": "AI资源组资源上限", "example": "64" }, { "name": "ImageType", "type": "string", "required": false, "description": "镜像类型，内置镜像：built-in，自定义镜像：custom", "example": "built-in" }, { "name": "ImageName", "type": "string", "required": false, "description": "镜像名称", "example": "imagename-xxx" }, { "name": "ImageVersion", "type": "string", "required": false, "description": "镜像版本，镜像id", "example": "image-xxxx" }, { "name": "FrameType", "type": "string", "required": false, "description": "框架类型", "example": "spark-ml" }, { "name": "PublicDomain", "type": "string", "required": false, "description": "自定义镜像域名", "example": "dlctcr.tencentcloud.com" }, { "name": "RegistryId", "type": "string", "required": false, "description": "自定义镜像实例id", "example": "tcr-xxx" }, { "name": "RegionName", "type": "string", "required": false, "description": "自定义镜像所属地域", "example": "ap-beijing" }, { "name": "PythonCuSpec", "type": "string", "required": false, "description": "python类型资源组python单机节点资源上限，该值要小于资源组的资源上限.small:1cu medium:2cu large:4cu xlarge:8cu 4xlarge:16cu 8xlarge:32cu 16xlarge:64cu，如果是高内存型资源，在类型前面加上m.", "example": "small" }, { "name": "SparkSpecMode", "type": "string", "required": false, "description": "仅SQL资源组资源配置模式，fast：快速模式，custom：自定义模式", "example": "custom" }, { "name": "SparkSize", "type": "integer", "required": false, "description": "仅SQL资源组资源上限，仅用于快速模式", "example": "64" }, { "name": "DriverGPUSpec", "type": "integer", "required": false, "description": "gpuDriver规格", "example": "1" }, { "name": "ExecutorGPUSpec", "type": "integer", "required": false, "description": "gpuExcutor 规格", "example": "1" }, { "name": "GPULimitSize", "type": "integer", "required": false, "description": "gpu 上限", "example": "1" }, { "name": "GPUSize", "type": "integer", "required": false, "description": "gpu 规格", "example": "1" }, { "name": "PythonGPUSpec", "type": "integer", "required": false, "description": "gpupod 规格", "example": "1" } ], "required": [ "EngineResourceGroupName" ] }, { "name": "UpdateUDFPolicy", "description": "UDP权限修改", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "UDF名称", "example": "udf1" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库名", "example": "database1" }, { "name": "CatalogName", "type": "string", "required": true, "description": "数据目录名", "example": "catalog1" }, { "name": "UDFPolicyInfos", "type": "array", "required": true, "description": "UDF权限信息", "example": "无", "item_type": "object", "children": [ { "name": "Accesses", "type": "array", "required": false, "description": "权限类型 示例：select，alter，drop", "example": "select", "item_type": "string" }, { "name": "Users", "type": "array", "required": false, "description": "拥有权限的用户信息", "example": "['100026442346', '100018379117']", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "拥有权限的工作组的信息", "example": "['221458']", "item_type": "string" } ] } ], "required": [ "Name", "DatabaseName", "CatalogName", "UDFPolicyInfos" ] }, { "name": "UpdateUserDataEngineConfig", "description": "修改用户引擎自定义配置", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎ID", "example": "DataEngine-1d7xxxx4h" }, { "name": "DataEngineConfigPairs", "type": "array", "required": false, "description": "用户自定义引擎配置项集合。该参数需要传用户需要添加的全部配置项，例如，已有配置项k1:v1，添加k2:v2，需要传[k1:v1,k2:v2]。", "example": "无", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] }, { "name": "SessionResourceTemplate", "type": "object", "required": false, "description": "作业引擎资源配置模板", "example": "无", "children": [ { "name": "DriverSize", "type": "string", "required": false, "description": "driver规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorSize", "type": "string", "required": false, "description": "executor规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge", "example": "small" }, { "name": "ExecutorNums", "type": "integer", "required": false, "description": "指定executor数量，最小值为1，最大值小于集群规格", "example": "1" }, { "name": "ExecutorMaxNumbers", "type": "integer", "required": false, "description": "指定executor max数量（动态配置场景下），最小值为1，最大值小于集群规格（当ExecutorMaxNumbers小于ExecutorNums时，改值设定为ExecutorNums）", "example": "1" }, { "name": "RunningTimeParameters", "type": "array", "required": false, "description": "运行时参数", "example": "复杂类型", "item_type": "object", "children": [ { "name": "ConfigItem", "type": "string", "required": true, "description": "配置项", "example": "dlc.query.execution.timeout" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "360" } ] } ] } ], "required": [ "DataEngineId" ] }, { "name": "UpgradeDataEngineImage", "description": "升级引擎镜像", "status": "online", "parameters": [ { "name": "DataEngineId", "type": "string", "required": true, "description": "引擎ID", "example": "DataEngine-xxx" } ], "required": [ "DataEngineId" ] } ] }