diff options
Diffstat (limited to 'data/zh_cn/dms/2025-04-14/api-docs.php')
| -rw-r--r-- | data/zh_cn/dms/2025-04-14/api-docs.php | 11346 |
1 files changed, 11346 insertions, 0 deletions
diff --git a/data/zh_cn/dms/2025-04-14/api-docs.php b/data/zh_cn/dms/2025-04-14/api-docs.php new file mode 100644 index 0000000..5afa6ec --- /dev/null +++ b/data/zh_cn/dms/2025-04-14/api-docs.php @@ -0,0 +1,11346 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dms', + 'version' => '2025-04-14', + ], + 'directories' => [ + [ + 'id' => 320232, + 'title' => 'Airflow', + 'type' => 'directory', + 'children' => [ + 'CreateAirflowLoginToken', + 'CreateAirflow', + 'UpdateAirflow', + 'UpdateAirflow', + 'GetAirflow', + 'ListAirflows', + 'DeleteAirflow', + ], + ], + [ + 'id' => 320239, + 'title' => '数据湖 库表', + 'type' => 'directory', + 'children' => [ + 'ListDataLakeDatabase', + 'GetDataLakeDatabase', + 'ListDataLakeCatalog', + 'GetDataLakeCatalog', + 'ListDataLakeTablebaseInfo', + 'GetDataLakeTable', + 'BatchCreateDataLakePartitions', + 'UpdateDataLakeTable', + 'UpdateDataLakePartition', + 'UpdateDataLakeDatabase', + 'ListDataLakeTableName', + 'ListDataLakeTable', + 'ListDataLakePartitionName', + 'ListDataLakePartitionByFilter', + 'ListDataLakePartition', + 'GetDataLakePartition', + 'DeleteDataLakeTable', + 'DeleteDataLakePartition', + 'DeleteDataLakeDatabase', + 'CreateDataLakeTable', + 'CreateDataLakePartition', + 'CreateDataLakeDatabase', + 'BatchUpdateDataLakePartitions', + 'BatchDeleteDataLakePartitions', + 'CreateDataLakeFunction', + 'GetDataLakeFunction', + 'UpdateDataLakeFunction', + 'DeleteDataLakeFunction', + 'ListDataLakeFunction', + 'ListDataLakeFunctionName', + ], + ], + [ + 'id' => 320270, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'GetNotebookAndSubmitTask', + 'GetNotebookTaskStatus', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeFileUploadSignature', + 'FileUploadCallback', + 'GetChatContent', + 'DeleteFileUpload', + 'SendChatMessage', + 'DescribeDataAgentSession', + 'CreateDataAgentSession', + 'ListFileUpload', + 'ListCustomAgent', + 'DescribeCustomAgent', + 'UpdateDataAgentWorkspaceMemberRole', + 'ListDataAgentWorkspace', + 'AddUserToDataAgentWorkspace', + 'UpdateDataAgentSpaceInfo', + 'CreateDataAgentWorkspace', + 'ListDataAgentWorkspaceMember', + 'DeleteDataAgentWorkspace', + 'RemoveUserToDataAgentWorkspace', + 'GetDataAgentSubAccountInfo', + 'GetDataAgentWorkspaceInfo', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'DLCatalog' => [ + 'title' => 'Catalog', + 'description' => '数据目录详情。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'Description', + 'description' => '数据目录描述。', + 'type' => 'string', + 'example' => 'init default catalog', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => '数据目录名称。', + 'type' => 'string', + 'example' => 'hive', + ], + 'Location' => [ + 'title' => 'Location', + 'description' => '数据目录存储路径。', + 'type' => 'string', + 'example' => 'oss://xxxx', + ], + ], + ], + 'DLColumn' => [ + 'title' => 'Column', + 'description' => '列属性。', + 'type' => 'object', + 'properties' => [ + 'Comment' => [ + 'title' => 'comment', + 'description' => '列的注释。', + 'type' => 'string', + 'example' => 'from deserializer', + ], + 'Type' => [ + 'title' => 'type', + 'description' => '列的数据类型，包括 array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar。', + 'type' => 'string', + 'example' => 'string', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '列的名称。', + 'type' => 'string', + 'example' => 'col', + ], + ], + ], + 'DLDatabase' => [ + 'title' => 'Database', + 'description' => '湖仓数据库详情。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'description', + 'description' => '数据库描述。', + 'type' => 'string', + 'example' => 'Default database for catalog hive'."\n", + ], + 'Parameters' => [ + 'description' => '数据库相关参数。', + 'type' => 'object', + 'example' => 'key/value', + ], + 'DbId' => [ + 'title' => 'dbId', + 'description' => '数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'CatalogName' => [ + 'title' => 'catalogName', + 'description' => '数据目录名称。', + 'type' => 'string', + 'example' => 'hive', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Location' => [ + 'title' => 'location', + 'description' => '数据库存储路径。', + 'type' => 'string', + 'example' => 'oss://xxx', + ], + ], + ], + 'DLFunction' => [ + 'description' => '函数信息', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'my_funciton', + ], + 'OwnerName' => [ + 'description' => '函数所有者。', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'OwnerType' => [ + 'description' => '所有者类型，枚举值：'."\n" + ."\n" + .'- ROLE'."\n" + .'- GROUP'."\n" + .'- USER', + 'type' => 'string', + 'example' => 'USER', + ], + 'CreatorId' => [ + 'description' => '创建该函数的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12****', + ], + 'FunctionType' => [ + 'description' => '函数类型。', + 'type' => 'string', + 'example' => 'JAVA', + ], + 'CreateTime' => [ + 'description' => '函数的创建时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1731586286', + ], + 'ResourceUris' => [ + 'description' => '该函数的资源URIs，函数创建后不支持修改。', + 'type' => 'array', + 'items' => [ + 'description' => '访问该资源的URI。', + '$ref' => '#/components/schemas/DLResourceUri', + ], + ], + 'ClassName' => [ + 'description' => '包含函数代码的Java类。', + 'type' => 'string', + 'example' => 'com.example.hive.MyCustomUDF', + ], + 'CatalogName' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'example' => 'hive', + ], + 'DbName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'ModifierId' => [ + 'description' => '修改该函数的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26****', + ], + ], + ], + 'DLFunctionInput' => [ + 'description' => '函数信息', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'my_funciton', + ], + 'OwnerName' => [ + 'description' => '函数所有者。', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'OwnerType' => [ + 'description' => '所有者类型，枚举值：'."\n" + ."\n" + .'- ROLE'."\n" + .'- GROUP'."\n" + .'- USER', + 'type' => 'string', + 'example' => 'USER', + ], + 'CreatorId' => [ + 'description' => '创建该函数的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12****', + ], + 'FunctionType' => [ + 'description' => '函数类型。', + 'type' => 'string', + 'example' => 'JAVA', + ], + 'CreateTime' => [ + 'description' => '函数的创建时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1731586286', + ], + 'ResourceUris' => [ + 'description' => '该函数的资源URIs，函数创建后不支持修改。', + 'type' => 'array', + 'items' => [ + 'description' => '访问该资源的URI。', + '$ref' => '#/components/schemas/DLResourceUri', + ], + ], + 'ClassName' => [ + 'description' => '包含函数代码的Java类。', + 'type' => 'string', + 'example' => 'com.example.hive.MyCustomUDF', + ], + 'ModifierId' => [ + 'description' => '修改该函数的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26****', + ], + ], + ], + 'DLOrder' => [ + 'title' => 'Order', + 'description' => '列排序信息。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'title' => 'order', + 'description' => '该列在排序中的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Col' => [ + 'title' => 'col', + 'description' => '列的名称。', + 'type' => 'string', + 'example' => 'col1', + ], + ], + ], + 'DLPartition' => [ + 'description' => '分区信息', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Sd' => [ + 'description' => '数据存储描述。', + '$ref' => '#/components/schemas/DLStorageDescriptor', + ], + 'Parameters' => [ + 'description' => '分区的键值对。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '键值对，key及value。', + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + ], + 'CreateTime' => [ + 'description' => '分区的创建时间，时间格式为UNIX时间戳秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1735109884', + ], + 'Values' => [ + 'description' => '分区值。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值。', + 'type' => 'string', + 'example' => 'part_val1', + ], + ], + 'CatalogName' => [ + 'description' => '数据目录名称。', + 'type' => 'string', + 'example' => 'hive', + ], + 'DbName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'LastAccessTime' => [ + 'description' => '上次访问该表的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1608707407', + ], + ], + ], + 'DLPartitionInput' => [ + 'description' => '湖仓表分区信息。', + 'type' => 'object', + 'properties' => [ + 'Parameters' => [ + 'description' => '分区的键值对参数', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '键值对 key/value', + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + ], + 'CreateTime' => [ + 'description' => '创建时间，Unix 时间戳秒数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1735109884', + ], + 'Values' => [ + 'description' => '分区值', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值', + 'type' => 'string', + 'example' => 'part_val1', + ], + ], + 'StorageDescriptor' => [ + 'description' => '湖仓表数据存储信息', + '$ref' => '#/components/schemas/DLStorageDescriptor', + ], + 'LastAccessTime' => [ + 'description' => '上一次访问分区的时间，Unix 时间戳秒数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1735109884', + ], + ], + ], + 'DLResourceUri' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。枚举值：'."\n" + .'- ARCHIVE'."\n" + .'- JAR'."\n" + .'- FILE', + 'type' => 'string', + 'example' => 'JAR', + ], + 'Uri' => [ + 'description' => '访问该资源的URL。', + 'type' => 'string', + 'example' => 'hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar', + ], + ], + ], + 'DLSerdeInfo' => [ + 'title' => 'SerdeInfo', + 'description' => '序列化和反序列化信息。', + 'type' => 'object', + 'properties' => [ + 'SerializationLib' => [ + 'title' => 'serializationLib', + 'description' => '使用的序列化库的类名称。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', + ], + 'DeserializerClass' => [ + 'title' => 'deserializerClass', + 'description' => '用于反序列化的具体类名。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde', + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '序列化相关的参数键值对。', + 'type' => 'object', + 'example' => '{'."\n" + .' "serialization.format": "1"'."\n" + .'}', + ], + 'Description' => [ + 'title' => 'description', + 'description' => '描述序列化的信息。', + 'type' => 'string', + 'example' => '"serialize"', + ], + 'SerdeType' => [ + 'description' => '序列化的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SerializerClass' => [ + 'title' => 'serializerClass', + 'description' => '用于序列化的具体类名。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '序列化名称。', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + 'DLSkewedInfo' => [ + 'title' => 'SkewedInfo', + 'description' => '存储倾斜列信息的数据结构。', + 'type' => 'object', + 'properties' => [ + 'SkewedColValues' => [ + 'title' => 'skewedColValues', + 'description' => '倾斜列值的列表，其中每个列表提供了一组相关联的值。', + 'type' => 'array', + 'items' => [ + 'description' => '倾斜值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '倾斜值。', + 'type' => 'string', + 'example' => '"123"', + ], + ], + ], + 'SkewedColValueLocationMaps' => [ + 'title' => 'skewedColValueLocationMaps', + 'description' => '倾斜列值及其位置的映射关系。', + 'type' => 'object', + 'example' => '{“col1”:"val1"}', + ], + 'SkewedColNames' => [ + 'title' => 'skewedColNames', + 'description' => '倾斜列的名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '倾斜字段。', + 'type' => 'string', + 'example' => 'col1', + ], + ], + ], + ], + 'DLStorageDescriptor' => [ + 'title' => 'StorageDescriptor', + 'description' => '湖仓表数据存储信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalColumns' => [ + 'title' => 'originalColumns', + 'description' => '原始列描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列属性。', + '$ref' => '#/components/schemas/DLColumn', + ], + ], + 'SortCols' => [ + 'title' => 'sortCols', + 'description' => '排序列的描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列排序信息。', + '$ref' => '#/components/schemas/DLOrder', + ], + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '数据存储的其他参数映射。', + 'type' => 'object', + 'example' => 'key/value'."\n", + ], + 'SkewedInfo' => [ + 'title' => 'skewedInfo', + 'description' => '存储倾斜列信息的数据结构。', + '$ref' => '#/components/schemas/DLSkewedInfo', + ], + 'InputFormat' => [ + 'title' => 'inputFormat', + 'description' => '输入格式类的名称，用于读取数据。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.mapred.SequenceFileInputFormat', + ], + 'OutputFormat' => [ + 'title' => 'outputFormat', + 'description' => '输出格式类的名称，用于写入数据。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat', + ], + 'Columns' => [ + 'title' => 'columns', + 'description' => '表中数据列的描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列属性。', + '$ref' => '#/components/schemas/DLColumn', + ], + ], + 'IsCompressed' => [ + 'title' => 'isCompressed', + 'description' => '是否压缩标识，表示数据是否被压缩存储。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SerdeInfo' => [ + 'title' => 'serdeInfo', + 'description' => '序列化和反序列化信息。', + '$ref' => '#/components/schemas/DLSerdeInfo', + ], + 'BucketCols' => [ + 'title' => 'bucketCols', + 'description' => '桶列的名称列表，决定数据的哈希分布。', + 'type' => 'array', + 'items' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => '2010', + ], + ], + 'NumBuckets' => [ + 'title' => 'numBuckets', + 'description' => '桶的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'Location' => [ + 'title' => 'location', + 'description' => '数据存储的具体位置。', + 'type' => 'string', + 'example' => 'oss://xxx', + ], + ], + ], + 'DLTable' => [ + 'title' => 'Table', + 'description' => '表的详细信息', + 'type' => 'object', + 'properties' => [ + 'ViewOriginalText' => [ + 'title' => 'viewOriginalText', + 'description' => '如果表是视图，表示视图的原始文本。', + 'type' => 'string', + 'example' => '""', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => '表的所有者名称。', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'TableType' => [ + 'title' => 'tableType', + 'description' => '元数据表的类型。例如MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', + 'type' => 'string', + 'example' => 'EXTERNAL_TABLE', + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '参数key/value。', + 'type' => 'object', + 'example' => '{'."\n" + .' "EXTERNAL": "TRUE",'."\n" + .' "delta.minReaderVersion": "1"}', + ], + 'Description' => [ + 'title' => 'description', + 'description' => '表的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreatorId' => [ + 'title' => 'creatorId', + 'description' => '创建该表的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8****', + ], + 'CreateTime' => [ + 'title' => 'createTime', + 'description' => '表的创建时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1731586286', + ], + 'StorageDescriptor' => [ + 'title' => 'StorageDescriptor', + 'description' => '存储描述信息，包含表的存储特征和格式详细信息。', + '$ref' => '#/components/schemas/DLStorageDescriptor', + ], + 'LastAccessTime' => [ + 'title' => 'lastAccessTime', + 'description' => '上次访问该表的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1608707407', + ], + 'Retention' => [ + 'title' => 'retention', + 'description' => '该表的保留时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => '100g_customer', + ], + 'OwnerType' => [ + 'title' => 'ownerType', + 'description' => '所有者的类型。可填写USER、ROLE或GROUP。', + 'type' => 'string', + 'example' => 'USER', + ], + 'ViewExpandedText' => [ + 'title' => 'viewExpandedText', + 'description' => '如果表是视图，表示视图的展开文本。', + 'type' => 'string', + 'example' => '""', + ], + 'DbId' => [ + 'title' => 'dbId', + 'description' => '表所属的数据库ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'DbName' => [ + 'title' => 'dbName', + 'description' => '表所属的数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'CatalogName' => [ + 'title' => 'catalogName', + 'description' => '数据目录名称。', + 'type' => 'string', + 'example' => 'hive', + ], + 'PartitionKeys' => [ + 'title' => 'partitionKeys', + 'description' => '表的列属性列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + '$ref' => '#/components/schemas/DLColumn', + ], + ], + 'ModifierId' => [ + 'title' => 'modifierId', + 'description' => '最后修改该表的用户。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1410769', + ], + 'Location' => [ + 'title' => 'location', + 'description' => '表的存储路径。', + 'type' => 'string', + 'example' => 'oss://xxx', + ], + ], + ], + 'DLTableInput' => [ + 'description' => '表的详细信息', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '表的所有者。', + 'type' => 'string', + 'example' => 'zhangsan'."\n", + ], + 'ViewOriginalText' => [ + 'description' => '如果表是视图，表示视图的原始文本。', + 'type' => 'string', + 'example' => '""', + ], + 'TableType' => [ + 'description' => '元数据表的类型。例如MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', + 'type' => 'string', + 'example' => 'EXTERNAL_TABLE'."\n", + ], + 'Parameters' => [ + 'description' => '键值对参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '参数key/value。', + 'type' => 'string', + 'example' => '{'."\n" + .' "EXTERNAL": "TRUE",'."\n" + .' "delta.minReaderVersion": "1"}', + ], + ], + 'Description' => [ + 'description' => '表的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreatorId' => [ + 'description' => '创建该表的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8****', + ], + 'CreateTime' => [ + 'description' => '表的创建时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1731586286', + ], + 'StorageDescriptor' => [ + 'title' => 'storageDescriptor', + 'description' => '存储描述信息，包含表的存储特征和格式详细信息。', + '$ref' => '#/components/schemas/DLStorageDescriptor', + ], + 'LastAccessTime' => [ + 'description' => '上次访问该表的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1608707407', + ], + 'Retention' => [ + 'description' => '该表的保留时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => '100g_customer', + ], + 'OwnerType' => [ + 'description' => '所有者的类型。可填写USER、ROLE或GROUP。', + 'type' => 'string', + 'example' => 'USER', + ], + 'ViewExpandedText' => [ + 'description' => '如果表是视图，表示视图的展开文本。', + 'type' => 'string', + 'example' => '""', + ], + 'PartitionKeys' => [ + 'description' => '表的列属性列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + '$ref' => '#/components/schemas/DLColumn', + ], + ], + 'ModifierId' => [ + 'description' => '最后修改该表的用户。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1410769', + ], + 'Location' => [ + 'description' => '表的存储路径。', + 'type' => 'string', + 'example' => 'oss://xxx', + ], + ], + ], + 'DLTablebaseInfo' => [ + 'title' => 'TablebaseInfo', + 'description' => '表的基本信息。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'title' => 'owner', + 'description' => '表的所有者。', + 'type' => 'string', + 'example' => 'test', + ], + 'ViewOriginalText' => [ + 'title' => 'viewOriginalText', + 'description' => '如果表是视图，表示视图的原始文本。', + 'type' => 'string', + 'example' => '""'."\n", + ], + 'TableType' => [ + 'title' => 'tableType', + 'description' => '表的类型。例如 MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', + 'type' => 'string', + 'example' => 'EXTERNAL_TABLE'."\n", + ], + 'Parameters' => [ + 'title' => 'parameters', + 'description' => '表的附加参数。', + 'type' => 'object', + 'example' => ' "EXTERNAL": "TRUE"'."\n", + ], + 'Description' => [ + 'title' => 'description', + 'description' => '表的描述。', + 'type' => 'string', + 'example' => '"table"'."\n", + ], + 'CreatorId' => [ + 'title' => 'creatorId', + 'description' => '创建该表的用户 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '141****'."\n", + ], + 'CreateTime' => [ + 'title' => 'createTime', + 'description' => '创建表的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1608707407', + ], + 'LastAccessTime' => [ + 'title' => 'lastAccessTime', + 'description' => '上次访问表的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1731586286', + ], + 'Retention' => [ + 'title' => 'retention', + 'description' => '表的保留期（按天）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30000', + ], + 'Name' => [ + 'title' => 'name', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => '100g_customer'."\n", + ], + 'OwnerType' => [ + 'title' => 'ownerType', + 'description' => '负责人类型。可填写 USER、ROLE 或 GROUP。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ROLE' => 'ROLE', + 'GROUP' => 'GROUP', + 'USER' => 'USER', + ], + 'example' => 'USER', + ], + 'ViewExpandedText' => [ + 'title' => 'viewExpandedText', + 'description' => '如果表是视图，表示视图的展开文本。', + 'type' => 'string', + 'example' => '""'."\n", + ], + 'DbId' => [ + 'title' => 'dbId', + 'description' => '所属的数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'DbName' => [ + 'title' => 'dbName', + 'description' => '所属的数据库名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'CatalogName' => [ + 'title' => 'catalogName', + 'description' => '所属的数据目录。', + 'type' => 'string', + 'example' => 'hive', + ], + 'PartitionKeys' => [ + 'title' => 'partitionKeys', + 'description' => '表的列属性列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列属性。', + '$ref' => '#/components/schemas/DLColumn', + ], + ], + 'ModifierId' => [ + 'title' => 'modifierId', + 'description' => '修改表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731585286', + ], + 'Location' => [ + 'title' => 'location', + 'description' => '表的存储路径。', + 'type' => 'string', + 'example' => 'oss://xxx', + ], + ], + ], + 'ForeignInstance' => [ + 'description' => '外部数据源实例信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceSource' => [ + 'description' => '数据库实例来源，取值如下：'."\n" + ."\n" + .'- **PUBLIC_OWN**：代表公网自建实例'."\n" + .'- **RDS**：代表RDS实例'."\n" + .'- **ECS_OWN**：代表ECS自建实例'."\n" + .'- **VPC_IDC**：代表VPC IDC自建实例'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Port' => [ + 'description' => '实例连接端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7890', + ], + 'Host' => [ + 'description' => '实例连接地址。', + 'type' => 'string', + 'example' => '127.0.XX.XX', + ], + 'RegionId' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InstanceType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'Properties' => [ + 'description' => '属性信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '属性信息。', + 'type' => 'string', + 'example' => '{\\"PackageUsedUpStrategyKey\\":\\"Postpaid\\"}', + ], + ], + 'DataLinkName' => [ + 'description' => 'datalink名称。', + 'type' => 'string', + 'example' => 'dbl_mysql_2337', + ], + 'Sid' => [ + 'description' => '数据库Sid。'."\n" + .'>数据库Sid是Oracle数据库的唯一标识符。当建立一个数据库时，系统将自动赋予一个初始ID。', + 'type' => 'string', + 'example' => 'HXE', + ], + ], + ], + 'ForeignInstanceCredInfo' => [ + 'description' => '外部数据源凭证信息。', + 'type' => 'object', + 'properties' => [ + 'CredInfo' => [ + 'description' => '凭证信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '凭证信息。', + 'type' => 'string', + 'example' => '{"username": "xxx", "password": "yyy"}', + ], + ], + 'CredType' => [ + 'description' => '凭证类型，目前恒定取值为DEFAULT。', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + ], + ], + 'OneMetaDatabaseObject' => [ + 'type' => 'object', + 'properties' => [ + 'ObjectName' => [ + 'type' => 'string', + ], + 'ObjectType' => [ + 'type' => 'string', + ], + 'ObjectQualifiedName' => [ + 'type' => 'string', + ], + ], + ], + 'OneMetaTableBaseInfo' => [ + 'type' => 'object', + 'properties' => [ + 'CatalogType' => [ + 'type' => 'string', + ], + 'DatabaseUuid' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'QualifiedName' => [ + 'type' => 'string', + ], + 'TableType' => [ + 'type' => 'string', + ], + 'TableUuid' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'EngineMeta' => [ + '$ref' => '#/components/schemas/OneMetaTableEngineMeta', + ], + ], + ], + 'OneMetaTableColumn' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'type' => 'string', + ], + 'ColumnType' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'Position' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'EngineMeta' => [ + '$ref' => '#/components/schemas/OneMetaTableColumnEngineMeta', + ], + ], + ], + 'OneMetaTableColumnEngineMeta' => [ + 'type' => 'object', + 'properties' => [ + 'Nullable' => [ + 'type' => 'boolean', + ], + 'AutoIncrement' => [ + 'type' => 'boolean', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'DataLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DataPrecision' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DataScale' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Encoding' => [ + 'type' => 'string', + ], + 'Extra' => [ + 'type' => 'string', + ], + 'GenerationColumn' => [ + 'type' => 'boolean', + ], + 'GenerationExpression' => [ + 'type' => 'string', + ], + ], + ], + 'OneMetaTableEngineMeta' => [ + 'type' => 'object', + 'properties' => [ + 'TableSchemaName' => [ + 'type' => 'string', + ], + 'Encoding' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'LastDdlTime' => [ + 'type' => 'string', + ], + 'Engine' => [ + 'type' => 'string', + ], + 'StorageCapacity' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DataBytes' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'IndexBytes' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'NumRows' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RefInfo' => [ + 'type' => 'string', + ], + ], + ], + 'OneMetaTableIndex' => [ + 'type' => 'object', + 'properties' => [ + 'IndexName' => [ + 'type' => 'string', + ], + 'IndexType' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ColumnNames' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Primary' => [ + 'type' => 'boolean', + ], + 'Unique' => [ + 'type' => 'boolean', + ], + 'RealColumnNames' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PartitionError' => [ + 'description' => '具体的错误信息。', + 'type' => 'object', + 'properties' => [ + 'ErrorDetail' => [ + 'description' => '错误详情。', + 'type' => 'string', + 'example' => 'auth failed', + ], + 'Values' => [ + 'description' => '分区值。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值。', + 'type' => 'string', + 'example' => 'part_val1', + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateAirflowLoginToken' => [ + 'summary' => '通过该API可获取Airflow登录凭证，使用此登录凭证可以登录DMS托管Airflow。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AirflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Airflow的实例ID。您可以在[Airflow实例列表](~~2881043~~)页面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'af-b3a7f110a6vmvn7xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4284D079-30F4-5B23-ADC4-28F291622C9A', + ], + 'HttpStatusCode' => [ + 'description' => '错误码描述。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- True：请求成功。 '."\n" + .'- False：请求失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'ErrorCode' => [ + 'description' => '错误码。取值说明如下：'."\n" + ."\n" + .'- 请求成功：不返回ErrorCode字段。'."\n" + .'- 请求失败：返回ErrorCode字段。'."\n" + ."\n" + .'具体信息，请参见本文的错误码列表。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '监控任务的结果详情。', + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '生成Token。', + 'type' => 'string', + 'example' => 'f432d77de03b6b95fc24f9****', + ], + 'Host' => [ + 'description' => 'Airflow实例的访问地址。', + 'type' => 'string', + 'example' => 'https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszb****', + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4284D079-30F4-5B23-ADC4-28F291622C9A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Successful\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Token\\": \\"f432d77de03b6b95fc24f9****\\",\\n \\"Host\\": \\"https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszb****\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '获取Airflow登录凭证', + ], + 'CreateAirflow' => [ + 'summary' => '在工作空间下创建Airflow实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DMS工作空间ID', + 'description' => 'DMS工作空间ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8630242382****', + ], + ], + [ + 'name' => 'AirflowName', + 'in' => 'query', + 'schema' => [ + 'title' => 'airflow实例的名称', + 'description' => 'Airflow实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testairflow', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => 'airflow实例的描述', + 'description' => 'Airflow实例描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'order scheduler', + ], + ], + [ + 'name' => 'AppSpec', + 'in' => 'query', + 'schema' => [ + 'title' => 'airflow实例的规格-SMALL、MEDIUM、LARGE、XLARGE、X2LARGE', + 'description' => 'Airflow实例的规格，取值为：**SMALL**、**MEDIUM**、**LARGE**、**XLARGE**或**X2LARGE**。', + 'type' => 'string', + 'required' => true, + 'example' => 'SMALL', + ], + ], + [ + 'name' => 'WorkerServerlessReplicas', + 'in' => 'query', + 'schema' => [ + 'title' => 'Worker节点扩展', + 'description' => 'Worker节点扩展的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => 'vpc id', + 'description' => 'VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf63r6coyiw9o5****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'title' => '交换机ID', + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-8vbaf073jawozfp****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sg-bp108t8ldzeyk1****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region中可用区ID', + 'description' => 'Region下的可用区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'title' => 'OSS bucket名称', + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss-test', + ], + ], + [ + 'name' => 'OssPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'OSS路径', + 'description' => '存放日志的OSS路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/airflow', + ], + ], + [ + 'name' => 'StartupFile', + 'in' => 'query', + 'schema' => [ + 'title' => 'airflow容器的启动脚本', + 'description' => 'Airflow容器的启动脚本。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/startup.sh', + ], + ], + [ + 'name' => 'RequirementFile', + 'in' => 'query', + 'schema' => [ + 'title' => '可按照包的路径', + 'description' => '安装包的路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/requirements.txt', + ], + ], + [ + 'name' => 'DagsDir', + 'in' => 'query', + 'schema' => [ + 'title' => 'dag扫描路径', + 'description' => 'Airflow扫描的dag目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/dags', + ], + ], + [ + 'name' => 'PluginsDir', + 'in' => 'query', + 'schema' => [ + 'title' => 'airflow实例扫描的插件路径', + 'description' => 'Airflow实例扫描的插件目标。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/plugins', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => 'token-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'AccessDeniedDetail' => [ + 'title' => '拒绝访问的详情', + 'description' => '拒接访问的信息。', + 'type' => 'string', + 'example' => 'NOT_FOUND', + ], + 'Root' => [ + 'title' => '数据字典', + 'description' => 'Airflow数据字典。', + 'type' => 'object', + 'properties' => [ + 'AirflowName' => [ + 'title' => 'airflow实例名', + 'description' => 'Airflow实例的名称。', + 'type' => 'string', + 'example' => 'testairflow', + ], + 'AppSpec' => [ + 'title' => 'airflow规格', + 'description' => 'Airflow实例的规格。', + 'type' => 'string', + 'example' => 'SMALL', + ], + 'AppType' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'example' => 'airflow', + ], + 'DagsDir' => [ + 'title' => 'airflow扫描dag的路径', + 'description' => 'Airflow扫描dag的目录。', + 'type' => 'string', + 'example' => 'default/dags', + ], + 'DeployErrorMsg' => [ + 'title' => '错误日志信息', + 'description' => '错误日志信息。', + 'type' => 'string', + 'example' => 'vpc not found', + ], + 'Description' => [ + 'title' => 'airflow的描述信息', + 'description' => 'Airflow的描述信息。', + 'type' => 'string', + 'example' => 'order scheduler', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-08-12T05:46:01.000+0000', + ], + 'OssBucketName' => [ + 'title' => 'OSS bucktet名字', + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'example' => 'oss-test', + ], + 'OssPath' => [ + 'title' => 'OSS路径', + 'description' => 'OSS路径。', + 'type' => 'string', + 'example' => '/airflow', + ], + 'PluginsDir' => [ + 'title' => 'airflow扫描的插件路径', + 'description' => 'Airflow扫描的插件目录。', + 'type' => 'string', + 'example' => 'default/plugins', + ], + 'RequirementFile' => [ + 'title' => '可安装包的路径', + 'description' => '可安装包的路径。', + 'type' => 'string', + 'example' => 'default/requirements.txt', + ], + 'SecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-2ze1nak7h0alg1xxx', + ], + 'StartupFile' => [ + 'title' => 'airflow实例的启动时加载的文件，可设置环境变量等', + 'description' => 'Airflow实例的启动时加载的文件，可设置环境变量等。', + 'type' => 'string', + 'example' => 'default/startup.sh', + ], + 'Status' => [ + 'title' => 'airflow实例状态', + 'description' => 'Airflow实例状态。', + 'type' => 'string', + 'example' => 'DEPLOYING', + ], + 'AirflowId' => [ + 'title' => 'airflow id', + 'description' => 'Airflow的实例ID。', + 'type' => 'string', + 'example' => 'af-****', + ], + 'VSwitchId' => [ + 'title' => '交换机ID', + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-8vbaf073jawozfpbg****', + ], + 'VpcId' => [ + 'title' => 'VPC ID', + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf63r6coyiw9o5gf****', + ], + 'WorkerServerlessReplicas' => [ + 'title' => 'Worker扩展节点数', + 'description' => 'Worker扩展节点的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => '工作空间ID。', + 'type' => 'string', + 'example' => '86302423828****', + ], + 'ZoneId' => [ + 'title' => '可用区ID', + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + ], + ], + 'Message' => [ + 'title' => '日志信息', + 'description' => '日志信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '请求是否成功，返回值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": {\\n \\"AirflowName\\": \\"testairflow\\",\\n \\"AppSpec\\": \\"SMALL\\",\\n \\"AppType\\": \\"airflow\\",\\n \\"DagsDir\\": \\"default/dags\\",\\n \\"DeployErrorMsg\\": \\"vpc not found\\",\\n \\"Description\\": \\"order scheduler\\",\\n \\"GmtCreated\\": \\"2025-08-12T05:46:01.000+0000\\",\\n \\"OssBucketName\\": \\"oss-test\\",\\n \\"OssPath\\": \\"/airflow\\",\\n \\"PluginsDir\\": \\"default/plugins\\",\\n \\"RequirementFile\\": \\"default/requirements.txt\\",\\n \\"SecurityGroupId\\": \\"sg-2ze1nak7h0alg1xxx\\",\\n \\"StartupFile\\": \\"default/startup.sh\\",\\n \\"Status\\": \\"DEPLOYING\\",\\n \\"AirflowId\\": \\"af-****\\",\\n \\"VSwitchId\\": \\"vsw-8vbaf073jawozfpbg****\\",\\n \\"VpcId\\": \\"vpc-uf63r6coyiw9o5gf****\\",\\n \\"WorkerServerlessReplicas\\": 0,\\n \\"WorkspaceId\\": \\"86302423828****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建Airflow实例', + ], + 'UpdateAirflow' => [ + 'summary' => '更新Airflow实例信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => 'token-****', + ], + ], + [ + 'name' => 'AirflowId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow的唯一键ID', + 'description' => 'Airflow的唯一键ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'af-test****', + ], + ], + [ + 'name' => 'AirflowName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow实例的名字', + 'description' => 'Airflow实例的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testairflow', + ], + ], + [ + 'name' => 'StartupFile', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow实例的启动时加载的脚本', + 'description' => 'Airflow实例的启动时加载的脚本。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/startup.sh', + ], + ], + [ + 'name' => 'WorkerServerlessReplicas', + 'in' => 'query', + 'schema' => [ + 'title' => 'Worker节点个数', + 'description' => 'Worker节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow的描述信息', + 'description' => 'Airflow的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test airflow', + ], + ], + [ + 'name' => 'PluginsDir', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow扫描的插件目录', + 'description' => 'Airflow扫描的插件目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/plugins', + ], + ], + [ + 'name' => 'AppSpec', + 'in' => 'query', + 'schema' => [ + 'title' => 'AIrflow的规格描述', + 'description' => 'AIrflow的规格描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMALL', + ], + ], + [ + 'name' => 'RequirementFile', + 'in' => 'query', + 'schema' => [ + 'title' => '包依赖的安装文件', + 'description' => '包依赖的安装文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/requirements.txt', + ], + ], + [ + 'name' => 'DagsDir', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow扫描dag的目录', + 'description' => 'Airflow扫描dag的目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'default/dags', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DMS工作空间ID', + 'description' => 'DMS工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '863024238280****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E0D21075-CD3E-4D98-8264-F****', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'NOT_FOUND', + ], + 'Root' => [ + 'description' => '更新后的详情信息。', + 'type' => 'object', + 'properties' => [ + 'AirflowName' => [ + 'description' => 'Airflow实例名称。', + 'type' => 'string', + 'example' => 'test airflow', + ], + 'AppSpec' => [ + 'description' => 'SMALL。', + 'type' => 'string', + 'example' => 'SMALL', + ], + 'AppType' => [ + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'AIRFLOW', + ], + 'CustomAirflowCfg' => [ + 'description' => '自定义配置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项。', + 'type' => 'string', + 'example' => 'smtp.username=test', + ], + ], + 'DagsDir' => [ + 'description' => '扫描dag的目录。', + 'type' => 'string', + 'example' => 'default/dags', + ], + 'DeployErrorMsg' => [ + 'description' => '发布错误信息。', + 'type' => 'string', + 'example' => 'quota exists', + ], + 'Description' => [ + 'description' => 'Airflow描述。', + 'type' => 'string', + 'example' => 'order schedule', + ], + 'Environments' => [ + 'description' => '环境配置。', + 'type' => 'string', + 'example' => 'k=v', + ], + 'GmtCreated' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-01-07T15:10:32+08:00', + ], + 'OssBucketName' => [ + 'description' => '对象存储Bucket名称。', + 'type' => 'string', + 'example' => 'osstest', + ], + 'OssPath' => [ + 'description' => '存放日志的OSS路径。', + 'type' => 'string', + 'example' => '/airflow', + ], + 'PluginsDir' => [ + 'description' => '扫描Airlfow插件的目录。', + 'type' => 'string', + 'example' => 'default/plugins', + ], + 'RequirementFile' => [ + 'description' => '安装包的路径。', + 'type' => 'string', + 'example' => 'default/requirements.txt', + ], + 'Requirements' => [ + 'description' => '安装包的配置。', + 'type' => 'string', + 'example' => 'jieba==0.42', + ], + 'SecurityGroupId' => [ + 'description' => '安全组的ID。', + 'type' => 'string', + 'example' => 'sg-2ze1nak7h0alg1w5****', + ], + 'StartupFile' => [ + 'description' => 'Airflow容器的启动脚本。', + 'type' => 'string', + 'example' => 'default/startup.sh', + ], + 'Status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'example' => 'DEPLOYED', + ], + 'Uuid' => [ + 'description' => 'Airflow实例ID。', + 'type' => 'string', + 'example' => 'af-xxx', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-hp3hyga33aur8tj36****', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp16ko44pgciwv0****', + ], + 'WorkerServerlessReplicas' => [ + 'description' => 'Worker节点扩展的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WorkspaceId' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'example' => '86302423828****', + ], + 'ZoneId' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + ], + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Unknown error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-F****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": {\\n \\"AirflowName\\": \\"test airflow\\",\\n \\"AppSpec\\": \\"SMALL\\",\\n \\"AppType\\": \\"AIRFLOW\\",\\n \\"CustomAirflowCfg\\": [\\n \\"smtp.username=test\\"\\n ],\\n \\"DagsDir\\": \\"default/dags\\",\\n \\"DeployErrorMsg\\": \\"quota exists\\",\\n \\"Description\\": \\"order schedule\\",\\n \\"Environments\\": \\"k=v\\",\\n \\"GmtCreated\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"OssBucketName\\": \\"osstest\\",\\n \\"OssPath\\": \\"/airflow\\",\\n \\"PluginsDir\\": \\"default/plugins\\",\\n \\"RequirementFile\\": \\"default/requirements.txt\\",\\n \\"Requirements\\": \\"jieba==0.42\\",\\n \\"SecurityGroupId\\": \\"sg-2ze1nak7h0alg1w5****\\",\\n \\"StartupFile\\": \\"default/startup.sh\\",\\n \\"Status\\": \\"DEPLOYED\\",\\n \\"Uuid\\": \\"af-xxx\\",\\n \\"VSwitchId\\": \\"vsw-hp3hyga33aur8tj36****\\",\\n \\"VpcId\\": \\"vpc-bp16ko44pgciwv0****\\",\\n \\"WorkerServerlessReplicas\\": 0,\\n \\"WorkspaceId\\": \\"86302423828****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\"\\n },\\n \\"Message\\": \\"Unknown error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新Airflow实例信息', + ], + 'GetAirflow' => [ + 'summary' => '查询Airflow实例详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AirflowId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Airflow实例的唯一ID', + 'description' => 'Airflow实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'af-b3a7f110a6vmvn7****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '8630242382****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'request id', + 'description' => 'Reuqest ID。', + 'type' => 'string', + 'example' => 'E0D21075-CD3E-4D98-8264-****', + ], + 'AccessDeniedDetail' => [ + 'title' => '访问失败的信息', + 'description' => '访问失败的信息。', + 'type' => 'string', + 'example' => 'NOT_FOUND', + ], + 'Root' => [ + 'title' => '数据明细', + 'description' => '数据明细。', + 'type' => 'object', + 'properties' => [ + 'AirflowName' => [ + 'title' => 'Airflow名称', + 'description' => 'Airflow名称。', + 'type' => 'string', + 'example' => 'testairflow', + ], + 'AppSpec' => [ + 'title' => 'Airflow规格', + 'description' => 'Airflow规格。', + 'type' => 'string', + 'example' => 'SMALL', + ], + 'AppType' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'example' => 'AIRFLOW', + ], + 'CustomAirflowCfg' => [ + 'title' => '自定义配置', + 'description' => '自定义配置。', + 'type' => 'array', + 'items' => [ + 'title' => '配置明细', + 'description' => '配置明细。', + 'type' => 'string', + 'example' => 'smtp.username=test', + ], + ], + 'DagsDir' => [ + 'title' => 'Airflow扫描的dag目录', + 'description' => 'Airflow扫描的dag目录。', + 'type' => 'string', + 'example' => 'default/dags', + ], + 'DeployErrorMsg' => [ + 'title' => '发布错误信息', + 'description' => '发布错误信息。', + 'type' => 'string', + 'example' => 'Deployed', + ], + 'Description' => [ + 'title' => 'Airflow的描述', + 'description' => 'Airflow的描述。', + 'type' => 'string', + 'example' => 'test airflow', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-08-12T05:46:01.000+0000', + ], + 'OssBucketName' => [ + 'title' => 'oss bucket名字', + 'description' => 'OSS Bucket名字。', + 'type' => 'string', + 'example' => 'osstest', + ], + 'OssPath' => [ + 'title' => 'oss路径', + 'description' => 'OSS路径。', + 'type' => 'string', + 'example' => '/airflow', + ], + 'PluginsDir' => [ + 'title' => 'Airflow扫描的插件目录', + 'description' => 'Airflow扫描的插件目录。', + 'type' => 'string', + 'example' => 'default/plugins', + ], + 'RequirementFile' => [ + 'title' => '依赖包的配置文件', + 'description' => '依赖包的配置文件。', + 'type' => 'string', + 'example' => 'default/requirements.txt', + ], + 'SecurityGroupId' => [ + 'title' => '安全组id', + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-2ze9gj646bkv****', + ], + 'StartupFile' => [ + 'title' => 'Airflow启动前加载的脚本', + 'description' => 'Airflow启动前加载的脚本。', + 'type' => 'string', + 'example' => 'default/startup.sh', + ], + 'Status' => [ + 'title' => 'Airflow实例状态', + 'description' => 'Airflow实例状态。', + 'type' => 'string', + 'example' => 'DEPLOYED', + ], + 'AirflowId' => [ + 'title' => 'Airflow的ID', + 'description' => 'Airflow的ID。', + 'type' => 'string', + 'example' => 'af-7a6ygsh80dx1jn****', + ], + 'VSwitchId' => [ + 'title' => '交换机ID', + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1931trfxkvf74v****', + ], + 'VpcId' => [ + 'title' => 'VPC ID', + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-2zevqv4obraqd5p****', + ], + 'WorkerServerlessReplicas' => [ + 'title' => 'worker节点数量', + 'description' => 'Worker节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WorkspaceId' => [ + 'title' => 'DMS工作空间ID', + 'description' => 'DMS工作空间ID。', + 'type' => 'string', + 'example' => '8630242382****', + ], + 'ZoneId' => [ + 'title' => 'Region里的可用区ID', + 'description' => 'Region下的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'RegionId' => [ + 'title' => 'region', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Unknown error', + ], + 'HttpStatusCode' => [ + 'title' => '状态码', + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidAirflow.NotFound', + 'errorMessage' => 'The specified Airflow does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": {\\n \\"AirflowName\\": \\"testairflow\\",\\n \\"AppSpec\\": \\"SMALL\\",\\n \\"AppType\\": \\"AIRFLOW\\",\\n \\"CustomAirflowCfg\\": [\\n \\"smtp.username=test\\"\\n ],\\n \\"DagsDir\\": \\"default/dags\\",\\n \\"DeployErrorMsg\\": \\"Deployed\\",\\n \\"Description\\": \\"test airflow\\",\\n \\"GmtCreated\\": \\"2025-08-12T05:46:01.000+0000\\",\\n \\"OssBucketName\\": \\"osstest\\",\\n \\"OssPath\\": \\"/airflow\\",\\n \\"PluginsDir\\": \\"default/plugins\\",\\n \\"RequirementFile\\": \\"default/requirements.txt\\",\\n \\"SecurityGroupId\\": \\"sg-2ze9gj646bkv****\\",\\n \\"StartupFile\\": \\"default/startup.sh\\",\\n \\"Status\\": \\"DEPLOYED\\",\\n \\"AirflowId\\": \\"af-7a6ygsh80dx1jn****\\",\\n \\"VSwitchId\\": \\"vsw-bp1931trfxkvf74v****\\",\\n \\"VpcId\\": \\"vpc-2zevqv4obraqd5p****\\",\\n \\"WorkerServerlessReplicas\\": 0,\\n \\"WorkspaceId\\": \\"8630242382****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Message\\": \\"Unknown error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取Airflow实例详情', + ], + 'ListAirflows' => [ + 'summary' => '获取工作空间的Airflow实例列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DMS工作空间ID', + 'description' => 'DMS工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '86302423828****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的令牌（Token）。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当前页码，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'query', + 'schema' => [ + 'description' => '跳过n条记录，用于分页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'title' => '拒接访问的信息', + 'description' => '拒接访问的信息。', + 'type' => 'string', + 'example' => 'NOT_FOUND', + ], + 'Root' => [ + 'title' => '数据详情', + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '数据列表', + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AirflowName' => [ + 'title' => 'Airflow实例名字', + 'description' => 'Airflow实例名称。', + 'type' => 'string', + 'example' => 'test-airflow', + ], + 'AppSpec' => [ + 'title' => 'Airflow规格', + 'description' => 'Airflow规格。', + 'type' => 'string', + 'example' => 'SMALL', + ], + 'AppType' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'example' => 'AIRFLOW', + ], + 'CustomAirflowCfg' => [ + 'title' => '自定义配置', + 'description' => '自定义配置。', + 'type' => 'array', + 'items' => [ + 'title' => '配置项', + 'description' => '配置项。', + 'type' => 'string', + 'example' => 'k=v', + ], + ], + 'DagsDir' => [ + 'title' => 'Airflow扫描的dag目录', + 'description' => 'Airflow扫描的dag目录。', + 'type' => 'string', + 'example' => 'default/dags', + ], + 'DeployErrorMsg' => [ + 'title' => '发布错误信息', + 'description' => '发布错误信息。', + 'type' => 'string', + 'example' => 'quota exists', + ], + 'Description' => [ + 'title' => 'Airflow描述', + 'description' => 'Airflow实例描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'GmtCreated' => [ + 'title' => 'Airflow实例创建时间', + 'description' => 'Airflow实例创建时间。', + 'type' => 'string', + 'example' => '2025-08-12T05:46:01.000+0000', + ], + 'OssBucketName' => [ + 'title' => 'OSS bucket名字', + 'description' => 'OSS Bucket名称。', + 'type' => 'string', + 'example' => 'osstest', + ], + 'OssPath' => [ + 'title' => 'OSS路径', + 'description' => 'OSS路径。', + 'type' => 'string', + 'example' => '/airflow', + ], + 'PluginsDir' => [ + 'title' => 'Airflow扫描的插件目录', + 'description' => 'Airflow扫描的插件目录。', + 'type' => 'string', + 'example' => 'default/plugins', + ], + 'RequirementFile' => [ + 'title' => '依赖包的文件路径', + 'description' => '依赖包的文件路径。', + 'type' => 'string', + 'example' => 'default/requirements.txt', + ], + 'SecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-2ze1nak7h0alg1w****', + ], + 'Status' => [ + 'title' => 'Airflow实例状态', + 'description' => 'Airflow实例状态。', + 'type' => 'string', + 'example' => 'DEPLOYED', + ], + 'AirflowId' => [ + 'title' => 'Airflow实例ID', + 'description' => 'Airflow实例ID。', + 'type' => 'string', + 'example' => 'af-7a6ygsh80d****', + ], + 'VSwitchId' => [ + 'title' => '交换机ID', + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-uf6sxdc22x7sbdb****', + ], + 'VpcId' => [ + 'title' => 'VPC ID', + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-8vbbfm33dy0y1pek****', + ], + 'WorkerServerlessReplicas' => [ + 'title' => 'Worker节点数量', + 'description' => 'Worker节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WorkspaceId' => [ + 'title' => 'DMS工作空间ID', + 'description' => 'DMS工作空间ID。', + 'type' => 'string', + 'example' => '8630242382****', + ], + 'ZoneId' => [ + 'title' => 'Region下的可用区ID', + 'description' => 'Region下的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'StartupFile' => [ + 'title' => 'Airflow启动时加载的脚本目录', + 'description' => 'Airflow启动时加载的脚本目录。', + 'type' => 'string', + 'example' => 'default/startup.sh', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '符合条件的Airflow总数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextToken' => [ + 'description' => '下一次查询的令牌（Token）。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Reuqest ID。', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'default' => '100', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": {\\n \\"List\\": [\\n {\\n \\"AirflowName\\": \\"test-airflow\\",\\n \\"AppSpec\\": \\"SMALL\\",\\n \\"AppType\\": \\"AIRFLOW\\",\\n \\"CustomAirflowCfg\\": [\\n \\"k=v\\"\\n ],\\n \\"DagsDir\\": \\"default/dags\\",\\n \\"DeployErrorMsg\\": \\"quota exists\\",\\n \\"Description\\": \\"test\\",\\n \\"GmtCreated\\": \\"2025-08-12T05:46:01.000+0000\\",\\n \\"OssBucketName\\": \\"osstest\\",\\n \\"OssPath\\": \\"/airflow\\",\\n \\"PluginsDir\\": \\"default/plugins\\",\\n \\"RequirementFile\\": \\"default/requirements.txt\\",\\n \\"SecurityGroupId\\": \\"sg-2ze1nak7h0alg1w****\\",\\n \\"Status\\": \\"DEPLOYED\\",\\n \\"AirflowId\\": \\"af-7a6ygsh80d****\\",\\n \\"VSwitchId\\": \\"vsw-uf6sxdc22x7sbdb****\\",\\n \\"VpcId\\": \\"vpc-8vbbfm33dy0y1pek****\\",\\n \\"WorkerServerlessReplicas\\": 0,\\n \\"WorkspaceId\\": \\"8630242382****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StartupFile\\": \\"default/startup.sh\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取工作空间的Airflow实例列表', + ], + 'DeleteAirflow' => [ + 'summary' => '删除Airflow实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => 'token-****', + ], + ], + [ + 'name' => 'AirflowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Airflow的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'af-test****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '86302423828****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E0D21075-CD3E-4D98-8264-****', + ], + 'AccessDeniedDetail' => [ + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => 'NOT_FOUND', + ], + 'Root' => [ + 'description' => '删除实例的详情。', + 'type' => 'object', + 'properties' => [ + 'Responses' => [ + 'description' => '返回详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。'."\n" + ."\n" + .'> 如果资产下无进程，则不返回该统计结果。', + 'type' => 'string', + 'example' => 'af-test****'."\n", + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Instance not found.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": {\\n \\"Responses\\": [\\n {\\n \\"Success\\": true,\\n \\"Uuid\\": \\"af-test****\\\\n\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Instance not found.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除Airflow实例', + ], + 'ListDataLakeDatabase' => [ + 'summary' => '调用此API可以获取数据湖的数据库列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249748', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据目录名称。您可前往[数据湖控制台](https://dlf.console.aliyun.com/cn-hangzhou/metadata/catalog?spm=a2c4g.11186623.0.0.5a225658pT4Dkr)查看数据目录名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索数据库名称的关键字。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'DatabaseList' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库详情。', + '$ref' => '#/components/schemas/DLDatabase', + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2g****', + ], + 'MaxResults' => [ + 'description' => '限定每次返回的最大条数，可以和NextToken搭配使用实现翻页能力。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2g****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖的数据库列表', + ], + 'GetDataLakeDatabase' => [ + 'summary' => '调用此API可以获取数据湖中的数据库信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249583', + 'abilityTreeNodes' => [ + 'FEATUREdms25Q07S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '404', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF54111****', + ], + 'Database' => [ + 'description' => '数据库信息。', + '$ref' => '#/components/schemas/DLDatabase', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5EE2B9E-2F95-57FA-B284-CB441CEE****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF54111****\\",\\n \\"Database\\": {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => ' 获取数据湖的数据库信息', + ], + 'ListDataLakeCatalog' => [ + 'summary' => '调用此API可以获取数据湖的数据目录列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索数据库目录名称的关键字。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'CataLogList' => [ + 'description' => '数据目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据目录。', + '$ref' => '#/components/schemas/DLCatalog', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CataLogList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取数据湖的数据目录列表', + ], + 'GetDataLakeCatalog' => [ + 'summary' => '调用此API可以获取数据湖的数据目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249777', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B****', + ], + 'Catalog' => [ + 'description' => '数据目录信息。', + '$ref' => '#/components/schemas/DLCatalog', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B****\\",\\n \\"Catalog\\": {\\n \\"Description\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据湖的数据目录', + ], + 'ListDataLakeTablebaseInfo' => [ + 'summary' => '调用此API可以获取数据湖中表的基本信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249769', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Rows', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索表名称的关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '表所在的数据库的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据目录名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter Rows is not valid.', + ], + 'TablebaseInfoList' => [ + 'description' => '数据湖表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表的基本信息。', + '$ref' => '#/components/schemas/DLTablebaseInfo', + ], + ], + 'TotalCount' => [ + 'description' => '满足条件的表数量。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Specified parameter Rows is not valid.\\",\\n \\"TablebaseInfoList\\": [\\n {\\n \\"Owner\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": \\"100\\"\\n}","type":"json"}]', + 'title' => '获取数据湖中表的基本信息', + ], + 'GetDataLakeTable' => [ + 'summary' => '调用此API可以获取数据湖的表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249771', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '表所在的数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100g_customer', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Unknown server error', + ], + 'Table' => [ + 'description' => '获取的表信息。', + '$ref' => '#/components/schemas/DLTable', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据湖的表信息', + ], + 'BatchCreateDataLakePartitions' => [ + 'summary' => '调用此API可批量新建湖仓表分区。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'PartitionInputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '新增分区的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据湖分区信息。', + 'required' => false, + '$ref' => '#/components/schemas/DLPartitionInput', + ], + 'required' => true, + ], + ], + [ + 'name' => 'IfNotExists', + 'in' => 'query', + 'schema' => [ + 'description' => '若新增的分区名称与已有的分区名称重复，是否忽略该异常。取值：'."\n" + ."\n" + .'- **true**：忽略。'."\n" + ."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NeedResult', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回分区信息，为**true**时结果会返回Partitions。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Partitions' => [ + 'description' => '新建的分区结果列表。当**NeedResult**参数取值**true**时返回。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列表详情。', + '$ref' => '#/components/schemas/DLPartition', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"Partitions\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量新建湖仓表分区', + ], + 'UpdateDataLakeTable' => [ + 'summary' => '调用此API可更新湖仓表信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '表的信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLTableInput', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '被更新表的名称。若无需更新表名，则与TableInput的Name保持一致即可。', + 'type' => 'string', + 'required' => false, + 'example' => '100g_customer', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Table' => [ + 'description' => '表的详细信息。', + '$ref' => '#/components/schemas/DLTable', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E175****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新湖仓表信息', + ], + 'UpdateDataLakePartition' => [ + 'summary' => '调用此API可更新湖仓表分区信息。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'table_name', + ], + ], + [ + 'name' => 'PartitionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '新增分区的信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLPartitionInput', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新湖仓表分区信息', + ], + 'UpdateDataLakeDatabase' => [ + 'summary' => '调用此API可更新湖仓数据库信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库存储路径。支持oss、s3、s3a。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://path/to/database', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据库属性的键值对。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"key":"value"}'."\n", + 'description' => '参数key和value。', + ], + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****', + ], + 'ErrorCode' => [ + 'description' => '调用失败时，返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Database' => [ + 'description' => '数据库详情。', + '$ref' => '#/components/schemas/DLDatabase', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新湖仓数据库信息', + ], + 'ListDataLakeTableName' => [ + 'summary' => '调用此API可获取数据湖表名列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表名称匹配正则表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '.*', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表的类型，取值如下：'."\n" + ."\n" + .'- MANAGED\\_TABLE：内部表。'."\n" + ."\n" + .'- EXTERNAL\\_TABLE：外部表。'."\n" + ."\n" + .'- VIRTUAL\\_VIEW：虚拟视图。'."\n" + ."\n" + .'- INDEX\\_TABLE：索引表。'."\n" + ."\n" + .'- MATERIALIZED\\_VIEW：物化视图。', + 'type' => 'string', + 'required' => false, + 'example' => 'MANAGED_TABLE', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'TableNameList' => [ + 'description' => '表名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test_name', + ], + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E175****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"TableNameList\\": [\\n \\"test_name\\"\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖表名列表', + ], + 'ListDataLakeTable' => [ + 'summary' => '调用此API可获取数据湖表列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => '元数据表名称，正则表达式匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '.*', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表的类型，取值如下：'."\n" + ."\n" + .'- MANAGED\\_TABLE：内部表。'."\n" + ."\n" + .'- EXTERNAL\\_TABLE：外部表。'."\n" + ."\n" + .'- VIRTUAL\\_VIEW：虚拟视图。'."\n" + ."\n" + .'- INDEX\\_TABLE：索引表。'."\n" + ."\n" + .'- MATERIALIZED\\_VIEW：物化视图。', + 'type' => 'string', + 'required' => false, + 'example' => 'MANAGED_TABLE', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '3D3FB827-E667-50DB-AD59-C83F8237****', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'TableList' => [ + 'description' => '表详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表列表。', + '$ref' => '#/components/schemas/DLTable', + ], + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D3FB827-E667-50DB-AD59-C83F8237****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"TableList\\": [\\n {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖表列表', + ], + 'ListDataLakePartitionName' => [ + 'summary' => '调用此API可获取数据湖表分区名列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'example' => 'table_name', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'PartitionNameList' => [ + 'description' => '分区名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区名。', + 'type' => 'string', + 'example' => 'part_1', + ], + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionNameList\\": [\\n \\"part_1\\"\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖表分区名列表', + ], + 'ListDataLakePartitionByFilter' => [ + 'summary' => '调用此API可根据筛选条件获取数据湖表分区列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询条件表达式。支持如下运算符：'."\n" + .'- 比较运算符：=、<>、!=、<、<=、>、>=。例如：ds>20240101。'."\n" + .'- 逻辑运算符：AND、OR、NOT。例如：ds LIKE \'20240%\'。'."\n" + .'- BETWEEN运算符：用于指定一个范围。例如：ds BETWEEN 20240101 AND 20241201。'."\n" + .'- IN运算符：用于指定特定的值集合。例如：ds IN (20240101, 20240102)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ds>20241201', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****', + ], + 'Success' => [ + 'description' => '是否调用成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'PartitionList' => [ + 'description' => '分区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '湖仓表分区信息。', + '$ref' => '#/components/schemas/DLPartition', + ], + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '根据筛选条件获取数据湖表分区列表', + ], + 'ListDataLakePartition' => [ + 'summary' => '调用此API可获取数据湖表分区列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'PartNames', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '分区名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区名。', + 'type' => 'string', + 'required' => false, + 'example' => 'part_1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。范围在0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****', + ], + 'Success' => [ + 'description' => '查询是否成功。'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'PartitionList' => [ + 'description' => '分区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '湖仓表分区信息。', + '$ref' => '#/components/schemas/DLPartition', + ], + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'example' => 'NesLoKLEdIZrKhDT7I2gS****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖表分区列表', + ], + 'GetDataLakePartition' => [ + 'summary' => '调用此API可获取湖仓表分区详情。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'PartitionValues', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '分区值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'part_val1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '是否调用成功，取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Partition' => [ + 'description' => '湖仓表分区信息。', + '$ref' => '#/components/schemas/DLPartition', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取湖仓表分区详情', + ], + 'DeleteDataLakeTable' => [ + 'summary' => '调用此API可删除湖仓表。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8E88933E-E3D4-5BA8-8CBF-0A1CAE66****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。'."\n", + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAE66****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除湖仓表', + ], + 'DeleteDataLakePartition' => [ + 'summary' => '调用此API可删除湖仓表分区。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'table_name', + ], + ], + [ + 'name' => 'PartitionValues', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '分区值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'part_val1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'IfExists', + 'in' => 'query', + 'schema' => [ + 'description' => '如果需要删除的分区不存在，是否要忽略该异常。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '返回值说明。'."\n" + ."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除湖仓表分区', + ], + 'DeleteDataLakeDatabase' => [ + 'summary' => '调用此API可删除湖仓数据库。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C51420E3-144A-4A94-B473-8662FCF4****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除湖仓数据库', + ], + 'CreateDataLakeTable' => [ + 'summary' => '调用此API可新建湖仓表。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '表的信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLTableInput', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Table' => [ + 'description' => '表的详细信息。', + '$ref' => '#/components/schemas/DLTable', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '新建湖仓表', + ], + 'CreateDataLakePartition' => [ + 'summary' => '调用此API可新建湖仓表分区。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'PartitionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '新增分区的信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLPartitionInput', + ], + ], + [ + 'name' => 'IfNotExists', + 'in' => 'query', + 'schema' => [ + 'description' => '当新增的分区名称与已有的分区名称重复，是否忽略该异常。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NeedResult', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回新建的分区信息，为**true**时结果会返回Partition。取值：'."\n" + ."\n" + .'- **true**：返回新建的分区信息。'."\n" + ."\n" + .'- **false**：不返回新建的分区信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****', + ], + 'ErrorCode' => [ + 'description' => '请求异常时返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Partition' => [ + 'description' => '分区信息。', + '$ref' => '#/components/schemas/DLPartition', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Partition\\": {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建湖仓表分区', + ], + 'CreateDataLakeDatabase' => [ + 'summary' => '调用此API可新建湖仓数据库。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库存储路径。支持oss、s3、s3a。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://path/to/database', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据库属性的键值对。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"key":"value"}', + 'description' => '参数key和value。', + ], + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****', + ], + 'ErrorCode' => [ + 'description' => '请求异常时返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建湖仓数据库', + ], + 'BatchUpdateDataLakePartitions' => [ + 'summary' => '调用此API可批量更新湖仓表分区信息。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'PartitionInputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '新增分区的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据湖分区信息。', + 'required' => false, + '$ref' => '#/components/schemas/DLPartitionInput', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PartitionErrors' => [ + 'description' => '错误列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息。', + '$ref' => '#/components/schemas/PartitionError', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E175****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量更新湖仓表分区', + ], + 'BatchDeleteDataLakePartitions' => [ + 'summary' => '调用此API可批量删除湖仓表分区。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'table_name', + ], + ], + [ + 'name' => 'PartitionValuesList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '分区值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区值。', + 'type' => 'array', + 'items' => [ + 'description' => '分区列的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'part_val1', + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'IfExists', + 'in' => 'query', + 'schema' => [ + 'description' => '如果需要删除的分区不存在，是否要忽略该异常。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'PartitionErrors' => [ + 'description' => '错误列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息。', + '$ref' => '#/components/schemas/PartitionError', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B96E35F-A58E-5399-9041-09CF9A1E****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量删除湖仓表分区', + ], + 'CreateDataLakeFunction' => [ + 'summary' => '调用此API可以新建湖仓自定义函数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '函数的详细信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLFunctionInput', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'EE214ECD-4330-503A-82F0-FFB03975****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Function' => [ + 'description' => '函数的详细信息。', + '$ref' => '#/components/schemas/DLFunction', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE214ECD-4330-503A-82F0-FFB03975****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '新建数据湖自定义函数', + ], + 'GetDataLakeFunction' => [ + 'summary' => '调用此API可获取湖仓自定义函数的详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my_funciton', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****', + ], + 'ErrorCode' => [ + 'description' => '请求异常时返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Function' => [ + 'description' => '函数的详细信息。', + '$ref' => '#/components/schemas/DLFunction', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取湖仓自定义函数的详细信息', + ], + 'UpdateDataLakeFunction' => [ + 'summary' => '调用此API可更新湖仓自定义函数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '函数的详细信息。', + 'required' => true, + '$ref' => '#/components/schemas/DLFunctionInput', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my_funciton', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C1D39814-9808-47F8-AFE0-AF167239****', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Function' => [ + 'description' => '函数的详细信息。', + '$ref' => '#/components/schemas/DLFunction', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1D39814-9808-47F8-AFE0-AF167239****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '更新湖仓自定义函数', + ], + 'DeleteDataLakeFunction' => [ + 'summary' => '调用此API可删除湖仓自定义函数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my_funciton', + ], + ], + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3****', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C****', + ], + 'ErrorCode' => [ + 'description' => '调用失败时，返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除湖仓自定义函数', + ], + 'ListDataLakeFunction' => [ + 'summary' => '调用此API可获取数据湖函数列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名匹配的正则表达式，用于过滤返回的函数名称。', + 'type' => 'string', + 'required' => false, + 'example' => '.*', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '调用失败时，返回的错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'FunctionList' => [ + 'description' => '函数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '函数信息。', + '$ref' => '#/components/schemas/DLFunction', + ], + ], + 'NextToken' => [ + 'description' => '下一次查询的令牌（Token）。', + 'type' => 'string', + 'example' => 'f056501ada12****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"FunctionList\\": [\\n {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"f056501ada12****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖函数列表', + ], + 'ListDataLakeFunctionName' => [ + 'summary' => '调用此API可获取数据湖函数名称列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => [ + 'FEATUREdms90TD19', + 'FEATUREdmsKIHNZQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Tid', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '3****', + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据目录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'hive', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'FunctionNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名匹配的正则表达式，用于过滤返回的函数名称。', + 'type' => 'string', + 'required' => false, + 'example' => '.*', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'f056501ada12****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1C78D32-1AFD-58AD-9DD2-C8A08969****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'FunctionNameList' => [ + 'description' => '函数名称列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '函数名称列表。', + 'type' => 'string', + 'example' => 'my_funciton', + ], + ], + 'NextToken' => [ + 'description' => '下一次查询的令牌（Token）。', + 'type' => 'string', + 'example' => 'f056501ada12****', + ], + 'MaxResults' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1C78D32-1AFD-58AD-9DD2-C8A08969****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"FunctionNameList\\": [\\n \\"my_funciton\\"\\n ],\\n \\"NextToken\\": \\"f056501ada12****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '获取数据湖函数名称列表', + ], + 'GetNotebookAndSubmitTask' => [ + 'summary' => '调度运行Notebook文件。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Notebook文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/Workspace/code/default/test.ipynb', + ], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Notebook文件的传入参数，按字典格式传入。', + 'type' => 'string', + 'required' => true, + 'example' => '{\'dt\': \'2022-10-14\'}', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话ID。', + 'type' => 'string', + 'required' => true, + 'example' => '8vkixxxxx***', + ], + ], + [ + 'name' => 'Retry', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度失败后重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8630242382****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMsg' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Request Invalid', + ], + 'TaskId' => [ + 'description' => '调度任务ID。', + 'type' => 'string', + 'example' => 'IcICC2nbMpYp9KygS43n010100', + ], + 'SessionId' => [ + 'description' => '会话ID。'."\n", + 'type' => 'string', + 'example' => '5zrs5szpiezlb9m3qxi6zp32h', + ], + 'Code' => [ + 'description' => '状态码，Success表示成功。', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrMsg\\": \\"Request Invalid\\",\\n \\"TaskId\\": \\"IcICC2nbMpYp9KygS43n010100\\",\\n \\"SessionId\\": \\"5zrs5szpiezlb9m3qxi6zp32h\\",\\n \\"Code\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '提交Notebook调度任务', + ], + 'GetNotebookTaskStatus' => [ + 'summary' => '查看Notebook任务运行结果。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsXSH6IQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '调度任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2b4cb5a-7420-49a8-aa7c-528becd6e1bf', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8630242382****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Notebook会话ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8141456676986429894916354', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6', + ], + 'HttpStatusCode' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Instance not found.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + 'Code' => [ + 'description' => '状态码，Success表示成功。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '调度结果。', + 'type' => 'object', + 'properties' => [ + 'NotebookSchedulePreviewUrl' => [ + 'description' => '调度结果预览链接。', + 'type' => 'string', + 'example' => 'https://dms.aliyun.com/web-ide?***', + ], + 'Status' => [ + 'description' => '调度结果状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Progress' => [ + 'description' => '调度运行进度。', + 'type' => 'string', + 'example' => '5/6', + ], + 'Result' => [ + 'description' => '调度输出。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Instance not found.\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Code\\": \\"Success\\",\\n \\"Data\\": {\\n \\"NotebookSchedulePreviewUrl\\": \\"https://dms.aliyun.com/web-ide?***\\",\\n \\"Status\\": \\"Success\\",\\n \\"Progress\\": \\"5/6\\",\\n \\"Result\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => '获取Notebook调度任务执行状态', + ], + 'DescribeFileUploadSignature' => [ + 'summary' => 'DescribeFileUploadSignature', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou'."\n", + ], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '仅前端使用', + 'type' => 'string', + 'required' => false, + 'example' => '仅前端使用', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0FEE5834-C55A-5995-A6A3-B443304965BD', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'OssCredential' => [ + 'description' => '指明派生密钥的参数集', + 'type' => 'string', + 'example' => 'STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request', + ], + 'OssDate' => [ + 'description' => '请求的时间，其格式遵循ISO 8601日期和时间标准', + 'type' => 'string', + 'example' => '20260101T135341Z', + ], + 'OssSignatureVersion' => [ + 'description' => '指定签名的版本和算法', + 'type' => 'string', + 'example' => 'OSS4-HMAC-SHA256', + ], + 'OssSignature' => [ + 'description' => '用于签名认证的描述信息', + 'type' => 'string', + 'example' => '9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********', + ], + 'OssSecurityToken' => [ + 'description' => '上传到OSS使用的STS token，1小时有效', + 'type' => 'string', + 'example' => 'CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********', + ], + 'Policy' => [ + 'description' => '文件上传权限限制和约束条件', + 'type' => 'string', + 'example' => 'eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********'."\n", + ], + 'UploadHost' => [ + 'description' => '文件上传的目标地址', + 'type' => 'string', + 'example' => 'https://**********.oss-cn-hangzhou.aliyuncs.com', + ], + 'UploadDir' => [ + 'description' => '文件上传的路径', + 'type' => 'string', + 'example' => 'data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEE5834-C55A-5995-A6A3-B443304965BD\\",\\n \\"Data\\": {\\n \\"OssCredential\\": \\"STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request\\",\\n \\"OssDate\\": \\"20260101T135341Z\\",\\n \\"OssSignatureVersion\\": \\"OSS4-HMAC-SHA256\\",\\n \\"OssSignature\\": \\"9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********\\",\\n \\"OssSecurityToken\\": \\"CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********\\",\\n \\"Policy\\": \\"eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********\\\\n\\",\\n \\"UploadHost\\": \\"https://**********.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"UploadDir\\": \\"data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\"\\n}","type":"json"}]', + 'title' => '获取文件上传签名信息', + ], + 'FileUploadCallback' => [ + 'summary' => 'FileUploadCallback', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou'."\n", + ], + ], + [ + 'name' => 'Filename', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称', + 'type' => 'string', + 'required' => true, + 'example' => 'conversion_metrics.csv', + ], + ], + [ + 'name' => 'UploadLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '文件上传完整路径'."\n" + .'- 格式：DescribeFileUploadSignature接口返回的UploadDir字段拼接上文件名'."\n" + .'- 示例：${UploadDir}/${Filename}', + 'type' => 'string', + 'required' => true, + 'example' => 'data_agent/file_upload/174483******/20251219T******Z/n87bgtx6dk******/conversion_metrics.csv', + ], + ], + [ + 'name' => 'FileSize', + 'in' => 'query', + 'schema' => [ + 'description' => '文件大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8110', + ], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '仅前端使用', + 'type' => 'string', + 'required' => false, + 'example' => 'TrailCenter', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '841BC14F-8E21-56B0-A7D6-593C5841AC84', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件ID', + 'type' => 'string', + 'example' => 'f-8*******01m'."\n", + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"841BC14F-8E21-56B0-A7D6-593C5841AC84\\",\\n \\"Data\\": {\\n \\"FileId\\": \\"f-8*******01m\\\\n\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\"\\n}","type":"json"}]', + 'title' => '文件上传后回调', + ], + 'GetChatContent' => [ + 'summary' => '通过指定会话ID和AgentId，从特定检查点开始获取聊天内容。', + 'path' => '/api/v1/chat/stream', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前所在的DMS单元，阿里云国内站用户默认填入cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话 ID，必须字段'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sess_12345', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AgentId，必填'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx-xxxx-xxxx', + ], + ], + [ + 'name' => 'Checkpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '后端将从这个接口开始返回输出'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'SSE响应流的每条data都符合该json结构', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '消息内容', + 'type' => 'string', + 'example' => 'Data understanding completed.', + ], + 'event_type' => [ + 'description' => '消息的类型，用于区分控制符和具体消息。如 `CHAT_START`表示Agent的一次回复开始，`CHAT_FINISH`表示Agent的一次回复结束。`DATA`表示这是一条携带了内容的消息，`DELTA`表示这是一条增量输出的消息的一部分.', + 'type' => 'string', + 'example' => 'DATA', + ], + 'content_type' => [ + 'description' => 'content字段的类型，可取值: `[str, json]`。当取值为json时，content字段可进一步解析为json结构', + 'type' => 'string', + 'example' => 'str', + ], + 'checkpoint' => [ + 'description' => 'Checkpoint值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'level' => [ + 'description' => '消息的输出级别，级别越高越重要', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'category' => [ + 'description' => '消息的类别，用于辅助json类型的content的解析。如`PLAN`表示该消息是执行计划的展示，会符合执行计划的Schema。', + 'type' => 'string', + 'example' => 'PLAN', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"content\\": \\"Data understanding completed.\\",\\n \\"event_type\\": \\"DATA\\",\\n \\"content_type\\": \\"str\\",\\n \\"checkpoint\\": 0,\\n \\"level\\": 20,\\n \\"category\\": \\"PLAN\\"\\n}","type":"json"}]', + 'title' => '获取聊天内容', + 'description' => '## 请求说明'."\n" + .'- 响应将以SSE流的形式返回，其中每个事件都遵循`SSEEvent`模式，包含有关消息级别的元信息等。'."\n" + .'- 每个SSE事件中的`content`字段可能携带实际的消息文本或JSON对象，具体取决于`content_type`的值。', + ], + 'DeleteFileUpload' => [ + 'summary' => 'DeleteFileUpload', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou'."\n", + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件ID', + 'type' => 'string', + 'required' => true, + 'example' => 'f-8*******01m'."\n", + ], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '仅前端使用', + 'type' => 'string', + 'required' => false, + 'example' => 'TrailCenter', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件ID', + 'type' => 'string', + 'example' => 'f-8*******01m'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"FileId\\": \\"f-8*******01m\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '删除上传文件', + ], + 'SendChatMessage' => [ + 'summary' => '向指定会话发送用户消息或取消会话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '您当前所在的DMS单元。若您选择分析数据库，该信息将用于后续通过DMS正确连接到您的DMS实例。您可前往DMS控制台查看您当前所在的DMS单元，若您是阿里云中国站用户，可以直接填入cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话 ID，必须字段。您可以通过CreateAgentSession获取SessionId。', + 'type' => 'string', + 'required' => true, + 'example' => 'sess_***', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AgentId，必填。您可通过CreateAgentSession接口的返回值获取当前的AgentID。Agent资源存在生命周期，因此您每次请求需要填入的AgentID可能变化。', + 'type' => 'string', + 'required' => true, + 'example' => 'agent_***', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '本次向Agent发送的消息内容', + 'type' => 'string', + 'required' => true, + 'example' => 'what can you do?', + ], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息类型，默认为 `[primary]`。当该消息为响应Agent的Human-in-Loop问题时，类型应当是`[additional]`；当该消息是要取消当前会话时，类型应当是`[cancel]`。', + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + 'default' => 'primary', + 'enum' => [ + 'primary', + 'additional', + 'cancel', + 'operate', + ], + ], + ], + [ + 'name' => 'ReplyTo', + 'in' => 'query', + 'schema' => [ + 'description' => '表示这条消息是对哪条Agent消息的响应。该字段应当传入当前收到的最大的Checkpoint序号，若是首条消息则填入0。该字段会用于偶发网络问题或者消息重复发送时的消息去重。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'QuotedMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '传入当前引用内容，通常在与Agent交互时使用。', + 'type' => 'string', + 'required' => false, + 'example' => '{"version":"v0"}', + ], + ], + [ + 'name' => 'Question', + 'in' => 'query', + 'schema' => [ + 'description' => '当消息类型为`additional`时为必须字段，传入Agent通过Human-in-Loop向用户提问的具体问题。', + 'type' => 'string', + 'required' => false, + 'example' => '请提供计算GMV的口径。', + ], + ], + [ + 'name' => 'DataSource', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据源信息，可为空'."\n", + 'type' => 'object', + 'properties' => [ + 'DataSourceType' => [ + 'description' => '数据源类型。可取值`[remote_data_center, database]`，分别表示本次分析是文件或者数据库。', + 'type' => 'string', + 'required' => false, + 'example' => 'remote_data_center', + ], + 'DataSourceId' => [ + 'description' => '已废弃，无需填入', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + 'Location' => [ + 'description' => '已废弃，无需填入', + 'type' => 'string', + 'required' => false, + 'example' => 'localhost', + ], + 'Database' => [ + 'description' => '已废弃，无需填入', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'Engine' => [ + 'description' => '数据库类型', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + 'Tables' => [ + 'description' => '需要分析的表名称的列表', + 'type' => 'array', + 'items' => [ + 'description' => '需要分析的表名', + 'type' => 'string', + 'required' => false, + 'example' => 'my_table', + ], + 'required' => false, + ], + 'FileId' => [ + 'description' => '文件ID', + 'type' => 'string', + 'required' => false, + 'example' => '35****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'DbName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'DmsInstanceId' => [ + 'description' => '实例在DMS的ID', + 'type' => 'string', + 'required' => false, + 'example' => '12******', + ], + 'DmsDatabaseId' => [ + 'description' => '数据库在DMS的ID', + 'type' => 'string', + 'required' => false, + 'example' => '23******', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SessionConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '本次会话的特殊配置。同一个Session只有第一次SendMessage的时候带下来的配置才会生效。', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'description' => '当前只支持中英文，默认是中文，只支持大写'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ENGLISH', + ], + 'CustomAgentId' => [ + 'description' => '已废弃，以CreateAgentSession入参为准', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'CustomAgentStage' => [ + 'description' => '已废弃，以CreateAgentSession入参为准', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'ReportWaterMark' => [ + 'description' => '可填入64字符以内的文本，会用于在生成的PDF格式的报告中添加水印。', + 'type' => 'string', + 'required' => false, + 'example' => '示例水印', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ParentSessionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Jarvis Web应用收到请求并缓存之后，会直接响应200。'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => 'FE65CE1F-****-****-****-******', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'Data' => [ + 'description' => '响应数据'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'Message'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'SessionId' => [ + 'description' => 'SessionId'."\n", + 'type' => 'string', + 'example' => '6zbqbho********', + ], + 'AgentId' => [ + 'description' => 'AgentId'."\n", + 'type' => 'string', + 'example' => '3jqqdiuxun******', + ], + ], + ], + 'Success' => [ + 'description' => 'Success'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE65CE1F-****-****-****-******\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"SessionId\\": \\"6zbqbho********\\",\\n \\"AgentId\\": \\"3jqqdiuxun******\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '发送聊天消息', + 'description' => '## 请求说明'."\n" + ."\n" + .'- `agent_id` 和 `session_id` 是必填字段。'."\n" + .'- `message_type` 默认为 `primary`，当需要追加信息或取消会话时，请设置为 `additional` 或 `cancel`。'."\n" + .'- `reply_to` 字段用于表示这条消息是对哪条Agent消息的响应，默认值为 `0`。'."\n" + .'- 当 `message_type` 为 `additional` 时，`question` 字段是必须的。'."\n" + .'- `quoted_message` 可以用来引用用户之前的消息内容。'."\n" + .'- `data_source`, `dms_user`, `db_metadata`, `session_config` 等字段均为可选，但提供了更详细的上下文信息。', + ], + 'DescribeDataAgentSession' => [ + 'summary' => '获取DataAgent会话描述信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Agent会话ID', + 'type' => 'string', + 'required' => false, + 'example' => 'c61n7gm******rj', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '18****-*****-*******7A3122F', + ], + 'Data' => [ + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => 'Agent会话Id', + 'type' => 'string', + 'example' => '976*********p', + ], + 'SessionStatus' => [ + 'description' => '会话状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'AgentId' => [ + 'description' => '当前Agent Id', + 'type' => 'string', + 'example' => 'cu0cs*******mf', + ], + 'AgentStatus' => [ + 'description' => '当前Agent 状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Title' => [ + 'description' => '标题', + 'type' => 'string', + 'example' => '分析一下这份文件，给出报告。', + ], + 'ChatHistoryLocations' => [ + 'description' => '会话回放历史', + 'type' => 'array', + 'items' => [ + 'description' => '会话回放的元素', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '会话回放历史的Key', + 'type' => 'string', + 'example' => 'testKey1', + ], + 'Url' => [ + 'description' => '会话回放历史的OSS下载链接', + 'type' => 'string', + 'example' => '****', + ], + ], + ], + ], + 'File' => [ + 'description' => '文件Id', + 'type' => 'string', + 'example' => 'f-8*******01m', + ], + 'SessionConfig' => [ + 'description' => '会话的配置项', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'description' => '语言'."\n" + .'- **CHINESE** 中文'."\n" + .'- **ENGLISH** 英语', + 'type' => 'string', + 'example' => 'CHINESE', + ], + 'CustomAgentId' => [ + 'description' => '自定义Agent Id', + 'type' => 'string', + 'example' => 'ca-e*******ckd', + ], + 'CustomAgentStage' => [ + 'description' => '自定义Agent的使用阶段：'."\n" + .'- **debug** 调试阶段'."\n" + .'- **prod** 正式生产阶段', + 'type' => 'string', + 'example' => 'debug', + ], + 'Mode' => [ + 'description' => '模式：'."\n" + .' - **ASK_DATA** 问数模式'."\n" + .' - **ANALYSIS** 分析模式'."\n" + .' - **INSIGHT** 洞察模式', + 'type' => 'string', + 'example' => 'ANALYSIS', + ], + 'EnableSearch' => [ + 'description' => '是否开启联网搜索。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'McpServerIds' => [ + 'title' => '会话配置中的MCP服务器ID列表', + 'description' => '会话配置中的MCP服务器ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '会话配置中的MCP服务器ID', + 'description' => '会话配置中的MCP服务器ID', + 'type' => 'string', + 'example' => '2q1tu90**********6uttu2nw', + ], + ], + 'UserOssBucket' => [ + 'description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', + 'type' => 'string', + 'example' => 'user-oss-bucket', + ], + 'EncryptType' => [ + 'title' => '加密类型', + 'description' => '加密类型', + 'type' => 'string', + ], + 'EncryptKey' => [ + 'title' => '加密秘钥', + 'description' => '加密秘钥', + 'type' => 'string', + ], + 'ReportWaterMark' => [ + 'title' => '报告水印', + 'description' => '报告水印', + 'type' => 'string', + ], + 'ReportPageWidth' => [ + 'title' => '报告页面宽度', + 'description' => '报告页面宽度', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'CreateTime' => [ + 'description' => '会话创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731645908000', + ], + 'Saved' => [ + 'description' => '是否被当前登录人收藏', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FavoriteInWorkspace' => [ + 'description' => '是否在工作空间中被当前登录人收藏', + 'type' => 'string', + 'example' => 'true', + ], + 'UserId' => [ + 'description' => '会话拥有人Id', + 'type' => 'string', + 'example' => '2096******', + ], + ], + ], + 'Success' => [ + 'description' => '返回值说明。'."\n" + ."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18****-*****-*******7A3122F\\",\\n \\"Data\\": {\\n \\"SessionId\\": \\"976*********p\\",\\n \\"SessionStatus\\": \\"RUNNING\\",\\n \\"AgentId\\": \\"cu0cs*******mf\\",\\n \\"AgentStatus\\": \\"RUNNING\\",\\n \\"Title\\": \\"分析一下这份文件，给出报告。\\",\\n \\"ChatHistoryLocations\\": [\\n {\\n \\"Key\\": \\"testKey1\\",\\n \\"Url\\": \\"****\\"\\n }\\n ],\\n \\"File\\": \\"f-8*******01m\\",\\n \\"SessionConfig\\": {\\n \\"Language\\": \\"CHINESE\\",\\n \\"CustomAgentId\\": \\"ca-e*******ckd\\",\\n \\"CustomAgentStage\\": \\"debug\\",\\n \\"Mode\\": \\"ANALYSIS\\",\\n \\"EnableSearch\\": true,\\n \\"McpServerIds\\": [\\n \\"2q1tu90**********6uttu2nw\\"\\n ],\\n \\"UserOssBucket\\": \\"user-oss-bucket\\",\\n \\"EncryptType\\": \\"\\",\\n \\"EncryptKey\\": \\"\\",\\n \\"ReportWaterMark\\": \\"\\",\\n \\"ReportPageWidth\\": 0\\n },\\n \\"CreateTime\\": 1731645908000,\\n \\"Saved\\": true,\\n \\"FavoriteInWorkspace\\": \\"true\\",\\n \\"UserId\\": \\"2096******\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]', + 'title' => '获取DataAgent会话描述', + ], + 'CreateDataAgentSession' => [ + 'summary' => '创建DataAgent会话', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '标题，支持中英文，最大长度128位。', + 'type' => 'string', + 'required' => false, + 'example' => '帮我分析一下这份数据，给出报告。', + ], + ], + [ + 'name' => 'File', + 'in' => 'query', + 'schema' => [ + 'description' => '文件Id', + 'type' => 'string', + 'required' => false, + 'example' => 'f-8*******01m', + ], + ], + [ + 'name' => 'SessionConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '会话配置', + 'description' => '会话配置信息', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'description' => '语言'."\n" + .'- **CHINESE** 中文'."\n" + .'- **ENGLISH** 英语', + 'type' => 'string', + 'required' => false, + 'example' => 'CHINESE', + ], + 'CustomAgentId' => [ + 'description' => '自定义Agent Id', + 'type' => 'string', + 'required' => false, + 'example' => 'ca-e*******ckd', + ], + 'CustomAgentStage' => [ + 'description' => '自定义Agent的使用阶段：'."\n" + .'- **debug** 调试阶段'."\n" + .'- **prod** 正式生产阶段', + 'type' => 'string', + 'required' => false, + 'example' => 'debug', + ], + 'Mode' => [ + 'description' => '模式：'."\n" + .' - **ASK_DATA** 问数模式'."\n" + .' - **ANALYSIS** 分析模式'."\n" + .' - **INSIGHT** 洞察模式', + 'type' => 'string', + 'required' => false, + 'example' => 'ANALYSIS', + ], + 'EnableSearch' => [ + 'description' => '是否开启联网搜索。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'McpServerIds' => [ + 'title' => '会话配置中的MCP服务器ID列表', + 'description' => '会话配置中的 MCP 服务器 ID 列表', + 'type' => 'array', + 'items' => [ + 'title' => '会话配置中MCP服务器ID', + 'description' => '会话配置中的 MCP 服务器 ID', + 'type' => 'string', + 'required' => false, + 'example' => '2q1tu90**********6uttu2nw', + ], + 'required' => false, + ], + 'UserOssBucket' => [ + 'description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', + 'type' => 'string', + 'required' => false, + 'example' => 'user-oss-bucket', + ], + 'EncryptType' => [ + 'title' => '加密方式', + 'type' => 'string', + 'required' => false, + ], + 'EncryptKey' => [ + 'title' => '加密秘钥', + 'type' => 'string', + 'required' => false, + ], + 'ReportWaterMark' => [ + 'title' => '报告水印', + 'type' => 'string', + 'required' => false, + ], + 'ReportPageWidth' => [ + 'title' => '报告页面宽度', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1CB***********3F1A', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => 'Agent会话Id', + 'type' => 'string', + 'example' => '976*********p', + ], + 'SessionStatus' => [ + 'description' => '会话状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'AgentId' => [ + 'description' => 'Agent Id', + 'type' => 'string', + 'example' => 'cu0cs*******mf', + ], + 'AgentStatus' => [ + 'description' => 'Agent 状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Title' => [ + 'description' => '标题', + 'type' => 'string', + 'example' => '帮我分析一下这份数据，给出报告。', + ], + 'File' => [ + 'description' => '文件的基本信息。', + 'type' => 'string', + 'example' => 'f-8*******01m', + ], + 'SessionConfig' => [ + 'description' => '会话配置信息', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'description' => '语言'."\n" + .'- **CHINESE** 中文'."\n" + .'- **ENGLISH** 英语', + 'type' => 'string', + 'example' => 'CHINESE', + ], + 'CustomAgentId' => [ + 'description' => '自定义Agent Id', + 'type' => 'string', + 'example' => 'ca-e*******ckd', + ], + 'CustomAgentStage' => [ + 'description' => '自定义Agent的使用阶段：'."\n" + .'- **debug** 调试阶段'."\n" + .'- **prod** 正式生产阶段', + 'type' => 'string', + 'example' => 'debug', + ], + 'Mode' => [ + 'description' => '模式：'."\n" + .' - **ASK_DATA** 问数模式'."\n" + .' - **ANALYSIS** 分析模式'."\n" + .' - **INSIGHT** 洞察模式', + 'type' => 'string', + 'example' => 'ANALYSIS', + ], + 'EnableSearch' => [ + 'description' => '是否开启联网搜索。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'McpServerIds' => [ + 'title' => '会话配置中的MCP服务器ID列表', + 'description' => '会话配置中的MCP服务器ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '会话配置中的MCP服务器ID', + 'description' => '会话配置中的MCP服务器ID', + 'type' => 'string', + 'example' => '2q1tu90**********6uttu2nw', + ], + ], + 'UserOssBucket' => [ + 'description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', + 'type' => 'string', + 'example' => 'user-oss-bucket', + ], + 'EncryptType' => [ + 'title' => '加密类型', + 'description' => '加密类型', + 'type' => 'string', + ], + 'EncryptKey' => [ + 'title' => '加密密钥', + 'description' => '加密密钥', + 'type' => 'string', + ], + 'ReportWaterMark' => [ + 'title' => '报告水印', + 'description' => '报告水印', + 'type' => 'string', + ], + 'ReportPageWidth' => [ + 'title' => '报告页面宽度', + 'description' => '报告页面宽度', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'CreateTime' => [ + 'description' => '会话的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765262307992', + ], + 'Saved' => [ + 'description' => '是否被当前登录人收藏', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'UnknownError', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CB***********3F1A\\",\\n \\"Data\\": {\\n \\"SessionId\\": \\"976*********p\\",\\n \\"SessionStatus\\": \\"RUNNING\\",\\n \\"AgentId\\": \\"cu0cs*******mf\\",\\n \\"AgentStatus\\": \\"RUNNING\\",\\n \\"Title\\": \\"帮我分析一下这份数据，给出报告。\\",\\n \\"File\\": \\"f-8*******01m\\",\\n \\"SessionConfig\\": {\\n \\"Language\\": \\"CHINESE\\",\\n \\"CustomAgentId\\": \\"ca-e*******ckd\\",\\n \\"CustomAgentStage\\": \\"debug\\",\\n \\"Mode\\": \\"ANALYSIS\\",\\n \\"EnableSearch\\": true,\\n \\"McpServerIds\\": [\\n \\"2q1tu90**********6uttu2nw\\"\\n ],\\n \\"UserOssBucket\\": \\"user-oss-bucket\\",\\n \\"EncryptType\\": \\"\\",\\n \\"EncryptKey\\": \\"\\",\\n \\"ReportWaterMark\\": \\"\\",\\n \\"ReportPageWidth\\": 0\\n },\\n \\"CreateTime\\": 1765262307992,\\n \\"Saved\\": false\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]', + 'title' => '创建DataAgent会话', + ], + 'ListFileUpload' => [ + 'summary' => 'ListFileUpload', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou'."\n", + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID', + 'type' => 'string', + 'required' => false, + 'example' => 'h8r********4fch', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件ID', + 'type' => 'string', + 'required' => false, + 'example' => 'f-8*******01m'."\n", + ], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '仅前端使用', + 'type' => 'string', + 'required' => false, + 'example' => '仅前端使用', + ], + ], + [ + 'name' => 'FileFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '文件来源', + 'type' => 'string', + 'required' => false, + 'example' => 'Agent', + ], + ], + [ + 'name' => 'FileCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '文件种类', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'WebReport' => '网页报告', + 'TextReport' => '文字报告', + 'DefaultArtifact' => '默认产物', + ], + 'example' => 'TextReport', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'query', + 'schema' => [ + 'description' => '排序列', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'gmtCreated' => '创建时间', + ], + 'example' => 'gmtCreated', + ], + ], + [ + 'name' => 'SortDirection', + 'in' => 'query', + 'schema' => [ + 'description' => '排列顺序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序', + 'desc' => '降序', + ], + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'Success' => [ + 'description' => '是否调用成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + 'Data' => [ + 'description' => '返回的结构体', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件ID', + 'type' => 'string', + 'example' => 'f-8*******01m'."\n", + ], + 'FileName' => [ + 'description' => '文件名称', + 'type' => 'string', + 'example' => 'samele_report.md', + ], + 'FileType' => [ + 'description' => '文件类型，扩展名', + 'type' => 'string', + 'example' => 'md'."\n", + ], + 'FileSize' => [ + 'description' => '文件大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7453', + ], + 'UploadLocation' => [ + 'description' => '文件上传路径', + 'type' => 'string', + 'example' => 'data_agent/agent_file_upload/16738266********/4mynz********/samele_report.md', + ], + 'DownloadLink' => [ + 'description' => '公网下载链接，有效期为1小时', + 'type' => 'string', + 'example' => 'https://********.oss-cn-hangzhou.aliyuncs.com/data_agent/agent_file_upload/1673866201******/6kaqhjd81agobeg7r********/sample_report.md?Expires=1765526467&OSSAccessKeyId=STS.NZP89ErN4A5BMuFMSovQjripY&Signature=eRjLGooo1EQvDyMphUS%2FQH5nt38%3D&response-content-disposition=attachment&security-token=CAIS6wN1q6Ft5B2yfSjIr5nlc4Pxn5EV9vepT1P3qVM6et5Gnazbuzz2IHhMdXlrCOgYt%2F8xnG1V6f8flrJ%2FToQAX0HfatZq5ZkS9AqnaoXM%2Fte496IFg5D92d4278egjqHoeOzcYI733Z7PAgm2N0YRrJL%2BcTK9JRPHVbSClZ9gaPkOQwC8dkAoLdxKJwxk2qh4UHzKLqSCPwLNiGjdB1YSRGMe71ly8qOi2MaRxwPDhVnhsI8vqp%2F2P4KvYrt%2BXod2WMzn2%2FdtJOiTknxc7gMP%2BK5qhelN9jrBopSFGV5dphyedvHT78FvIQZieu1jXKJNsPHLnPJ1vPCUnov6zQp6M%2BBRXhPCXISnyceDQb32bYZjK%2BimYy2QiInRaN6l7Bl6YnsCbQpUccM%2BMHJ%2FDhYsSD3IJbenvxLoGl77E%2FXdifxvjMcllA62o4uwSgLRE%2BnD40ExIYQhak4kDRkS0FH6f7UOGw42KAs%2FVubOHN0tNUsA8f614lSPTF5pynBGovvyYujOoKcUZJ7kX5RJ3YMBbY5Bt2Y6mutDnA5aJC3%2BHUkSotY%2BuMGFUffXY488UCSQqje%2BPfruvExMcBH%2FrSCUqLWZ0UGeHSXbkINxMi0cPU0dPmqR4erXLz22Z%2Br%2FEqmG17cNuMM2n2RioYeLOhqAAXurgCh5hs3XZ3n42rAf5nUhbzmxvSEozjif16B9zOwNlEH5LvhHfJ95roMLxAAeOW95A0mhbPco%2Fas3aqZv3lWCrmYuU6sGoioo86ezXyDrFD44YdkxC%2BP0yAQ2xi7tErXAyqbfJ4y40b2a0blRmu%2FI4s3jcLyLnUSNx3f9bXjCIAA%3D', + ], + 'IntranetDownloadLink' => [ + 'description' => '内网下载链接，有效期为1小时', + 'type' => 'string', + 'example' => 'https://********.oss-cn-hangzhou-internal.aliyuncs.com/data_agent/agent_file_upload/1673866201******/6kaqhjd81agobeg7r********/sample_report.md?Expires=1765526467&OSSAccessKeyId=STS.NZP89ErN4A5BMuFMSovQjripY&Signature=eRjLGooo1EQvDyMphUS%2FQH5nt38%3D&response-content-disposition=attachment&security-token=CAIS6wN1q6Ft5B2yfSjIr5nlc4Pxn5EV9vepT1P3qVM6et5Gnazbuzz2IHhMdXlrCOgYt%2F8xnG1V6f8flrJ%2FToQAX0HfatZq5ZkS9AqnaoXM%2Fte496IFg5D92d4278egjqHoeOzcYI733Z7PAgm2N0YRrJL%2BcTK9JRPHVbSClZ9gaPkOQwC8dkAoLdxKJwxk2qh4UHzKLqSCPwLNiGjdB1YSRGMe71ly8qOi2MaRxwPDhVnhsI8vqp%2F2P4KvYrt%2BXod2WMzn2%2FdtJOiTknxc7gMP%2BK5qhelN9jrBopSFGV5dphyedvHT78FvIQZieu1jXKJNsPHLnPJ1vPCUnov6zQp6M%2BBRXhPCXISnyceDQb32bYZjK%2BimYy2QiInRaN6l7Bl6YnsCbQpUccM%2BMHJ%2FDhYsSD3IJbenvxLoGl77E%2FXdifxvjMcllA62o4uwSgLRE%2BnD40ExIYQhak4kDRkS0FH6f7UOGw42KAs%2FVubOHN0tNUsA8f614lSPTF5pynBGovvyYujOoKcUZJ7kX5RJ3YMBbY5Bt2Y6mutDnA5aJC3%2BHUkSotY%2BuMGFUffXY488UCSQqje%2BPfruvExMcBH%2FrSCUqLWZ0UGeHSXbkINxMi0cPU0dPmqR4erXLz22Z%2Br%2FEqmG17cNuMM2n2RioYeLOhqAAXurgCh5hs3XZ3n42rAf5nUhbzmxvSEozjif16B9zOwNlEH5LvhHfJ95roMLxAAeOW95A0mhbPco%2Fas3aqZv3lWCrmYuU6sGoioo86ezXyDrFD44YdkxC%2BP0yAQ2xi7tErXAyqbfJ4y40b2a0blRmu%2FI4s3jcLyLnUSNx3f9bXjCIAA%3D', + ], + 'Region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AliyunUid' => [ + 'description' => '阿里云账户ID', + 'type' => 'string', + 'example' => '20372822********'."\n", + ], + 'AliyunParentUid' => [ + 'description' => '阿里云主账号ID', + 'type' => 'string', + 'example' => '16738266********', + ], + 'SessionId' => [ + 'description' => '会话ID', + 'type' => 'string', + 'example' => 'h8r********4fch', + ], + 'FileFrom' => [ + 'description' => '文件来源', + 'type' => 'string', + 'example' => 'Agent', + ], + 'FileCategory' => [ + 'description' => '文件种类', + 'type' => 'string', + 'enumValueTitles' => [ + 'WebReport' => '网页报告', + 'TextReport' => '文字报告', + 'DefaultArtifact' => '默认产物', + ], + 'example' => 'TextReport', + ], + 'GmtCreated' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": [\\n {\\n \\"FileId\\": \\"f-8*******01m\\\\n\\",\\n \\"FileName\\": \\"samele_report.md\\",\\n \\"FileType\\": \\"md\\\\n\\",\\n \\"FileSize\\": 7453,\\n \\"UploadLocation\\": \\"data_agent/agent_file_upload/16738266********/4mynz********/samele_report.md\\",\\n \\"DownloadLink\\": \\"https://********.oss-cn-hangzhou.aliyuncs.com/data_agent/agent_file_upload/1673866201******/6kaqhjd81agobeg7r********/sample_report.md?Expires=1765526467&OSSAccessKeyId=STS.NZP89ErN4A5BMuFMSovQjripY&Signature=eRjLGooo1EQvDyMphUS%2FQH5nt38%3D&response-content-disposition=attachment&security-token=CAIS6wN1q6Ft5B2yfSjIr5nlc4Pxn5EV9vepT1P3qVM6et5Gnazbuzz2IHhMdXlrCOgYt%2F8xnG1V6f8flrJ%2FToQAX0HfatZq5ZkS9AqnaoXM%2Fte496IFg5D92d4278egjqHoeOzcYI733Z7PAgm2N0YRrJL%2BcTK9JRPHVbSClZ9gaPkOQwC8dkAoLdxKJwxk2qh4UHzKLqSCPwLNiGjdB1YSRGMe71ly8qOi2MaRxwPDhVnhsI8vqp%2F2P4KvYrt%2BXod2WMzn2%2FdtJOiTknxc7gMP%2BK5qhelN9jrBopSFGV5dphyedvHT78FvIQZieu1jXKJNsPHLnPJ1vPCUnov6zQp6M%2BBRXhPCXISnyceDQb32bYZjK%2BimYy2QiInRaN6l7Bl6YnsCbQpUccM%2BMHJ%2FDhYsSD3IJbenvxLoGl77E%2FXdifxvjMcllA62o4uwSgLRE%2BnD40ExIYQhak4kDRkS0FH6f7UOGw42KAs%2FVubOHN0tNUsA8f614lSPTF5pynBGovvyYujOoKcUZJ7kX5RJ3YMBbY5Bt2Y6mutDnA5aJC3%2BHUkSotY%2BuMGFUffXY488UCSQqje%2BPfruvExMcBH%2FrSCUqLWZ0UGeHSXbkINxMi0cPU0dPmqR4erXLz22Z%2Br%2FEqmG17cNuMM2n2RioYeLOhqAAXurgCh5hs3XZ3n42rAf5nUhbzmxvSEozjif16B9zOwNlEH5LvhHfJ95roMLxAAeOW95A0mhbPco%2Fas3aqZv3lWCrmYuU6sGoioo86ezXyDrFD44YdkxC%2BP0yAQ2xi7tErXAyqbfJ4y40b2a0blRmu%2FI4s3jcLyLnUSNx3f9bXjCIAA%3D\\",\\n \\"IntranetDownloadLink\\": \\"https://********.oss-cn-hangzhou-internal.aliyuncs.com/data_agent/agent_file_upload/1673866201******/6kaqhjd81agobeg7r********/sample_report.md?Expires=1765526467&OSSAccessKeyId=STS.NZP89ErN4A5BMuFMSovQjripY&Signature=eRjLGooo1EQvDyMphUS%2FQH5nt38%3D&response-content-disposition=attachment&security-token=CAIS6wN1q6Ft5B2yfSjIr5nlc4Pxn5EV9vepT1P3qVM6et5Gnazbuzz2IHhMdXlrCOgYt%2F8xnG1V6f8flrJ%2FToQAX0HfatZq5ZkS9AqnaoXM%2Fte496IFg5D92d4278egjqHoeOzcYI733Z7PAgm2N0YRrJL%2BcTK9JRPHVbSClZ9gaPkOQwC8dkAoLdxKJwxk2qh4UHzKLqSCPwLNiGjdB1YSRGMe71ly8qOi2MaRxwPDhVnhsI8vqp%2F2P4KvYrt%2BXod2WMzn2%2FdtJOiTknxc7gMP%2BK5qhelN9jrBopSFGV5dphyedvHT78FvIQZieu1jXKJNsPHLnPJ1vPCUnov6zQp6M%2BBRXhPCXISnyceDQb32bYZjK%2BimYy2QiInRaN6l7Bl6YnsCbQpUccM%2BMHJ%2FDhYsSD3IJbenvxLoGl77E%2FXdifxvjMcllA62o4uwSgLRE%2BnD40ExIYQhak4kDRkS0FH6f7UOGw42KAs%2FVubOHN0tNUsA8f614lSPTF5pynBGovvyYujOoKcUZJ7kX5RJ3YMBbY5Bt2Y6mutDnA5aJC3%2BHUkSotY%2BuMGFUffXY488UCSQqje%2BPfruvExMcBH%2FrSCUqLWZ0UGeHSXbkINxMi0cPU0dPmqR4erXLz22Z%2Br%2FEqmG17cNuMM2n2RioYeLOhqAAXurgCh5hs3XZ3n42rAf5nUhbzmxvSEozjif16B9zOwNlEH5LvhHfJ95roMLxAAeOW95A0mhbPco%2Fas3aqZv3lWCrmYuU6sGoioo86ezXyDrFD44YdkxC%2BP0yAQ2xi7tErXAyqbfJ4y40b2a0blRmu%2FI4s3jcLyLnUSNx3f9bXjCIAA%3D\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AliyunUid\\": \\"20372822********\\\\n\\",\\n \\"AliyunParentUid\\": \\"16738266********\\",\\n \\"SessionId\\": \\"h8r********4fch\\",\\n \\"FileFrom\\": \\"Agent\\",\\n \\"FileCategory\\": \\"TextReport\\",\\n \\"GmtCreated\\": \\"2025-12-11T14:04:32.000+00:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取文件上传的列表', + ], + 'ListCustomAgent' => [ + 'summary' => 'ListCustomAgent 获取个人空间、工作空间中所有自定义Agent列表', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '56kv1pvl9uvt9**********bb', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持自定义Agent名称和描述模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '测试Agent', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义Agent状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NEW' => '新建-未发布', + 'RELEASED' => '已发布', + 'DRAFT' => '草稿-未发布', + 'OFFLINE' => '已下线', + ], + 'example' => 'RELEASED', + ], + ], + [ + 'name' => 'QueryAllReleased', + 'in' => 'query', + 'schema' => [ + 'description' => '查询所有已发布状态的自定义Agent，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，默认20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + 'Data' => [ + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '数据内容列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据内容对象', + 'type' => 'object', + 'properties' => [ + 'CustomAgentId' => [ + 'description' => '自定义Agent Id', + 'type' => 'string', + 'example' => 'ca-4y3ca4khkcu**********ysf', + ], + 'Name' => [ + 'description' => '自定义Agent名称', + 'type' => 'string', + 'example' => 'Agent测试名称', + ], + 'Description' => [ + 'description' => '自定义Agent描述', + 'type' => 'string', + 'example' => 'Agent测试描述', + ], + 'DataJson' => [ + 'description' => '指定的数据范围，JSON字符串格式', + 'type' => 'string', + 'example' => '{'."\n" + .' "tableFlag" : true,'."\n" + .' "scope" : "personal",'."\n" + .' "personal" : {'."\n" + .' "DataSourceType" : "remote_data_center",'."\n" + .' "FileId" : "f-5qlrwaw10********s3gpw1z",'."\n" + .' "Database" : "测试表格******.xlsx",'."\n" + .' "Tables" : [ "Sheet1" ],'."\n" + .' "TableIds" : [ "******" ],'."\n" + .' "RegionId" : "cn-hangzhou"'."\n" + .' }'."\n" + .'}', + ], + 'Instruction' => [ + 'description' => '指示', + 'type' => 'string', + 'example' => '分析框架：'."\n" + .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n" + .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n" + .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', + ], + 'Knowledge' => [ + 'description' => '知识', + 'type' => 'string', + 'example' => '核心指标定义：'."\n" + .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n" + .'2、订单量为每日有效下单笔数；'."\n" + .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n" + .'4、转化率=支付订单数 / UV，反映流量转化效率；', + ], + 'Status' => [ + 'description' => '自定义Agent状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'NEW' => '新建-未发布', + 'RELEASED' => '已发布', + 'DRAFT' => '草稿-未发布', + 'OFFLINE' => '已下线', + ], + 'example' => 'RELEASED', + ], + 'ReleaseTime' => [ + 'description' => '发布时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'OfflineTime' => [ + 'description' => '下线时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'Modifier' => [ + 'description' => '修改人', + 'type' => 'string', + 'example' => '20372822********', + ], + 'WorkspaceId' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'example' => '56kv1pvl9uvt9**********bb', + ], + 'Region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AliyunUid' => [ + 'description' => '阿里云账户ID', + 'type' => 'string', + 'example' => '20372822********', + ], + 'AliyunParentId' => [ + 'description' => '阿里主账户ID', + 'type' => 'string', + 'example' => '16738266********', + ], + 'DmsUnit' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreated' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'KnowledgeConfigList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'type' => 'string', + ], + 'McpServerId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ExecutionConfig' => [ + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => [ + 'description' => '是否跳过计划确认步骤', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SkipSqlConfirm' => [ + 'description' => '是否跳过所有SQL确认', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SkipWebReportConfirm' => [ + 'description' => '是否跳过绘制网页报告确认', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SkipAskHuman' => [ + 'description' => '是否禁止过程中用户询问', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'TextReportConfig' => [ + 'description' => '文字报告格式', + 'type' => 'string', + 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', + ], + 'WebReportConfig' => [ + 'description' => '网页报告格式', + 'type' => 'string', + 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', + ], + 'DefaultAgent' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreatorUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'HaoY*****', + ], + 'ModifierUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'HaoY*****', + ], + 'DMSUnit' => [ + 'title' => '当前DMS单元', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IsScheduleTask' => [ + 'type' => 'boolean', + ], + 'NextRuntime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ScheduleTaskConfig' => [ + 'title' => '周期任务配置', + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => [ + 'title' => '参考历史会话id', + 'type' => 'string', + ], + 'CronExpression' => [ + 'title' => '周期运行表达式', + 'type' => 'string', + ], + 'Query' => [ + 'title' => '周期运行的提问', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalElements' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalPages' => [ + 'description' => '分页总页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"CustomAgentId\\": \\"ca-4y3ca4khkcu**********ysf\\",\\n \\"Name\\": \\"Agent测试名称\\",\\n \\"Description\\": \\"Agent测试描述\\",\\n \\"DataJson\\": \\"{\\\\n \\\\\\"tableFlag\\\\\\" : true,\\\\n \\\\\\"scope\\\\\\" : \\\\\\"personal\\\\\\",\\\\n \\\\\\"personal\\\\\\" : {\\\\n \\\\\\"DataSourceType\\\\\\" : \\\\\\"remote_data_center\\\\\\",\\\\n \\\\\\"FileId\\\\\\" : \\\\\\"f-5qlrwaw10********s3gpw1z\\\\\\",\\\\n \\\\\\"Database\\\\\\" : \\\\\\"测试表格******.xlsx\\\\\\",\\\\n \\\\\\"Tables\\\\\\" : [ \\\\\\"Sheet1\\\\\\" ],\\\\n \\\\\\"TableIds\\\\\\" : [ \\\\\\"******\\\\\\" ],\\\\n \\\\\\"RegionId\\\\\\" : \\\\\\"cn-hangzhou\\\\\\"\\\\n }\\\\n}\\",\\n \\"Instruction\\": \\"分析框架：\\\\n1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；\\\\n2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；\\\\n3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；\\",\\n \\"Knowledge\\": \\"核心指标定义：\\\\n1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；\\\\n2、订单量为每日有效下单笔数；\\\\n3、UV（独立访客）指访问网站或APP的去重用户数；\\\\n4、转化率=支付订单数 / UV，反映流量转化效率；\\",\\n \\"Status\\": \\"RELEASED\\",\\n \\"ReleaseTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"OfflineTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"Modifier\\": \\"20372822********\\",\\n \\"WorkspaceId\\": \\"56kv1pvl9uvt9**********bb\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AliyunUid\\": \\"20372822********\\",\\n \\"AliyunParentId\\": \\"16738266********\\",\\n \\"DmsUnit\\": \\"cn-hangzhou\\",\\n \\"GmtCreated\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"GmtModified\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": false,\\n \\"SkipAskHuman\\": false\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalElements\\": 5,\\n \\"TotalPages\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取自定义Agent列表', + ], + 'DescribeCustomAgent' => [ + 'summary' => 'DescribeCustomAgent 根据自定义Agent ID获取详情描述信息', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => '56kv1pvl9uvt9**********bb', + ], + ], + [ + 'name' => 'CustomAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义Agent Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca-4y3ca4khkcu**********ysf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter Tid is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'CustomAgentId' => [ + 'description' => '自定义Agent Id', + 'type' => 'string', + 'example' => 'ca-4y3ca4khkcu**********ysf', + ], + 'Name' => [ + 'description' => '自定义Agent名称', + 'type' => 'string', + 'example' => 'Agent测试名称', + ], + 'Description' => [ + 'description' => '自定义Agent描述', + 'type' => 'string', + 'example' => 'Agent测试描述', + ], + 'DataJson' => [ + 'description' => '指定的数据范围，JSON字符串格式', + 'type' => 'string', + 'example' => '{'."\n" + .' "tableFlag" : true,'."\n" + .' "scope" : "personal",'."\n" + .' "personal" : {'."\n" + .' "DataSourceType" : "remote_data_center",'."\n" + .' "FileId" : "f-5qlrwaw10********s3gpw1z",'."\n" + .' "Database" : "测试表格******.xlsx",'."\n" + .' "Tables" : [ "Sheet1" ],'."\n" + .' "TableIds" : [ "******" ],'."\n" + .' "RegionId" : "cn-hangzhou"'."\n" + .' }'."\n" + .'}', + ], + 'Instruction' => [ + 'description' => '指示', + 'type' => 'string', + 'example' => '分析框架：'."\n" + .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n" + .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n" + .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', + ], + 'Knowledge' => [ + 'description' => '知识', + 'type' => 'string', + 'example' => '核心指标定义：'."\n" + .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n" + .'2、订单量为每日有效下单笔数；'."\n" + .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n" + .'4、转化率=支付订单数 / UV，反映流量转化效率；', + ], + 'Status' => [ + 'description' => '自定义Agent状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'NEW' => '新建-未发布', + 'RELEASED' => '已发布', + 'DRAFT' => '草稿-未发布', + 'OFFLINE' => '已下线', + ], + 'example' => 'RELEASED', + ], + 'ReleaseTime' => [ + 'description' => '发布时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'OfflineTime' => [ + 'description' => '下线时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'Modifier' => [ + 'description' => '修改人', + 'type' => 'string', + 'example' => '20372822********', + ], + 'WorkspaceId' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'example' => '56kv1pvl9uvt9**********bb', + ], + 'Region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AliyunUid' => [ + 'description' => '阿里云账户ID', + 'type' => 'string', + 'example' => '20372822********', + ], + 'AliyunParentUid' => [ + 'description' => '阿里云主账号ID', + 'type' => 'string', + 'example' => '16738266********', + ], + 'DmsUnit' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreated' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'KnowledgeConfigList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'type' => 'string', + ], + 'McpServerId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ExecutionConfig' => [ + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => [ + 'description' => '是否跳过计划确认步骤', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SkipSqlConfirm' => [ + 'description' => '是否跳过所有SQL确认', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SkipWebReportConfirm' => [ + 'description' => '是否跳过绘制网页报告确认', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SkipAskHuman' => [ + 'description' => '是否禁止过程中用户询问', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'TextReportConfig' => [ + 'description' => '文字报告格式', + 'type' => 'string', + 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', + ], + 'WebReportConfig' => [ + 'description' => '网页报告格式', + 'type' => 'string', + 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', + ], + 'DefaultAgent' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreatorUserName' => [ + 'description' => '创建者名称', + 'type' => 'string', + 'example' => 'HaoY*****', + ], + 'ModifierUserName' => [ + 'description' => '修改者名称', + 'type' => 'string', + 'example' => 'HaoY*****', + ], + 'DMSUnit' => [ + 'title' => '当前DMS单元', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IsScheduleTask' => [ + 'type' => 'boolean', + ], + 'NextRuntime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ScheduleTaskConfig' => [ + 'title' => '周期任务配置', + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => [ + 'title' => '参考的会话id', + 'type' => 'string', + ], + 'CronExpression' => [ + 'title' => '周期运行表达式', + 'type' => 'string', + ], + 'Query' => [ + 'title' => '周期运行的问题', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"CustomAgentId\\": \\"ca-4y3ca4khkcu**********ysf\\",\\n \\"Name\\": \\"Agent测试名称\\",\\n \\"Description\\": \\"Agent测试描述\\",\\n \\"DataJson\\": \\"{\\\\n \\\\\\"tableFlag\\\\\\" : true,\\\\n \\\\\\"scope\\\\\\" : \\\\\\"personal\\\\\\",\\\\n \\\\\\"personal\\\\\\" : {\\\\n \\\\\\"DataSourceType\\\\\\" : \\\\\\"remote_data_center\\\\\\",\\\\n \\\\\\"FileId\\\\\\" : \\\\\\"f-5qlrwaw10********s3gpw1z\\\\\\",\\\\n \\\\\\"Database\\\\\\" : \\\\\\"测试表格******.xlsx\\\\\\",\\\\n \\\\\\"Tables\\\\\\" : [ \\\\\\"Sheet1\\\\\\" ],\\\\n \\\\\\"TableIds\\\\\\" : [ \\\\\\"******\\\\\\" ],\\\\n \\\\\\"RegionId\\\\\\" : \\\\\\"cn-hangzhou\\\\\\"\\\\n }\\\\n}\\",\\n \\"Instruction\\": \\"分析框架：\\\\n1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；\\\\n2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；\\\\n3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；\\",\\n \\"Knowledge\\": \\"核心指标定义：\\\\n1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；\\\\n2、订单量为每日有效下单笔数；\\\\n3、UV（独立访客）指访问网站或APP的去重用户数；\\\\n4、转化率=支付订单数 / UV，反映流量转化效率；\\",\\n \\"Status\\": \\"RELEASED\\",\\n \\"ReleaseTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"OfflineTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"Modifier\\": \\"20372822********\\",\\n \\"WorkspaceId\\": \\"56kv1pvl9uvt9**********bb\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AliyunUid\\": \\"20372822********\\",\\n \\"AliyunParentUid\\": \\"16738266********\\",\\n \\"DmsUnit\\": \\"cn-hangzhou\\",\\n \\"GmtCreated\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"GmtModified\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": false,\\n \\"SkipAskHuman\\": false\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\"\\n }\\n}","type":"json"}]', + 'title' => '获取自定义Agent详细描述', + ], + 'UpdateDataAgentWorkspaceMemberRole' => [ + 'summary' => '调整空间成员的角色', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '12****', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要调整的成员账号uid', + 'type' => 'string', + 'required' => false, + 'example' => '20282*****7591', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要调整到的角色名称', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'description' => '已调整的成员账号uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'UserName' => [ + 'description' => '用户的RAM名称', + 'type' => 'string', + 'example' => 'yunqitest', + ], + 'RoleName' => [ + 'description' => '调整后的用户角色名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'JoinTime' => [ + 'description' => '用户加入空间的时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765961516'."\n", + ], + 'TotalTaskNumber' => [ + 'description' => '用户在空间中的总任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RunningTaskNumber' => [ + 'description' => '用户在空间中运行中的任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"MemberId\\": \\"20282*****7591\\",\\n \\"UserName\\": \\"yunqitest\\",\\n \\"RoleName\\": \\"admin\\",\\n \\"JoinTime\\": 1765961516,\\n \\"TotalTaskNumber\\": 20,\\n \\"RunningTaskNumber\\": 10\\n }\\n}","type":"json"}]', + 'title' => '调整空间成员的角色', + ], + 'ListDataAgentWorkspace' => [ + 'summary' => '获取主账号下的协作空间（分页）', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询空间类型', + 'type' => 'string', + 'required' => true, + 'example' => 'MY', + ], + ], + [ + 'name' => 'WorkspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'workspaceTest', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '开始页号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数（个）', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'no use', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '令牌（Token）信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'no use', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段名称', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页空间数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '总共页数（页）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Content' => [ + 'description' => '配置内容', + 'type' => 'array', + 'items' => [ + 'description' => '数据内容', + 'type' => 'object', + 'properties' => [ + 'Creator' => [ + 'description' => '空间创建者的uid', + 'type' => 'string', + 'example' => ' '."\n" + .'20282*****7591', + ], + 'ModifyTime' => [ + 'description' => '空间最近的修改时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765961516'."\n", + ], + 'CreateTime' => [ + 'description' => '空间的创建时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765960516'."\n", + ], + 'RoleName' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'Description' => [ + 'description' => '空间描述信息', + 'type' => 'string', + 'example' => 'space for test', + ], + 'WorkspaceName' => [ + 'description' => '空间的名称', + 'type' => 'string', + 'example' => 'workspaceTest', + ], + 'TotalMember' => [ + 'description' => '空间成员数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'WorkspaceStatus' => [ + 'description' => '空间的状态', + 'type' => 'string', + 'example' => 'active', + ], + 'WorkspaceId' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '20923*****7291', + ], + ], + ], + ], + 'TotalElements' => [ + 'description' => '总空间数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122', + ], + 'TotalPages' => [ + 'description' => '总页数（页）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'nu use', + ], + 'NextToken' => [ + 'description' => '令牌（Token）信息', + 'type' => 'string', + 'example' => 'no use', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 12,\\n \\"Content\\": [\\n {\\n \\"Creator\\": \\"\\\\t\\\\n20282*****7591\\",\\n \\"ModifyTime\\": 1765961516,\\n \\"CreateTime\\": 1765960516,\\n \\"RoleName\\": \\"admin\\",\\n \\"Description\\": \\"space for test\\",\\n \\"WorkspaceName\\": \\"workspaceTest\\",\\n \\"TotalMember\\": 11,\\n \\"WorkspaceStatus\\": \\"active\\",\\n \\"WorkspaceId\\": \\"20923*****7291\\"\\n }\\n ],\\n \\"TotalElements\\": 122,\\n \\"TotalPages\\": 12\\n },\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"no use\\"\\n}","type":"json"}]', + 'title' => '获取主账号下的协作空间', + ], + 'AddUserToDataAgentWorkspace' => [ + 'summary' => '将用户添加到指定的工作空间中', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的阿里云uid', + 'type' => 'string', + 'required' => false, + 'example' => '20282*****7591', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '67E910F2-***-695C', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'description' => '用户的阿里云uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'UserName' => [ + 'description' => '用户RAM名称', + 'type' => 'string', + 'example' => 'agentTest', + ], + 'RoleName' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'JoinTime' => [ + 'description' => '用户加入空间的时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765960516', + ], + 'RunningTaskNumber' => [ + 'description' => '用户在空间中正在运行的任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalTaskNumber' => [ + 'description' => '用户在空间中发起的总任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-***-695C\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"MemberId\\": \\"20282*****7591\\",\\n \\"UserName\\": \\"agentTest\\",\\n \\"RoleName\\": \\"admin\\",\\n \\"JoinTime\\": 1765960516,\\n \\"RunningTaskNumber\\": 2,\\n \\"TotalTaskNumber\\": 5\\n }\\n}","type":"json"}]', + 'title' => '为协作空间添加成员', + ], + 'UpdateDataAgentSpaceInfo' => [ + 'summary' => '更新空间的信息', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291', + ], + ], + [ + 'name' => 'WorkspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '空间的新名称', + 'type' => 'string', + 'required' => false, + 'example' => 'yunqitest_v2', + ], + ], + [ + 'name' => 'WorkspaceDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '空间的新描述', + 'type' => 'string', + 'required' => false, + 'example' => 'space for test new', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '67E910F2-***-695C', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码，请求异常时返回', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '20923*****7291', + ], + 'WorkspaceName' => [ + 'description' => '空间信息更新后的名称', + 'type' => 'string', + 'example' => 'yunqitest_v2', + ], + 'WorkspaceStatus' => [ + 'description' => '空间信息更新后的状态', + 'type' => 'string', + 'example' => 'space for test new', + ], + 'Creator' => [ + 'description' => '空间创建者的uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'RoleName' => [ + 'description' => '移除的用户角色名称', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'description' => '会话的创建时间（时间戳/秒）', + 'type' => 'string', + 'example' => '1765960516', + ], + 'ModifyTime' => [ + 'description' => '空间最后一次修改的时间（时间戳/秒）', + 'type' => 'string', + 'example' => '1765962516', + ], + 'Description' => [ + 'description' => '表的描述信息', + 'type' => 'string', + 'example' => 'space for test new', + ], + 'TotalMember' => [ + 'description' => '空间的成员总数（个）', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-***-695C\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": \\"20923*****7291\\",\\n \\"WorkspaceName\\": \\"yunqitest_v2\\",\\n \\"WorkspaceStatus\\": \\"space for test new\\",\\n \\"Creator\\": \\"20282*****7591\\",\\n \\"RoleName\\": \\"active\\",\\n \\"CreateTime\\": \\"1765960516\\",\\n \\"ModifyTime\\": \\"1765962516\\",\\n \\"Description\\": \\"space for test new\\",\\n \\"TotalMember\\": \\"20\\"\\n }\\n}","type":"json"}]', + 'title' => '更新空间的信息', + ], + 'CreateDataAgentWorkspace' => [ + 'summary' => '创建DataAgent协作空间', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'workspaceTest', + ], + ], + [ + 'name' => 'WorkspaceDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间描述', + 'type' => 'string', + 'required' => false, + 'example' => 'Space for test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '20923*****7291', + ], + 'WorkspaceName' => [ + 'description' => '空间的名称', + 'type' => 'string', + 'example' => 'workspaceTest', + ], + 'WorkspaceStatus' => [ + 'description' => '空间的状态', + 'type' => 'string', + 'example' => 'active', + ], + 'TotalMember' => [ + 'description' => '空间成员数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'Creator' => [ + 'description' => '空间创建者的uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'CreateTime' => [ + 'description' => '空间的创建时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765960516', + ], + 'ModifyTime' => [ + 'description' => '空间最近的修改时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765961516', + ], + 'WorkspaceDesc' => [ + 'description' => '空间描述信息', + 'type' => 'string', + 'example' => 'space for test', + ], + 'RoleName' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'example' => 'owner', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": \\"20923*****7291\\",\\n \\"WorkspaceName\\": \\"workspaceTest\\",\\n \\"WorkspaceStatus\\": \\"active\\",\\n \\"TotalMember\\": 11,\\n \\"Creator\\": \\"20282*****7591\\",\\n \\"CreateTime\\": 1765960516,\\n \\"ModifyTime\\": 1765961516,\\n \\"WorkspaceDesc\\": \\"space for test\\",\\n \\"RoleName\\": \\"owner\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\"\\n}","type":"json"}]', + 'title' => '创建协作空间', + ], + 'ListDataAgentWorkspaceMember' => [ + 'summary' => '获取空间所有成员', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291', + ], + ], + [ + 'name' => 'SearchMemberId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于查询的成员ID前缀', + 'type' => 'string', + 'required' => false, + 'example' => '20273', + ], + ], + [ + 'name' => 'SearchRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '用于查询的成员名称前缀', + 'type' => 'string', + 'required' => false, + 'example' => 'yunqi', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页空间数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小（个）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '令牌（Token）信息', + 'type' => 'string', + 'required' => false, + 'example' => 'NesLoK****', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '升序/降序', + 'type' => 'string', + 'required' => false, + 'example' => 'Desc', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序依据', + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6'."\n", + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页空间数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '总共页数（页）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Content' => [ + 'description' => '数据内容', + 'type' => 'array', + 'items' => [ + 'description' => '空间成员信息列表', + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'description' => '用户的阿里云uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'UserName' => [ + 'description' => '用户的RAM名称', + 'type' => 'string', + 'example' => 'yunqitest', + ], + 'JoinTime' => [ + 'description' => '用户加入空间的时间（时间戳/秒）', + 'type' => 'string', + 'example' => '1765961516', + ], + 'TotalTaskNumber' => [ + 'description' => '用户在空间中发起的总任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RoleName' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'example' => 'member', + ], + 'RunningTaskNumber' => [ + 'description' => '用户在空间中正在运行的任务数量（个）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页大小（个）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）', + 'type' => 'string', + 'example' => 'no use', + ], + 'TotalElements' => [ + 'description' => '总元素数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'no use', + ], + 'TotalPages' => [ + 'description' => '总页数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'no use', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"Content\\": [\\n {\\n \\"MemberId\\": \\"20282*****7591\\",\\n \\"UserName\\": \\"yunqitest\\",\\n \\"JoinTime\\": \\"1765961516\\",\\n \\"TotalTaskNumber\\": 30,\\n \\"RoleName\\": \\"member\\",\\n \\"RunningTaskNumber\\": 15\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"no use\\",\\n \\"TotalElements\\": 0,\\n \\"TotalPages\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取工作空间的成员信息', + ], + 'DeleteDataAgentWorkspace' => [ + 'summary' => '删除DataAgent协作空间', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\"\\n}","type":"json"}]', + 'title' => '删除协作空间', + ], + 'RemoveUserToDataAgentWorkspace' => [ + 'summary' => '从空间中移除用户', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291'."\n", + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'description' => '要移除的成员账号uid', + 'type' => 'string', + 'required' => false, + 'example' => '21482*****7584', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\"\\n}","type":"json"}]', + 'title' => '从空间中移除用户', + ], + 'GetDataAgentSubAccountInfo' => [ + 'summary' => '获取主账号下的子账号信息', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou'."\n", + ], + ], + [ + 'name' => 'SubAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号的阿里云uid', + 'type' => 'string', + 'required' => false, + 'example' => '20282*****7591', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '67E910F2-***-695C', + ], + 'Success' => [ + 'description' => '返回值说明', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '查询到的用户RAM名称', + 'type' => 'string', + 'example' => 'yunqitest', + ], + 'UserId' => [ + 'description' => '需查询的子账号uid', + 'type' => 'string', + 'example' => '20282*****7591'."\n", + ], + 'CreateDate' => [ + 'description' => '用户在RAM创建的时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765960516', + ], + 'UpdateDate' => [ + 'description' => '用户信息更新时间（时间戳/秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765962516', + ], + 'MainAccountId' => [ + 'description' => '用户所在的主账号ID', + 'type' => 'string', + 'example' => '167*****166', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-***-695C\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"Data\\": {\\n \\"UserName\\": \\"yunqitest\\",\\n \\"UserId\\": \\"20282*****7591\\\\n\\",\\n \\"CreateDate\\": 1765960516,\\n \\"UpdateDate\\": 1765962516,\\n \\"MainAccountId\\": \\"167*****166\\"\\n }\\n}","type":"json"}]', + 'title' => '获取主账号下的子账号信息', + ], + 'GetDataAgentWorkspaceInfo' => [ + 'summary' => '获取协作空间详细信息', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdmsKIHNZQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前DMS单元', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'required' => false, + 'example' => '20923*****7291', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E0D2-*****-A63B6', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'DMS-DA-40114', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Specified parameter is not valid.', + ], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => '协作空间ID', + 'type' => 'string', + 'example' => '20923*****7291', + ], + 'WorkspaceName' => [ + 'description' => '空间的名称', + 'type' => 'string', + 'example' => 'workspaceTest', + ], + 'WorkspaceStatus' => [ + 'description' => '空间的状态', + 'type' => 'string', + 'example' => 'active', + ], + 'Creator' => [ + 'description' => '空间创建者的uid', + 'type' => 'string', + 'example' => '20282*****7591', + ], + 'RoleName' => [ + 'description' => '用户在空间中的角色名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'CreateTime' => [ + 'description' => '会话的创建时间（时间戳/秒）', + 'type' => 'string', + 'example' => '1765960516', + ], + 'ModifyTime' => [ + 'description' => '空间最近的修改时间（时间戳/秒）', + 'type' => 'string', + 'example' => '1765961516', + ], + 'WorkspaceDesc' => [ + 'description' => '协作空间描述', + 'type' => 'string', + 'example' => 'space for test', + ], + 'TotalMember' => [ + 'description' => '空间成员数量（个）', + 'type' => 'string', + 'example' => '11', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D2-*****-A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": \\"20923*****7291\\",\\n \\"WorkspaceName\\": \\"workspaceTest\\",\\n \\"WorkspaceStatus\\": \\"active\\",\\n \\"Creator\\": \\"20282*****7591\\",\\n \\"RoleName\\": \\"admin\\",\\n \\"CreateTime\\": \\"1765960516\\",\\n \\"ModifyTime\\": \\"1765961516\\",\\n \\"WorkspaceDesc\\": \\"space for test\\",\\n \\"TotalMember\\": \\"11\\"\\n }\\n}","type":"json"}]', + 'title' => '获取协作空间详细信息', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'dms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dms.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'dms.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dms.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dms.ap-southeast-1.aliyuncs.com', + ], + ], +]; |