diff options
Diffstat (limited to 'data/zh_cn/dms/2025-04-14')
| -rw-r--r-- | data/zh_cn/dms/2025-04-14/api-docs.php | 18212 |
1 files changed, 10077 insertions, 8135 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 index 5afa6ec..c17793a 100644 --- a/data/zh_cn/dms/2025-04-14/api-docs.php +++ b/data/zh_cn/dms/2025-04-14/api-docs.php @@ -1,1309 +1,1066 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Dms', - 'version' => '2025-04-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'dms', 'version' => '2025-04-14'], 'directories' => [ [ - 'id' => 320232, - 'title' => 'Airflow', + 'children' => ['CreateAirflowLoginToken', 'CreateAirflow', 'UpdateAirflow', 'GetAirflow', 'ListAirflows', 'DeleteAirflow'], 'type' => 'directory', - 'children' => [ - 'CreateAirflowLoginToken', - 'CreateAirflow', - 'UpdateAirflow', - 'UpdateAirflow', - 'GetAirflow', - 'ListAirflows', - 'DeleteAirflow', - ], + 'title' => 'Airflow', + 'id' => 143433, ], [ - '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', + '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', - ], + 'title' => '数据湖 库表', + 'id' => 235543, ], [ - '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', + 'GetNotebookAndSubmitTask', 'GetNotebookTaskStatus', 'AddUserToDataAgentWorkspace', 'ConfigAirflow', 'CreateCustomAgent', 'CreateDataAgentAccuracyTest', 'CreateDataAgentKnowledgeBase', 'CreateDataAgentSession', 'CreateDataAgentWorkspace', 'DeleteCustomAgent', 'DeleteDataAgentAccuracyTest', 'DeleteDataAgentKnowledgeBase', 'DeleteDataAgentWorkspace', 'DeleteDocument', 'DeleteDocumentChunks', 'DeleteFileUpload', 'DeleteWorkspaceCode', 'DescribeCustomAgent', 'DescribeDataAgentSession', 'DescribeDocument', + 'DescribeFileUploadSignature', 'DescribeKnowledgeBaseStats', 'DescribeKnowledgeBaseUploadSignature', 'FileUploadCallback', 'GetChatContent', 'GetDataAgentSubAccountInfo', 'GetDataAgentWorkspaceInfo', 'GetSqlConsoleOperationLog', 'GetWorkspaceCode', 'GetWorkspaceCodePublishSetting', 'GetWorkspaceQuota', 'ListAirflowVersions', 'ListCustomAgent', 'ListDataAgentAccuracyTestInstances', 'ListDataAgentAccuracyTestResults', 'ListDataAgentAccuracyTestTasks', 'ListDataAgentSession', 'ListDataAgentWorkspace', 'ListDataAgentWorkspaceMember', 'ListDataCenterDatabase', + 'ListDataCenterTable', 'ListDocumentChunks', 'ListDocuments', 'ListFileUpload', 'ListKnowledgeBases', 'ListWorkspaceCode', 'ModifyCustomAgent', 'OperateCustomAgent', 'RedeployAirflow', 'RemoveUserToDataAgentWorkspace', 'RetrieveKnowledgeBase', 'SaveWorkspaceCode', 'SendChatMessage', 'SetWorkspaceCodePublishSetting', 'SetWorkspaceQuota', 'StartDataAgentAccuracyTestTask', 'StopDataAgentAccuracyTestTask', 'UpdateDataAgentAccuracyTest', 'UpdateDataAgentSpaceInfo', 'UpdateDataAgentWorkspaceMemberRole', + 'UpdateDocument', 'UpdateKnowledgeBase', 'UploadDocument', 'UpsertDocumentChunks', 'WorkspaceActionLog', 'WorkspaceActionStatus', 'WorkspaceCodePublish', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 235574, ], ], 'components' => [ 'schemas' => [ - 'DLCatalog' => [ - 'title' => 'Catalog', - 'description' => '数据目录详情。', + 'AgenticCatalog' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Description', - 'description' => '数据目录描述。', - 'type' => 'string', - 'example' => 'init default catalog', + 'CatalogUuid' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'CatalogType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'DbType' => ['type' => 'string'], + 'DataSourceUuid' => ['type' => 'string'], + 'StorageLocation' => ['type' => 'string'], + 'State' => ['type' => 'integer', 'format' => 'int32'], + 'RegionId' => ['type' => 'string'], + 'Properties' => ['type' => 'object'], + 'CatalogBizAttrs' => ['type' => 'object'], + ], + ], + 'AgenticDatabase' => [ + 'type' => 'object', + 'properties' => [ + 'CatalogUuid' => ['type' => 'string'], + 'CatalogName' => ['type' => 'string'], + 'CatalogType' => ['type' => 'string'], + 'DbType' => ['type' => 'string'], + 'DatabaseUuid' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'QualifiedName' => ['type' => 'string'], + 'SearchName' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'EngineMeta' => ['$ref' => '#/components/schemas/AgenticDatabaseEngineMeta'], + 'StorageLocation' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'State' => ['type' => 'integer', 'format' => 'int32'], + 'Properties' => ['type' => 'object'], + 'DatabaseBizAttrs' => ['type' => 'object'], + ], + ], + 'AgenticDatabaseEngineMeta' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['type' => 'string'], + 'CatalogName' => ['type' => 'string'], + 'Encoding' => ['type' => 'string'], + 'StorageCapacity' => ['type' => 'integer', 'format' => 'int64'], + ], + ], + 'AgenticDatabaseObject' => [ + 'type' => 'object', + 'properties' => [ + 'DatabaseUuid' => ['type' => 'string'], + 'DatabaseQualifiedName' => ['type' => 'string'], + 'ObjectName' => ['type' => 'string'], + 'ObjectType' => ['type' => 'string'], + 'ObjectQualifiedName' => ['type' => 'string'], + 'DdlSql' => ['type' => 'string'], + ], + ], + 'AgenticDmsInstanceSyncTask' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'string'], + 'Status' => ['type' => 'string'], + 'SyncUserDataPermission' => ['type' => 'boolean'], + 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], + 'SuccessCount' => ['type' => 'integer', 'format' => 'int32'], + 'FailedCount' => ['type' => 'integer', 'format' => 'int32'], + 'SkippedCount' => ['type' => 'integer', 'format' => 'int32'], + 'ErrorCode' => ['type' => 'string'], + 'ErrorSummary' => ['type' => 'string'], + 'ActorId' => ['type' => 'string'], + 'ActorType' => ['type' => 'string'], + 'ActorName' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'GmtModified' => ['type' => 'string'], + ], + ], + 'AgenticDmsInstanceSyncTaskInstance' => [ + 'type' => 'object', + 'properties' => [ + 'DmsInstanceId' => ['type' => 'string'], + 'Status' => ['type' => 'string'], + 'Phase' => ['type' => 'string'], + 'DatasourceUuid' => ['type' => 'string'], + 'CatalogUuid' => ['type' => 'string'], + 'DmsRegionId' => ['type' => 'string'], + 'DbType' => ['type' => 'string'], + 'DmsInstanceSummary' => [ + 'type' => 'object', + 'properties' => [ + 'Host' => ['type' => 'string'], + 'Port' => ['type' => 'integer', 'format' => 'int32'], + 'Alias' => ['type' => 'string'], + 'DbType' => ['type' => 'string'], + 'EnvType' => ['type' => 'string'], + 'InstanceResourceId' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'InstanceSource' => ['type' => 'string'], + ], ], - 'Name' => [ - 'title' => 'Name', - 'description' => '数据目录名称。', - 'type' => 'string', - 'example' => 'hive', + 'CrawlerTaskId' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'string'], + 'ErrorSummary' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'GmtModified' => ['type' => 'string'], + ], + ], + 'AgenticTableBaseInfo' => [ + 'type' => 'object', + 'properties' => [ + 'CatalogType' => ['type' => 'string'], + 'DatabaseUuid' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'QualifiedName' => ['type' => 'string'], + 'TableType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'EngineMeta' => ['$ref' => '#/components/schemas/AgenticTableEngineMeta'], + ], + ], + 'AgenticTableColumn' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['type' => 'string'], + 'ColumnType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'Position' => ['type' => 'integer', 'format' => 'int32'], + 'EngineMeta' => ['$ref' => '#/components/schemas/AgenticTableColumnEngineMeta'], + ], + ], + 'AgenticTableColumnEngineMeta' => [ + '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'], + ], + ], + 'AgenticTableEngineMeta' => [ + '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'], + 'Checksum' => ['type' => 'string'], + 'FullChecksum' => ['type' => 'string'], + 'RefInfo' => ['type' => 'string'], + ], + ], + 'AgenticTableIndex' => [ + 'type' => 'object', + 'properties' => [ + 'IndexName' => ['type' => 'string'], + 'IndexType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'ColumnNames' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'Location' => [ - 'title' => 'Location', - 'description' => '数据目录存储路径。', - 'type' => 'string', - 'example' => 'oss://xxxx', + 'Primary' => ['type' => 'boolean'], + 'Unique' => ['type' => 'boolean'], + 'RealColumnNames' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], + 'AgentServiceOrderSummaryVO' => [ + 'type' => 'object', + 'properties' => [ + 'AgentService' => ['type' => 'string'], + 'OrderCount' => ['type' => 'integer', 'format' => 'int32'], + 'ServiceNumTotal' => ['type' => 'integer', 'format' => 'int32'], + 'ModelCallQuota' => ['type' => 'integer', 'format' => 'int64'], + 'SkillPlanCallQuota' => ['type' => 'integer', 'format' => 'int64'], + 'DeepResearchQuota' => ['type' => 'integer', 'format' => 'int64'], + ], + ], + 'AgentServiceOrderVO' => [ + 'type' => 'object', + 'properties' => [ + 'OrderInstanceId' => ['type' => 'string'], + 'AgentService' => ['type' => 'string'], + 'ServiceNum' => ['type' => 'integer', 'format' => 'int32'], + 'Status' => ['type' => 'string'], + 'ExpireTime' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'GmtModified' => ['type' => 'string'], + 'ModelCallUsed' => ['type' => 'integer', 'format' => 'int32'], + 'ModelCallQuota' => ['type' => 'integer', 'format' => 'int32'], + 'SkillPlanCallUsed' => ['type' => 'integer', 'format' => 'int32'], + 'SkillPlanCallQuota' => ['type' => 'integer', 'format' => 'int32'], + 'DeepResearchUsed' => ['type' => 'integer', 'format' => 'int32'], + 'DeepResearchQuota' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'DataAgentBillingInstance' => [ + 'type' => 'object', + 'properties' => [ + 'BillingInstanceId' => ['type' => 'string'], + 'PayLevel' => ['type' => 'string'], + 'AgentSeats' => ['type' => 'integer', 'format' => 'int32'], + 'FreeAgentSeats' => ['type' => 'integer', 'format' => 'int32'], + 'SessionSeats' => ['type' => 'integer', 'format' => 'int32'], + 'SessionAvailableDurationQuota' => ['type' => 'integer', 'format' => 'int32'], + 'LLM' => ['type' => 'integer', 'format' => 'int32'], + 'FreeLLM' => ['type' => 'integer', 'format' => 'int32'], + 'TokenLimit' => ['type' => 'integer', 'format' => 'int32'], + 'ChargeType' => ['type' => 'string'], + 'CommodityCode' => ['type' => 'string'], + 'ExpireTime' => ['type' => 'integer', 'format' => 'int64'], + 'IsDefault' => ['type' => 'boolean'], + 'GmtCreated' => ['type' => 'integer', 'format' => 'int64'], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64'], + 'BoundWorkspaceIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'DataMountInfo' => [ + 'description' => 'Airflow数据挂载配置', + 'type' => 'object', + 'properties' => [ + 'OssBucket' => ['description' => 'OSS的Bucket。', 'type' => 'string', 'example' => 'test-bucket'], + 'Prefix' => ['description' => '路径前缀。默认查询根目录。', 'type' => 'string', 'example' => '/prod'], + 'MountFolderName' => ['description' => '数据挂载的目录，实际挂载目录会添加前缀/Workspace/data/', 'type' => 'string', 'example' => 'image'], + 'ReadOnly' => ['description' => '数据卷是否只读。'."\n" + ."\n" + .'默认值：false。', 'type' => 'boolean', 'example' => 'false'], + ], + 'required' => false, + ], + 'DLCatalog' => [ + 'title' => 'Catalog', + 'description' => '数据目录详情。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => 'Description', 'description' => '数据目录描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'init default catalog', 'backendName' => 'description'], + 'Name' => ['title' => 'Name', 'description' => '数据目录名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'name'], + 'Location' => ['title' => 'Location', 'description' => '数据目录存储路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxxx', 'backendName' => 'location'], + ], + ], 'DLColumn' => [ 'title' => 'Column', 'description' => '列属性。', + 'visibility' => 'Public', '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', - ], + 'Comment' => ['title' => 'comment', 'description' => '列的注释。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'from deserializer', 'backendName' => 'comment'], + 'Type' => ['title' => 'type', 'description' => '列的数据类型，包括 array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'string', 'backendName' => 'type'], + 'Name' => ['title' => 'name', 'description' => '列的名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'col', 'backendName' => 'name'], ], ], 'DLDatabase' => [ 'title' => 'Database', 'description' => '湖仓数据库详情。', + 'visibility' => 'Public', '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', - ], + 'Description' => ['title' => 'description', 'description' => '数据库描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Default database for catalog hive'."\n", 'backendName' => 'description'], + 'Parameters' => ['description' => '数据库相关参数。', 'visibility' => 'Public', 'type' => 'object', 'example' => 'key/value', 'backendName' => 'parameters'], + 'DbId' => ['title' => 'dbId', 'description' => '数据库 ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'backendName' => 'dbId'], + 'CatalogName' => ['title' => 'catalogName', 'description' => '数据目录名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'catalogName'], + 'Name' => ['title' => 'name', 'description' => '数据库名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'name'], + 'Location' => ['title' => 'location', 'description' => '数据库存储路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxx', 'backendName' => 'location'], ], ], 'DLFunction' => [ 'description' => '函数信息', + 'visibility' => 'Public', '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', - ], + 'FunctionName' => ['description' => '函数名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my_funciton', 'backendName' => 'functionName'], + 'OwnerName' => ['description' => '函数所有者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan', 'backendName' => 'ownerName'], + 'OwnerType' => ['description' => '所有者类型，枚举值：'."\n" + ."\n" + .'- ROLE'."\n" + .'- GROUP'."\n" + .'- USER', 'visibility' => 'Public', 'type' => 'string', 'example' => 'USER', 'backendName' => 'ownerType'], + 'CreatorId' => ['description' => '创建该函数的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', 'backendName' => 'creatorId'], + 'FunctionType' => ['description' => '函数类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'JAVA', 'backendName' => 'functionType'], + 'CreateTime' => ['description' => '函数的创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1731586286', 'backendName' => 'createTime'], 'ResourceUris' => [ 'description' => '该函数的资源URIs，函数创建后不支持修改。', + 'visibility' => 'Public', '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****', + 'items' => ['description' => '访问该资源的URI。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLResourceUri'], + 'backendName' => 'resourceUris', ], + 'ClassName' => ['description' => '包含函数代码的Java类。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'com.example.hive.MyCustomUDF', 'backendName' => 'className'], + 'CatalogName' => ['description' => '数据目录名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'catalogName'], + 'DbName' => ['description' => '数据库名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'dbName'], + 'ModifierId' => ['description' => '修改该函数的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '26****', 'backendName' => 'modifierId'], ], ], 'DLFunctionInput' => [ 'description' => '函数信息', + 'visibility' => 'Public', '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', - ], + 'FunctionName' => ['description' => '函数名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my_funciton', 'backendName' => 'functionName'], + 'OwnerName' => ['description' => '函数所有者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan', 'backendName' => 'ownerName'], + 'OwnerType' => ['description' => '所有者类型，枚举值：'."\n" + ."\n" + .'- ROLE'."\n" + .'- GROUP'."\n" + .'- USER', 'visibility' => 'Public', 'type' => 'string', 'example' => 'USER', 'backendName' => 'ownerType'], + 'CreatorId' => ['description' => '创建该函数的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', 'backendName' => 'creatorId'], + 'FunctionType' => ['description' => '函数类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'JAVA', 'backendName' => 'functionType'], + 'CreateTime' => ['description' => '函数的创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1731586286', 'backendName' => 'createTime'], 'ResourceUris' => [ 'description' => '该函数的资源URIs，函数创建后不支持修改。', + 'visibility' => 'Public', '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****', + 'items' => ['description' => '访问该资源的URI。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLResourceUri'], + 'backendName' => 'resourceUris', ], + 'ClassName' => ['description' => '包含函数代码的Java类。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'com.example.hive.MyCustomUDF', 'backendName' => 'className'], + 'ModifierId' => ['description' => '修改该函数的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '26****', 'backendName' => 'modifierId'], ], ], 'DLOrder' => [ 'title' => 'Order', 'description' => '列排序信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Order' => [ - 'title' => 'order', - 'description' => '该列在排序中的位置。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Col' => [ - 'title' => 'col', - 'description' => '列的名称。', - 'type' => 'string', - 'example' => 'col1', - ], + 'Order' => ['title' => 'order', 'description' => '该列在排序中的位置。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'order'], + 'Col' => ['title' => 'col', 'description' => '列的名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'col1', 'backendName' => 'col'], ], ], 'DLPartition' => [ 'description' => '分区信息', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'table_name', - ], - 'Sd' => [ - 'description' => '数据存储描述。', - '$ref' => '#/components/schemas/DLStorageDescriptor', - ], + 'TableName' => ['description' => '表名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'table_name', 'backendName' => 'tableName'], + 'Sd' => ['description' => '数据存储描述。', 'visibility' => 'Public', 'backendName' => 'sd', '$ref' => '#/components/schemas/DLStorageDescriptor'], 'Parameters' => [ 'description' => '分区的键值对。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '键值对，key及value。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - ], - 'CreateTime' => [ - 'description' => '分区的创建时间，时间格式为UNIX时间戳秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1735109884', + 'additionalProperties' => ['description' => '键值对，key及value。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"key":"value"}'], + 'backendName' => 'parameters', ], + 'CreateTime' => ['description' => '分区的创建时间，时间格式为UNIX时间戳秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1735109884', 'backendName' => 'createTime'], 'Values' => [ 'description' => '分区值。', + 'visibility' => 'Public', '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', + 'items' => ['description' => '分区列的值。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'part_val1', 'extendType' => 'true'], + 'backendName' => 'values', ], + 'CatalogName' => ['description' => '数据目录名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'catalogName'], + 'DbName' => ['description' => '数据库名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'dbName'], + 'LastAccessTime' => ['description' => '上次访问该表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'backendName' => 'lastAccessTime'], ], ], 'DLPartitionInput' => [ 'description' => '湖仓表分区信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Parameters' => [ 'description' => '分区的键值对参数', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '键值对 key/value', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - ], - 'CreateTime' => [ - 'description' => '创建时间，Unix 时间戳秒数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1735109884', + 'additionalProperties' => ['description' => '键值对 key/value', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"key":"value"}'], + 'backendName' => 'parameters', ], + 'CreateTime' => ['description' => '创建时间，Unix 时间戳秒数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1735109884', 'backendName' => 'createTime'], 'Values' => [ 'description' => '分区值', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '分区列的值', - 'type' => 'string', - 'example' => 'part_val1', - ], - ], - 'StorageDescriptor' => [ - 'description' => '湖仓表数据存储信息', - '$ref' => '#/components/schemas/DLStorageDescriptor', - ], - 'LastAccessTime' => [ - 'description' => '上一次访问分区的时间，Unix 时间戳秒数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1735109884', + 'items' => ['description' => '分区列的值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'part_val1', 'extendType' => 'true'], + 'backendName' => 'values', ], + 'StorageDescriptor' => ['description' => '湖仓表数据存储信息', 'visibility' => 'Public', 'backendName' => 'sd', '$ref' => '#/components/schemas/DLStorageDescriptor'], + 'LastAccessTime' => ['description' => '上一次访问分区的时间，Unix 时间戳秒数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1735109884', 'backendName' => 'lastAccessTime'], ], ], 'DLResourceUri' => [ 'description' => '资源信息。', + 'visibility' => 'Public', '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', - ], + 'ResourceType' => ['description' => '资源类型。枚举值：'."\n" + .'- ARCHIVE'."\n" + .'- JAR'."\n" + .'- FILE', 'visibility' => 'Public', 'type' => 'string', 'example' => 'JAR', 'backendName' => 'resourceType'], + 'Uri' => ['description' => '访问该资源的URL。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar', 'backendName' => 'uri'], ], ], 'DLSerdeInfo' => [ 'title' => 'SerdeInfo', 'description' => '序列化和反序列化信息。', + 'visibility' => 'Public', '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', - ], + 'SerializationLib' => ['title' => 'serializationLib', 'description' => '使用的序列化库的类名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', 'backendName' => 'serializationLib'], + 'DeserializerClass' => ['title' => 'deserializerClass', 'description' => '用于反序列化的具体类名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde', 'backendName' => 'deserializerClass'], + 'Parameters' => ['title' => 'parameters', 'description' => '序列化相关的参数键值对。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{'."\n" + .' "serialization.format": "1"'."\n" + .'}', 'backendName' => 'parameters'], + 'Description' => ['title' => 'description', 'description' => '描述序列化的信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '"serialize"', 'backendName' => 'description'], + 'SerdeType' => ['description' => '序列化的类型。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'backendName' => 'serdeType'], + 'SerializerClass' => ['title' => 'serializerClass', 'description' => '用于序列化的具体类名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', 'backendName' => 'serializerClass'], + 'Name' => ['title' => 'name', 'description' => '序列化名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'name', 'backendName' => 'name'], ], ], 'DLSkewedInfo' => [ 'title' => 'SkewedInfo', 'description' => '存储倾斜列信息的数据结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'SkewedColValues' => [ 'title' => 'skewedColValues', 'description' => '倾斜列值的列表，其中每个列表提供了一组相关联的值。', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => '倾斜值列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '倾斜值。', - 'type' => 'string', - 'example' => '"123"', - ], + 'items' => ['description' => '倾斜值。', 'visibility' => 'Public', 'type' => 'string', 'example' => '"123"', 'extendType' => 'true'], + 'itemName' => 'SkewedColValue', + 'extendType' => 'true', ], + 'backendName' => 'skewedColValues', + 'itemName' => 'SkewedColValue', ], - 'SkewedColValueLocationMaps' => [ - 'title' => 'skewedColValueLocationMaps', - 'description' => '倾斜列值及其位置的映射关系。', - 'type' => 'object', - 'example' => '{“col1”:"val1"}', - ], + 'SkewedColValueLocationMaps' => ['title' => 'skewedColValueLocationMaps', 'description' => '倾斜列值及其位置的映射关系。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{“col1”:"val1"}', 'backendName' => 'skewedColValueLocationMaps'], 'SkewedColNames' => [ 'title' => 'skewedColNames', 'description' => '倾斜列的名称列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '倾斜字段。', - 'type' => 'string', - 'example' => 'col1', - ], + 'items' => ['description' => '倾斜字段。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'col1', 'extendType' => 'true'], + 'backendName' => 'skewedColNames', + 'itemName' => 'SkewedColName', ], ], ], 'DLStorageDescriptor' => [ 'title' => 'StorageDescriptor', 'description' => '湖仓表数据存储信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'OriginalColumns' => [ 'title' => 'originalColumns', 'description' => '原始列描述信息。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '列属性。', - '$ref' => '#/components/schemas/DLColumn', - ], + 'items' => ['description' => '列属性。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn'], + 'backendName' => 'originalColumns', + 'itemName' => 'OriginalColumn', ], 'SortCols' => [ 'title' => 'sortCols', 'description' => '排序列的描述信息。', + 'visibility' => 'Public', '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', - ], + 'items' => ['description' => '列排序信息。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLOrder'], + 'backendName' => 'sortCols', + 'itemName' => 'SortCol', + ], + 'Parameters' => ['title' => 'parameters', 'description' => '数据存储的其他参数映射。', 'visibility' => 'Public', 'type' => 'object', 'example' => 'key/value'."\n", 'backendName' => 'parameters'], + 'SkewedInfo' => ['title' => 'skewedInfo', 'description' => '存储倾斜列信息的数据结构。', 'visibility' => 'Public', 'backendName' => 'skewedInfo', '$ref' => '#/components/schemas/DLSkewedInfo'], + 'InputFormat' => ['title' => 'inputFormat', 'description' => '输入格式类的名称，用于读取数据。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'org.apache.hadoop.mapred.SequenceFileInputFormat', 'backendName' => 'inputFormat'], + 'OutputFormat' => ['title' => 'outputFormat', 'description' => '输出格式类的名称，用于写入数据。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat', 'backendName' => 'outputFormat'], 'Columns' => [ 'title' => 'columns', 'description' => '表中数据列的描述信息。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '列属性。', - '$ref' => '#/components/schemas/DLColumn', - ], - ], - 'IsCompressed' => [ - 'title' => 'isCompressed', - 'description' => '是否压缩标识，表示数据是否被压缩存储。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SerdeInfo' => [ - 'title' => 'serdeInfo', - 'description' => '序列化和反序列化信息。', - '$ref' => '#/components/schemas/DLSerdeInfo', + 'items' => ['description' => '列属性。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn'], + 'backendName' => 'columns', + 'itemName' => 'Column', ], + 'IsCompressed' => ['title' => 'isCompressed', 'description' => '是否压缩标识，表示数据是否被压缩存储。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'compressed'], + 'SerdeInfo' => ['title' => 'serdeInfo', 'description' => '序列化和反序列化信息。', 'visibility' => 'Public', 'backendName' => 'serdeInfo', '$ref' => '#/components/schemas/DLSerdeInfo'], 'BucketCols' => [ 'title' => 'bucketCols', 'description' => '桶列的名称列表，决定数据的哈希分布。', + 'visibility' => 'Public', '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', + 'items' => ['description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2010', 'extendType' => 'true'], + 'backendName' => 'bucketCols', + 'itemName' => 'BucketCol', ], + 'NumBuckets' => ['title' => 'numBuckets', 'description' => '桶的数量。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'backendName' => 'numBuckets'], + 'Location' => ['title' => 'location', 'description' => '数据存储的具体位置。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxx', 'backendName' => 'location'], ], ], 'DLTable' => [ 'title' => 'Table', 'description' => '表的详细信息', + 'visibility' => 'Public', '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', + 'ViewOriginalText' => ['title' => 'viewOriginalText', 'description' => '如果表是视图，表示视图的原始文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'viewOriginalText'], + 'Owner' => ['title' => 'owner', 'description' => '表的所有者名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan', 'backendName' => 'owner'], + 'TableType' => ['title' => 'tableType', 'description' => '元数据表的类型。例如MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EXTERNAL_TABLE', 'backendName' => 'tableType'], + 'Parameters' => ['title' => 'parameters', 'description' => '参数key/value。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{'."\n" + .' "EXTERNAL": "TRUE",'."\n" + .' "delta.minReaderVersion": "1"}', 'backendName' => 'parameters'], + 'Description' => ['title' => 'description', 'description' => '表的描述信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description'], + 'CreatorId' => ['title' => 'creatorId', 'description' => '创建该表的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '8****', 'backendName' => 'creatorId'], + 'CreateTime' => ['title' => 'createTime', 'description' => '表的创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1731586286', 'backendName' => 'createTime'], + 'StorageDescriptor' => ['title' => 'StorageDescriptor', 'description' => '存储描述信息，包含表的存储特征和格式详细信息。', 'visibility' => 'Public', 'backendName' => 'storageDescriptor', '$ref' => '#/components/schemas/DLStorageDescriptor'], + 'LastAccessTime' => ['title' => 'lastAccessTime', 'description' => '上次访问该表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'backendName' => 'lastAccessTime'], + 'Retention' => ['title' => 'retention', 'description' => '该表的保留时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'backendName' => 'retention'], + 'Name' => ['title' => 'name', 'description' => '表的名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '100g_customer', 'backendName' => 'name'], + 'OwnerType' => ['title' => 'ownerType', 'description' => '所有者的类型。可填写USER、ROLE或GROUP。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'USER', 'backendName' => 'ownerType'], + 'ViewExpandedText' => ['title' => 'viewExpandedText', 'description' => '如果表是视图，表示视图的展开文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'viewExpandedText'], + 'DbId' => ['title' => 'dbId', 'description' => '表所属的数据库ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'backendName' => 'dbId'], + 'DbName' => ['title' => 'dbName', 'description' => '表所属的数据库名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'dbName'], + 'CatalogName' => ['title' => 'catalogName', 'description' => '数据目录名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'catalogName'], + 'PartitionKeys' => [ + 'title' => 'partitionKeys', + 'description' => '表的列属性列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => '列信息。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn'], + 'backendName' => 'partitionKeys', + 'itemName' => 'PartitionKey', ], + 'ModifierId' => ['title' => 'modifierId', 'description' => '最后修改该表的用户。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1410769', 'backendName' => 'modifierId'], + 'Location' => ['title' => 'location', 'description' => '表的存储路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxx', 'backendName' => 'location'], + ], + ], + 'DLTablebaseInfo' => [ + 'title' => 'TablebaseInfo', + 'description' => '表的基本信息。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['title' => 'owner', 'description' => '表的所有者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'owner'], + 'ViewOriginalText' => ['title' => 'viewOriginalText', 'description' => '如果表是视图，表示视图的原始文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""'."\n", 'backendName' => 'viewOriginalText'], + 'TableType' => ['title' => 'tableType', 'description' => '表的类型。例如 MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EXTERNAL_TABLE'."\n", 'backendName' => 'tableType'], + 'Parameters' => ['title' => 'parameters', 'description' => '表的附加参数。', 'visibility' => 'Public', 'type' => 'object', 'example' => ' "EXTERNAL": "TRUE"'."\n", 'backendName' => 'parameters'], + 'Description' => ['title' => 'description', 'description' => '表的描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '"table"'."\n", 'backendName' => 'description'], + 'CreatorId' => ['title' => 'creatorId', 'description' => '创建该表的用户 ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '141****'."\n", 'backendName' => 'creatorId'], + 'CreateTime' => ['title' => 'createTime', 'description' => '创建表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'backendName' => 'createTime'], + 'LastAccessTime' => ['title' => 'lastAccessTime', 'description' => '上次访问表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1731586286', 'backendName' => 'lastAccessTime'], + 'Retention' => ['title' => 'retention', 'description' => '表的保留期（按天）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'backendName' => 'retention'], + 'Name' => ['title' => 'name', 'description' => '表的名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '100g_customer'."\n", 'backendName' => 'name'], 'OwnerType' => [ 'title' => 'ownerType', - 'description' => '所有者的类型。可填写USER、ROLE或GROUP。', + 'description' => '负责人类型。可填写 USER、ROLE 或 GROUP。', + 'visibility' => 'Public', 'type' => 'string', + 'enumValueTitles' => ['ROLE' => 'ROLE', 'GROUP' => 'GROUP', 'USER' => 'USER'], 'example' => 'USER', + 'backendName' => 'ownerType', ], - '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', - ], + 'ViewExpandedText' => ['title' => 'viewExpandedText', 'description' => '如果表是视图，表示视图的展开文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""'."\n", 'backendName' => 'viewExpandedText'], + 'DbId' => ['title' => 'dbId', 'description' => '所属的数据库 ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'backendName' => 'dbId'], + 'DbName' => ['title' => 'dbName', 'description' => '所属的数据库名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default', 'backendName' => 'dbName'], + 'CatalogName' => ['title' => 'catalogName', 'description' => '所属的数据目录。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive', 'backendName' => 'catalogName'], 'PartitionKeys' => [ 'title' => 'partitionKeys', 'description' => '表的列属性列表。', + 'visibility' => 'Public', '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', + 'items' => ['description' => '列属性。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn'], + 'backendName' => 'partitionKeys', + 'itemName' => 'Column', ], + 'ModifierId' => ['title' => 'modifierId', 'description' => '修改表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1731585286', 'backendName' => 'modifierId'], + 'Location' => ['title' => 'location', 'description' => '表的存储路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxx', 'backendName' => 'location'], ], ], 'DLTableInput' => [ 'description' => '表的详细信息', + 'visibility' => 'Public', '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", - ], + 'Owner' => ['description' => '表的所有者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'zhangsan'."\n", 'backendName' => 'owner'], + 'ViewOriginalText' => ['description' => '如果表是视图，表示视图的原始文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'viewOriginalText'], + 'TableType' => ['description' => '元数据表的类型。例如MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、INDEX_TABLE、MATERIALIZED_VIEW。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'EXTERNAL_TABLE'."\n", 'backendName' => 'tableType'], 'Parameters' => [ 'description' => '键值对参数。', + 'visibility' => 'Public', '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' => '""', - ], + 'additionalProperties' => ['description' => '参数key/value。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{'."\n" + .' "EXTERNAL": "TRUE",'."\n" + .' "delta.minReaderVersion": "1"}'], + 'backendName' => 'parameters', + ], + 'Description' => ['description' => '表的描述信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'description'], + 'CreatorId' => ['description' => '创建该表的用户ID。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '8****', 'backendName' => 'creatorId'], + 'CreateTime' => ['description' => '表的创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1731586286', 'backendName' => 'createTime'], + 'StorageDescriptor' => ['title' => 'storageDescriptor', 'description' => '存储描述信息，包含表的存储特征和格式详细信息。', 'visibility' => 'Public', 'backendName' => 'storageDescriptor', '$ref' => '#/components/schemas/DLStorageDescriptor'], + 'LastAccessTime' => ['description' => '上次访问该表的时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1608707407', 'backendName' => 'lastAccessTime'], + 'Retention' => ['description' => '该表的保留时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'backendName' => 'retention'], + 'Name' => ['title' => 'name', 'description' => '表的名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => '100g_customer', 'backendName' => 'name'], + 'OwnerType' => ['description' => '所有者的类型。可填写USER、ROLE或GROUP。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'USER', 'backendName' => 'ownerType'], + 'ViewExpandedText' => ['description' => '如果表是视图，表示视图的展开文本。', 'visibility' => 'Public', 'type' => 'string', 'example' => '""', 'backendName' => 'viewExpandedText'], 'PartitionKeys' => [ 'description' => '表的列属性列表。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '列信息。', - '$ref' => '#/components/schemas/DLColumn', - ], - ], - 'ModifierId' => [ - 'description' => '最后修改该表的用户。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1410769', - ], - 'Location' => [ - 'description' => '表的存储路径。', - 'type' => 'string', - 'example' => 'oss://xxx', + 'items' => ['description' => '列信息。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn'], + 'backendName' => 'partitionKeys', ], + 'ModifierId' => ['description' => '最后修改该表的用户。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1410769', 'backendName' => 'modifierId'], + 'Location' => ['description' => '表的存储路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://xxx', 'backendName' => 'location'], ], ], - 'DLTablebaseInfo' => [ - 'title' => 'TablebaseInfo', - 'description' => '表的基本信息。', + 'DmsGatewayOrder' => [ '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', - ], + 'BizType' => ['type' => 'string'], + 'OrderId' => ['type' => 'integer', 'format' => 'int64'], + 'InstanceId' => ['type' => 'string'], + 'InstanceType' => ['type' => 'string'], + 'Region' => ['type' => 'string'], + 'ChargeType' => ['type' => 'string'], + 'CommodityCode' => ['type' => 'string'], + 'ExpireTime' => ['type' => 'string'], + 'State' => ['type' => 'string'], + 'PayNum' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'DmsKnowledgeSearchOrderInfoDO' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'integer', 'format' => 'int64'], + 'OrderId' => ['type' => 'string'], + 'AliyunAccountUid' => ['type' => 'string'], + 'ApiKey' => ['type' => 'string'], + 'WebSearchApiUrl' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'GmtModified' => ['type' => 'string'], ], ], 'ForeignInstance' => [ 'description' => '外部数据源实例信息。', + 'visibility' => 'Public', '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', - ], + 'InstanceSource' => ['description' => '数据库实例来源，取值如下：'."\n" + ."\n" + .'- **PUBLIC_OWN**：代表公网自建实例'."\n" + .'- **RDS**：代表RDS实例'."\n" + .'- **ECS_OWN**：代表ECS自建实例'."\n" + .'- **VPC_IDC**：代表VPC IDC自建实例'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RDS', 'backendName' => 'instanceSource'], + 'Port' => ['description' => '实例连接端口。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '7890', 'backendName' => 'port'], + 'Host' => ['description' => '实例连接地址。', 'visibility' => 'Public', 'type' => 'string', 'example' => '127.0.XX.XX', 'backendName' => 'host'], + 'RegionId' => ['description' => '资源所属的地域ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai', 'backendName' => 'regionId'], + 'InstanceType' => ['description' => '实例类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'mysql', 'backendName' => 'instanceType'], 'Properties' => [ 'description' => '属性信息。', + 'visibility' => 'Public', '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', + 'additionalProperties' => ['description' => '属性信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{\\"PackageUsedUpStrategyKey\\":\\"Postpaid\\"}'], + 'backendName' => 'properties', ], + 'DataLinkName' => ['description' => 'datalink名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dbl_mysql_2337', 'backendName' => 'dataLinkName'], + 'Sid' => ['description' => '数据库Sid。'."\n" + .'>数据库Sid是Oracle数据库的唯一标识符。当建立一个数据库时，系统将自动赋予一个初始ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'HXE', 'backendName' => 'sid'], ], ], 'ForeignInstanceCredInfo' => [ 'description' => '外部数据源凭证信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'CredInfo' => [ 'description' => '凭证信息。', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '凭证信息。', - 'type' => 'string', - 'example' => '{"username": "xxx", "password": "yyy"}', - ], - ], - 'CredType' => [ - 'description' => '凭证类型，目前恒定取值为DEFAULT。', - 'type' => 'string', - 'example' => 'DEFAULT', + 'additionalProperties' => ['description' => '凭证信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"username": "xxx", "password": "yyy"}'], + 'backendName' => 'credInfo', ], + 'CredType' => ['description' => '凭证类型，目前恒定取值为DEFAULT。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'DEFAULT', 'backendName' => 'credType'], + ], + ], + 'ManagedDaOrderSummaryVO' => [ + 'type' => 'object', + 'properties' => [ + 'totalQuota' => ['type' => 'integer', 'format' => 'int32'], + 'usedQuota' => ['type' => 'integer', 'format' => 'int32'], + 'availableQuota' => ['type' => 'integer', 'format' => 'int32'], + 'trialUsed' => ['type' => 'boolean'], + 'trialExpireTime' => ['type' => 'string'], + 'validOrderCount' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'ManagedDaOrderVO' => [ + 'type' => 'object', + 'properties' => [ + 'orderId' => ['type' => 'integer', 'format' => 'int64'], + 'subscriptionPlan' => ['type' => 'string'], + 'payNum' => ['type' => 'integer', 'format' => 'int32'], + 'state' => ['type' => 'string'], + 'expireTime' => ['type' => 'string', 'format' => 'iso8601_normal'], + 'region' => ['type' => 'string'], + 'instanceId' => ['type' => 'string'], + 'gmtCreate' => ['type' => 'string', 'format' => 'iso8601_normal'], + ], + ], + 'MdbAgentInstanceVo' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string'], + 'InstanceName' => ['type' => 'string'], + 'EngineType' => ['type' => 'string'], + 'EngineInstanceId' => ['type' => 'string'], + 'EngineRegion' => ['type' => 'string'], + 'PublicDomain' => ['type' => 'string'], + 'Status' => ['type' => 'integer', 'format' => 'int32'], + 'StatusDesc' => ['type' => 'string'], + 'StatusMessage' => ['type' => 'string'], + 'OrderId' => ['type' => 'string'], + 'ChargeType' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'LastActiveTime' => ['type' => 'string'], + 'LockTime' => ['type' => 'string'], + 'AccessUrl' => ['type' => 'string'], + ], + ], + 'OneMetaDatabase' => [ + 'type' => 'object', + 'properties' => [ + 'CatalogUuid' => ['type' => 'string'], + 'CatalogName' => ['type' => 'string'], + 'CatalogType' => ['type' => 'string'], + 'DataSourceType' => ['type' => 'string'], + 'DatabaseUuid' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'QualifiedName' => ['type' => 'string'], + 'SearchName' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'EngineMeta' => ['$ref' => '#/components/schemas/OneMetaDatabaseEngineMeta'], + 'StorageLocation' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'State' => ['type' => 'integer', 'format' => 'int32'], + 'Properties' => ['type' => 'object'], + 'DatabaseBizAttrs' => ['type' => 'object'], + ], + ], + 'OneMetaDatabaseEngineMeta' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['type' => 'string'], + 'CatalogName' => ['type' => 'string'], + 'Encoding' => ['type' => 'string'], + 'StorageCapacity' => ['type' => 'integer', 'format' => 'int64'], ], ], 'OneMetaDatabaseObject' => [ 'type' => 'object', 'properties' => [ - 'ObjectName' => [ - 'type' => 'string', - ], - 'ObjectType' => [ - 'type' => 'string', - ], - 'ObjectQualifiedName' => [ - 'type' => 'string', - ], + 'ObjectName' => ['type' => 'string'], + 'ObjectType' => ['type' => 'string'], + 'ObjectQualifiedName' => ['type' => 'string'], + ], + ], + 'OneMetaKnowledgeBase' => [ + 'description' => '知识库对象结构', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['title' => '知识库uuid标识', 'description' => '知识库uuid标识', 'type' => 'string', 'example' => 'kb-***'], + 'Name' => ['title' => '知识库名字', 'description' => '知识库名字', 'type' => 'string', 'example' => 'order_kb'], + 'Description' => ['title' => '知识库描述', 'description' => '知识库描述', 'type' => 'string', 'example' => 'order knowledgebase'], + 'State' => ['title' => '知识库状态：'."\n" + .'0：无数据'."\n" + .'1：可用', 'description' => '知识库状态：'."\n" + .'0：无数据'."\n" + .'1：可用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Tag' => ['title' => '知识库标签', 'description' => '知识库标签', 'type' => 'string', 'example' => '4phsj52f81ymlm***'], + 'Creator' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '20464374909***'], + 'GmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-05-14 11:30:00'], + 'GmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2026-05-14 11:30:39'], + 'Domain' => ['description' => '知识库作用域', 'type' => 'string', 'example' => 'vehicle'], + 'ExtraInfo' => ['description' => '知识库其他信息', 'type' => 'string', 'example' => '{"keywords":"sales,vehicle brand"}'], + ], + ], + 'OneMetaKnowledgeBaseChunk' => [ + 'description' => '知识块信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '知识块ID。', 'type' => 'string', 'example' => '2e12aeb5-52cd-4834-bcd8-****'], + 'DocName' => ['description' => '文档名称。', 'type' => 'string', 'example' => 'test.md'], + 'Content' => ['description' => '知识块内容。', 'type' => 'string', 'example' => 'abc'], + 'ChunkTitle' => ['description' => '知识块标题。', 'type' => 'string', 'example' => 'titile1'], + 'ChunkMtime' => ['description' => '知识块修改时间。', 'type' => 'string', 'example' => '2026-04-20 15:51:27'], + ], + ], + 'OneMetaKnowledgeBaseDocument' => [ + 'description' => '文档信息。', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['title' => '知识库Uuid', 'description' => '知识库ID。', 'type' => 'string', 'example' => 'kb-***'], + 'Name' => ['title' => '文档名称', 'description' => '文档名称。', 'type' => 'string', 'example' => 'test.md'], + 'Description' => ['title' => '文档描述', 'description' => '文档描述。', 'type' => 'string', 'example' => 'abc'], + 'FileExt' => ['title' => '文档扩展类型', 'description' => '文档扩展类型。', 'type' => 'string', 'example' => 'md'], + 'DocumentLoaderName' => ['title' => '文档加载器名称', 'description' => '文档加载器名称。', 'type' => 'string', 'example' => 'ADBPGLoader'], + 'TextSplitterName' => ['title' => '文档分词器名称', 'description' => '文档分词器名称。', 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter'], + 'GmtCreate' => ['title' => '创建时间', 'description' => '文档创建时间。', 'type' => 'string', 'example' => '2026-04-22 22:59:35'], + 'GmtModified' => ['title' => '修改时间', 'description' => '文档修改时间。', 'type' => 'string', 'example' => '2026-04-24 21:22:53'], + 'FileSize' => ['title' => '文件大小', 'description' => '文档大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '20307'], + 'DocsCount' => ['title' => 'chunk 数量', 'description' => '知识块数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'State' => ['title' => '文档状态：'."\n" + .'0：正常'."\n" + .'-1：未解析'."\n" + .'-2：解析中'."\n" + .'-3：解析失败'."\n" + .'-4：解析取消', 'description' => '文档状态，返回值如下：'."\n" + ."\n" + .'- **0**：文档解析完成。'."\n" + .'- **-1**：文档未解析。'."\n" + .'- **-2**：文档解析中。'."\n" + .'- **-3**：文档解析失败。'."\n" + .'- **-4**：文档解析取消。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Summary' => ['description' => '文档摘要。', 'type' => 'string', 'example' => 'This is a test document.'], + 'Keywords' => ['description' => '文档关键词。', 'type' => 'string', 'example' => '["test","abc"]'], ], ], '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', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'IndexName' => ['type' => 'string'], + 'IndexType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], 'ColumnNames' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'Primary' => [ - 'type' => 'boolean', - ], - 'Unique' => [ - 'type' => 'boolean', + 'items' => ['type' => 'string'], ], + 'Primary' => ['type' => 'boolean'], + 'Unique' => ['type' => 'boolean'], 'RealColumnNames' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'items' => ['type' => 'string'], + ], + ], + ], + 'OpenClawInstanceQuotaVO' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string'], + 'ModelCallUsed' => ['type' => 'string'], + 'ModelCallQuota' => ['type' => 'string'], + 'SkillPlanCallUsed' => ['type' => 'string'], + 'SkillPlanCallQuota' => ['type' => 'string'], + 'DeepResearchCallUsed' => ['type' => 'string'], + 'DeepResearchCallQuota' => ['type' => 'string'], + 'AliyunAccountUid' => ['type' => 'string'], + 'RefreshDay' => ['type' => 'string'], + 'LastMeteringTime' => ['type' => 'string'], + 'InstanceName' => ['type' => 'string'], + 'InstanceGmtCreate' => ['type' => 'string'], + 'InstanceDesc' => ['type' => 'string'], + 'Status' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'OpenClawInstanceVO' => [ + 'type' => 'object', + 'properties' => [ + 'AliyunAccountUid' => ['type' => 'string'], + 'InstanceId' => ['type' => 'string'], + 'InstanceName' => ['type' => 'string'], + 'InstanceDesc' => ['type' => 'string'], + 'Cpu' => ['type' => 'number', 'format' => 'double'], + 'MemorySize' => ['type' => 'integer', 'format' => 'int32'], + 'PublicDomain' => ['type' => 'string'], + 'OpenclawToken' => ['type' => 'string'], + 'Status' => ['type' => 'integer', 'format' => 'int32'], + 'StatusDesc' => ['type' => 'string'], + 'GmtCreate' => ['type' => 'string'], + 'GmtModified' => ['type' => 'string'], + 'LastActiveTime' => ['type' => 'string'], + 'OwnerUid' => ['type' => 'string'], + 'AuthType' => ['type' => 'string'], + 'BasicAuthUsername' => ['type' => 'string'], + 'BasicAuthPassword' => ['type' => 'string'], + 'Variables' => ['type' => 'string'], + 'StatusMessage' => ['type' => 'string'], + 'InstanceRegion' => ['type' => 'string'], + 'ImageInfo' => [ + 'type' => 'object', + 'properties' => [ + 'ImageId' => ['type' => 'integer', 'format' => 'int64'], + 'Namespace' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Tag' => ['type' => 'string'], + 'VersionDesc' => ['type' => 'string'], ], ], + 'ChargeType' => ['type' => 'string'], + 'TrialExpireTime' => ['type' => 'string'], + 'LockTime' => ['type' => 'string'], + 'ModelCallQuota' => ['type' => 'integer', 'format' => 'int64'], + 'ModelCallUsed' => ['type' => 'integer', 'format' => 'int64'], + 'AgentType' => ['type' => 'string'], ], ], 'PartitionError' => [ 'description' => '具体的错误信息。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ErrorDetail' => [ - 'description' => '错误详情。', - 'type' => 'string', - 'example' => 'auth failed', - ], + 'ErrorDetail' => ['description' => '错误详情。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'auth failed', 'backendName' => 'errorDetail'], 'Values' => [ 'description' => '分区值。', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '分区列的值。', - 'type' => 'string', - 'example' => 'part_val1', - ], + 'items' => ['description' => '分区列的值。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'part_val1', 'extendType' => 'true'], + 'backendName' => 'values', ], ], ], + 'TrialOrderEligibilityVO' => [ + 'type' => 'object', + 'properties' => [ + 'Valid' => ['type' => 'boolean'], + 'Message' => ['type' => 'string'], + ], + ], ], ], 'apis' => [ - 'CreateAirflowLoginToken' => [ - 'summary' => '通过该API可获取Airflow登录凭证，使用此登录凭证可以登录DMS托管Airflow。', + 'AddUserToDataAgentWorkspace' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AirflowId', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'Airflow的实例ID。您可以在[Airflow实例列表](~~2881043~~)页面查看。', - 'type' => 'string', - 'required' => true, - 'example' => 'af-b3a7f110a6vmvn7xxxxxx', - ], + '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' => [ @@ -1313,278 +1070,401 @@ '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', - ], + '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' => '监控任务的结果详情。', + '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****', - ], + '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'], ], ], - 'Code' => [ - 'description' => '状态码。200表示成功。', - 'type' => 'string', - 'example' => '200', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '为协作空间添加成员', + 'summary' => '将用户添加到指定的工作空间中', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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登录凭证', + 'ramActions' => [], + '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"}]', ], - 'CreateAirflow' => [ - 'summary' => '在工作空间下创建Airflow实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'BatchCreateDataLakePartitions' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'high', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'title' => 'DMS工作空间ID', - 'description' => 'DMS工作空间ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8630242382****', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'AirflowName', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'title' => 'airflow实例的名称', - 'description' => 'Airflow实例名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testairflow', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Description', + 'name' => 'TableName', 'in' => 'query', + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], + ], + [ + 'name' => 'PartitionInputs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'airflow实例的描述', - 'description' => 'Airflow实例描述。', - 'type' => 'string', + 'description' => '新增分区的信息。', + 'type' => 'array', + 'items' => ['description' => '数据湖分区信息。', 'required' => false, '$ref' => '#/components/schemas/DLPartitionInput'], 'required' => true, - 'example' => 'order scheduler', ], ], [ - 'name' => 'AppSpec', + 'name' => 'IfNotExists', 'in' => 'query', - 'schema' => [ - 'title' => 'airflow实例的规格-SMALL、MEDIUM、LARGE、XLARGE、X2LARGE', - 'description' => 'Airflow实例的规格，取值为：**SMALL**、**MEDIUM**、**LARGE**、**XLARGE**或**X2LARGE**。', - 'type' => 'string', - 'required' => true, - 'example' => 'SMALL', - ], + 'schema' => ['description' => '若新增的分区名称与已有的分区名称重复，是否忽略该异常。取值：'."\n" + ."\n" + .'- **true**：忽略。'."\n" + ."\n" + .'- **false**：不忽略。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'WorkerServerlessReplicas', + 'name' => 'NeedResult', 'in' => 'query', - 'schema' => [ - 'title' => 'Worker节点扩展', - 'description' => 'Worker节点扩展的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '是否需要返回分区信息，为**true**时结果会返回Partitions。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'VpcId', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'title' => 'vpc id', - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-uf63r6coyiw9o5****', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3****'], ], [ - 'name' => 'VSwitchId', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '交换机ID', - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-8vbaf073jawozfp****', + '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'], + 'title' => '批量新建湖仓表分区', + 'summary' => '调用此API可批量新建湖仓表分区。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:BatchCreateDataLakePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"Partitions\\": [\\n {\\n \\"TableName\\": \\"table_name\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n },\\n \\"CreateTime\\": 1735109884,\\n \\"Values\\": [\\n \\"part_val1\\"\\n ],\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"LastAccessTime\\": 1608707407\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchDeleteDataLakePartitions' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SecurityGroupId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'title' => '安全组ID', - 'description' => '安全组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-bp108t8ldzeyk1****', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'ZoneId', + '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' => [ - 'title' => 'region中可用区ID', - 'description' => 'Region下的可用区ID。', - 'type' => 'string', + 'description' => '分区值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分区值。', + 'type' => 'array', + 'items' => ['description' => '分区列的值。', 'type' => 'string', 'required' => false, 'example' => 'part_val1'], + 'required' => false, + ], 'required' => true, - 'example' => 'cn-hangzhou-h', ], ], [ - 'name' => 'OssBucketName', + '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' => 'OSS bucket名称', - 'description' => 'OSS Bucket名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss-test', + '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'], + 'title' => '批量删除湖仓表分区', + 'summary' => '调用此API可批量删除湖仓表分区。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B96E35F-A58E-5399-9041-09CF9A1E****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"auth failed\\",\\n \\"Values\\": [\\n \\"part_val1\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchUpdateDataLakePartitions' => [ + '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' => 'OssPath', + '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' => [ - 'title' => 'OSS路径', - 'description' => '存放日志的OSS路径。', - 'type' => 'string', + 'description' => '新增分区的信息。', + 'type' => 'array', + 'items' => ['description' => '数据湖分区信息。', 'required' => false, '$ref' => '#/components/schemas/DLPartitionInput'], 'required' => true, - 'example' => '/airflow', ], ], [ - 'name' => 'StartupFile', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'title' => 'airflow容器的启动脚本', - 'description' => 'Airflow容器的启动脚本。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/startup.sh', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3****'], ], [ - 'name' => 'RequirementFile', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '可按照包的路径', - 'description' => '安装包的路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/requirements.txt', + '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'], + 'title' => '批量更新湖仓表分区', + 'summary' => '调用此API可批量更新湖仓表分区信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:BatchUpdateDataLakePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E175****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"auth failed\\",\\n \\"Values\\": [\\n \\"part_val1\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ConfigAirflow' => [ + 'summary' => '更新Airflow实例的自定义配置', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DagsDir', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + ], + 'parameters' => [ + [ + 'name' => 'AirflowId', 'in' => 'query', - 'schema' => [ - 'title' => 'dag扫描路径', - 'description' => 'Airflow扫描的dag目录。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/dags', - ], + 'schema' => ['title' => 'Airflow实例的唯一ID', 'description' => 'Airflow实例的唯一ID', 'type' => 'string', 'required' => true, 'example' => 'af-b3a7f110a6vmvn7xxxxxx'], ], [ - 'name' => 'PluginsDir', + 'name' => 'CustomAirflowCfg', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'title' => 'airflow实例扫描的插件路径', - 'description' => 'Airflow实例扫描的插件目标。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/plugins', + 'title' => '自定义Airflow配置列表', + 'description' => '自定义Airflow配置列表', + 'type' => 'array', + 'items' => ['description' => '配置明细。', 'type' => 'string', 'required' => false, 'example' => 'celery.worker_concurrency=10'], + 'required' => true, ], ], [ - 'name' => 'ClientToken', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。', - 'type' => 'string', - 'required' => false, - 'example' => 'token-****', - ], + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID', 'type' => 'string', 'required' => true, 'example' => '8630242382****'], ], ], 'responses' => [ @@ -1592,333 +1472,189 @@ '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', - ], + '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数据字典。', + 'title' => 'Airflow实例信息', + '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', - ], + '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' => ['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' => 'vpc not found'], + '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' => '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-7a6ygsh80dx1jn****'], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-bp1931trfxkvf74v****'], + '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' => 'DMS工作空间ID', 'description' => 'DMS工作空间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', - ], + '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'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '更新Airflow实例的自定义配置', + 'description' => '配置DMS Airflow的airflow.cfg文件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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实例', + 'ramActions' => [], + '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 \\"CustomAirflowCfg\\": [\\n \\"smtp.username=test\\"\\n ],\\n \\"DagsDir\\": \\"default/dags\\",\\n \\"DeployErrorMsg\\": \\"vpc not found\\",\\n \\"Description\\": \\"test airflow\\",\\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-7a6ygsh80dx1jn****\\",\\n \\"VSwitchId\\": \\"vsw-bp1931trfxkvf74v****\\",\\n \\"VpcId\\": \\"vpc-uf63r6coyiw9o5gf****\\",\\n \\"WorkerServerlessReplicas\\": 0,\\n \\"WorkspaceId\\": \\"86302423828****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n },\\n \\"Message\\": \\"Instance not found.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateAirflow' => [ - 'summary' => '更新Airflow实例信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAirflow' => [ + 'summary' => '在工作空间下创建Airflow实例。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', + 'operationType' => 'create', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。', - 'type' => 'string', - 'required' => false, - 'example' => 'token-****', - ], + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8630242382****'], ], [ - 'name' => 'AirflowId', + 'name' => 'AirflowName', 'in' => 'query', - 'schema' => [ - 'title' => 'Airflow的唯一键ID', - 'description' => 'Airflow的唯一键ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'af-test****', - ], + 'schema' => ['title' => 'airflow实例的名称', 'description' => 'Airflow实例名称。', 'type' => 'string', 'required' => true, 'example' => 'testairflow'], ], [ - 'name' => 'AirflowName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => 'Airflow实例的名字', - 'description' => 'Airflow实例的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testairflow', - ], + 'schema' => ['title' => 'airflow实例的描述', 'description' => 'Airflow实例描述。', 'type' => 'string', 'required' => false, 'example' => 'order scheduler'], ], [ - 'name' => 'StartupFile', + 'name' => 'AppSpec', 'in' => 'query', - 'schema' => [ - 'title' => 'Airflow实例的启动时加载的脚本', - 'description' => 'Airflow实例的启动时加载的脚本。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/startup.sh', - ], + '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' => false, - 'example' => '0', - ], + 'schema' => ['title' => 'Worker节点扩展', 'description' => 'Worker节点扩展的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ - 'name' => 'Description', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'title' => 'Airflow的描述信息', - 'description' => 'Airflow的描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test airflow', - ], + 'schema' => ['title' => 'vpc id', 'description' => 'VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf63r6coyiw9o5****'], ], [ - 'name' => 'PluginsDir', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'title' => 'Airflow扫描的插件目录', - 'description' => 'Airflow扫描的插件目录。', - 'type' => 'string', - 'required' => false, - 'example' => 'default/plugins', - ], + 'schema' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-8vbaf073jawozfp****'], ], [ - 'name' => 'AppSpec', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'title' => 'AIrflow的规格描述', - 'description' => 'AIrflow的规格描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'SMALL', - ], + 'schema' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'required' => true, 'example' => 'sg-bp108t8ldzeyk1****'], + ], + [ + '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', - ], + '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' => 'GracefulShutdownTimeout', + 'in' => 'query', + 'schema' => ['title' => 'Worker退出时的超时时间', 'description' => 'Worker退出时的超时时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], + ], + [ + 'name' => 'EnableServerless', + 'in' => 'query', + 'schema' => ['title' => '是否开启Worker弹性', 'description' => '是否开启Worker弹性', 'type' => 'boolean', 'required' => false, 'default' => 'false'], + ], + [ + 'name' => 'DataMountInfoList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Airflow扫描dag的目录', - 'description' => 'Airflow扫描dag的目录。', - 'type' => 'string', + 'title' => '数据挂载信息列表', + 'description' => '数据挂载信息列表', + 'type' => 'array', + 'items' => ['title' => 'OSS存储绑定', 'description' => 'OSS存储绑定', 'required' => false, '$ref' => '#/components/schemas/DataMountInfo'], 'required' => false, - 'example' => 'default/dags', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'AirflowVersion', 'in' => 'query', - 'schema' => [ - 'title' => 'DMS工作空间ID', - 'description' => 'DMS工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '863024238280****', - ], + 'schema' => ['title' => 'Airflow版本，支持3.1或2.10', 'description' => 'Airflow版本，支持3.1或2.10', 'type' => 'string', 'required' => false, 'example' => '3.1'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '客户端Token，用于保证请求的幂等性。', 'type' => 'string', 'required' => false, 'example' => 'token-****'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => 'Region下的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], ], ], 'responses' => [ @@ -1926,969 +1662,822 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E0D21075-CD3E-4D98-8264-F****', - ], - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => 'NOT_FOUND', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'AccessDeniedDetail' => ['title' => '拒绝访问的详情', 'description' => '拒接访问的信息。', 'type' => 'string', 'example' => 'NOT_FOUND'], 'Root' => [ - 'description' => '更新后的详情信息。', + 'title' => '数据字典', + 'description' => 'Airflow数据字典。', 'type' => 'object', 'properties' => [ - 'AirflowName' => [ - 'description' => 'Airflow实例名称。', - 'type' => 'string', - 'example' => 'test airflow', - ], - 'AppSpec' => [ - 'description' => 'SMALL。', - 'type' => 'string', - 'example' => 'SMALL', - ], - 'AppType' => [ - 'description' => '实例类型。', - 'type' => 'string', - 'example' => 'AIRFLOW', - ], + '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'], + 'AirflowVersion' => ['title' => 'Airflow版本', 'description' => 'Airflow版本', 'type' => 'string', 'example' => '3.1'], 'CustomAirflowCfg' => [ - 'description' => '自定义配置项列表。', + 'title' => '自定义Airflow配置', + 'description' => '自定义Airflow配置', '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', + 'items' => ['title' => '自定义Airflow配置项', 'description' => '自定义Airflow配置项', 'type' => 'string', 'example' => 'celery.worker_concurrency=10'], ], - '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', + 'DataMountInfoList' => [ + 'title' => '数据挂载信息列表', + 'description' => '数据挂载信息列表', + 'type' => 'array', + 'items' => ['title' => '数据挂载', 'description' => '数据挂载', '$ref' => '#/components/schemas/DataMountInfo'], ], + 'EnableServerless' => ['title' => '是否开启Worker弹性', 'description' => '是否开启Worker弹性', 'type' => 'boolean'], + 'GracefulShutdownTimeout' => ['title' => 'Worker退出时的超时时间', 'description' => 'Worker退出时的超时时间', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], ], ], - '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', - ], + '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'], ], + 'description' => '', ], ], ], - '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', + '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 \\"AirflowVersion\\": \\"3.1\\",\\n \\"CustomAirflowCfg\\": [\\n \\"celery.worker_concurrency=10\\"\\n ],\\n \\"DataMountInfoList\\": [\\n {\\n \\"OssBucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MountFolderName\\": \\"\\",\\n \\"ReadOnly\\": true\\n }\\n ],\\n \\"EnableServerless\\": true,\\n \\"GracefulShutdownTimeout\\": 60\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建Airflow实例', + 'description' => '在工作空间下创建Airflow实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateAirflowLoginToken' => [ + 'path' => '', + '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', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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****', - ], + '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' => 'request id', - 'description' => 'Reuqest ID。', - 'type' => 'string', - 'example' => 'E0D21075-CD3E-4D98-8264-****', - ], - 'AccessDeniedDetail' => [ - 'title' => '访问失败的信息', - 'description' => '访问失败的信息。', - 'type' => 'string', - 'example' => 'NOT_FOUND', - ], - 'Root' => [ - 'title' => '数据明细', - 'description' => '数据明细。', + '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' => [ - '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', - ], + 'Token' => ['description' => '生成Token。', 'type' => 'string', 'example' => 'f432d77de03b6b95fc24f9****'], + 'Host' => ['description' => 'Airflow实例的访问地址。', 'type' => 'string', 'example' => 'https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszb****'], ], ], - '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', - ], + 'Code' => ['description' => '状态码。200表示成功。', 'type' => 'string', 'example' => '200'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidAirflow.NotFound', - 'errorMessage' => 'The specified Airflow does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Airflow登录凭证', + 'summary' => '通过该API可获取Airflow登录凭证，使用此登录凭证可以登录DMS托管Airflow。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:CreateAirflowLoginToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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实例详情', + '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"}]', ], - 'ListAirflows' => [ - 'summary' => '获取工作空间的Airflow实例列表。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateCustomAgent' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'title' => 'DMS工作空间ID', - 'description' => 'DMS工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '86302423828****', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb'], ], [ - 'name' => 'MaxResults', + 'name' => 'Name', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['description' => '自定义Agent名称', 'type' => 'string', 'required' => false, 'example' => 'Agent测试名称'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '自定义Agent描述', 'type' => 'string', 'required' => false, 'example' => 'Agent测试描述'], + ], + [ + 'name' => 'DataJson', + 'in' => 'query', + 'schema' => ['description' => '指定的数据范围，**JSON字符串格式**'."\n" + .'- 通用参数说明'."\n" + .' - tableFlag：true为指定数据范围'."\n" + .' - scope：personal为固定值'."\n" + .' - personal：文件、数据库类型的传参'."\n" + ."\n" + .'**文件类型**，按如下格式传参：'."\n" + .'- DataSourceType：remote_data_center为固定值'."\n" + .'- FileId：文件ID'."\n" + .'- Database：ListDataCenterTable接口返回的库名，通常为文件名'."\n" + .'- Tables：ListDataCenterTable接口返回的表名'."\n" + .'- TableIds：ListDataCenterTable接口返回的TableId'."\n" + .'- RegionId：当前地域'."\n" + .'```'."\n" + .'{'."\n" + .' "tableFlag": true,'."\n" + .' "scope": "personal",'."\n" + .' "personal": {'."\n" + .' "DataSourceType": "remote_data_center",'."\n" + .' "FileId": "f-f0jksn001ibmkoo********6v2zn6",'."\n" + .' "Database": "diamonds.csv",'."\n" + .' "Tables": ['."\n" + .' "diamonds"'."\n" + .' ],'."\n" + .' "TableIds": ['."\n" + .' "35hfn94pxl********50pi"'."\n" + .' ],'."\n" + .' "RegionId": "cn-hangzhou"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'**数据库类型**，按如下参数传参：'."\n" + .'- DataSourceType：database为固定值'."\n" + .'- DmsInstanceId：数据中心接口返回的DMS实例ID'."\n" + .'- DmsDatabaseId：数据中心接口返回的DMS数据库ID'."\n" + .'- FileId：实例名（已废弃）'."\n" + .'- DbName：数据中心接口返回的数据库名称'."\n" + .'- Database：数据中心接口返回的数据库名称'."\n" + .'- Tables：数据中心接口返回的表名'."\n" + .'- TableIds：数据中心接口返回的TableId'."\n" + .'- Engine：引擎类型（mysql、postgresql）'."\n" + .'- RegionId：当前地域'."\n" + .'```'."\n" + .'{'."\n" + .' "tableFlag": true,'."\n" + .' "scope": "personal",'."\n" + .' "personal": {'."\n" + .' "DataSourceType": "database",'."\n" + .' "DmsInstanceId": "284***8",'."\n" + .' "DmsDatabaseId": "769***45",'."\n" + .' "FileId": "pgm-bp15095e*******6t",'."\n" + .' "DbName": "pg_catalog",'."\n" + .' "Database": "pg_catalog",'."\n" + .' "Tables": ['."\n" + .' "pg_aggregate"'."\n" + .' ],'."\n" + .' "TableIds": ['."\n" + .' "5263****31"'."\n" + .' ],'."\n" + .' "Engine": "postgresql",'."\n" + .' "RegionId": "cn-hangzhou"'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'string', 'required' => false, '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" + .'}'], + ], + [ + 'name' => 'Instruction', + 'in' => 'query', + 'schema' => ['description' => '指示'."\n" + .'- 输入限制：最大10000字符', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n" + .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n" + .'2、订单量为每日有效下单笔数；'."\n" + .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n" + .'4、转化率=支付订单数 / UV，反映流量转化效率；'], + ], + [ + 'name' => 'Knowledge', + 'in' => 'query', + 'schema' => ['description' => '知识'."\n" + .'- 输入限制：最大10000字符', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n" + .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n" + .'2、订单量为每日有效下单笔数；'."\n" + .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n" + .'4、转化率=支付订单数 / UV，反映流量转化效率；'], + ], + [ + 'name' => 'KnowledgeConfigList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '外部知识库', + 'type' => 'array', + 'items' => [ + 'description' => '外部知识库结构', + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'description' => '接入类型。'."\n" + ."\n" + .'- mcp：MCP方式接入', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['mcp' => 'MCP方式接入'], + 'example' => 'mcp', + ], + 'McpServerId' => ['description' => 'MCP Server 的 Id', 'type' => 'string', 'required' => false, 'example' => 'nhdpt9adf6ac**********ca'], + 'KbUuid' => ['type' => 'string'], + ], + 'required' => false, + ], 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '20', - 'default' => '10', ], ], [ - 'name' => 'NextToken', + 'name' => 'ExecutionConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '下一次查询的令牌（Token）。', - 'type' => 'string', + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => ['description' => '是否跳过计划确认步骤', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipSqlConfirm' => ['description' => '是否跳过所有SQL确认', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipWebReportConfirm' => ['description' => '是否跳过绘制网页报告确认', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipAskHuman' => ['description' => '是否禁止过程中用户询问', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'f056501ada12****', ], ], [ - 'name' => 'PageIndex', + 'name' => 'ScheduleTaskConfig', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'description' => '当前页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '周期运行任务配置', + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => ['description' => '参考的历史会话 id', 'type' => 'string', 'required' => false, 'example' => '4m24*****mg7j2v'], + 'CronExpression' => ['description' => '时间周期调度的 Cron 表达式', 'type' => 'string', 'required' => false, 'example' => '0 0 0 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'required' => false, 'example' => '分析一下这份数据，给出简报'], + ], 'required' => false, - 'example' => '1', ], ], [ - 'name' => 'Skip', + 'name' => 'TextReportConfig', + 'in' => 'query', + 'schema' => ['description' => '文字报告格式', 'type' => 'string', 'required' => false, 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + ], + [ + 'name' => 'WebReportConfig', 'in' => 'query', + 'schema' => ['description' => '网页报告格式', 'type' => 'string', 'required' => false, 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + ], + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'CallbackConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '跳过n条记录，用于分页。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], ], ], + [ + 'name' => 'RelatedSessionId', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'title' => '拒接访问的信息', - 'description' => '拒接访问的信息。', - 'type' => 'string', - 'example' => 'NOT_FOUND', - ], - 'Root' => [ - 'title' => '数据详情', - 'description' => '数据详情。', + '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' => [ - 'List' => [ - 'title' => '数据列表', - 'description' => '数据列表。', + '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' => 'NEW', + ], + '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' => '20923*****7291'], + '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' => [ + 'description' => '外部知识库', 'type' => 'array', 'items' => [ + 'description' => '外部知识库结构', '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启动时加载的脚本目录。', + 'AccessType' => [ + 'description' => '接入类型。'."\n" + ."\n" + .'- mcp：MCP方式接入', 'type' => 'string', - 'example' => 'default/startup.sh', + 'enumValueTitles' => ['mcp' => 'MCP方式接入'], + 'example' => 'mcp', ], + 'McpServerId' => ['description' => 'MCP Server 的 Id', 'type' => 'string', 'example' => 'nhdpt9adf6ac**********ca'], + 'KbUuid' => ['type' => 'string'], ], ], ], - 'TotalCount' => [ - 'description' => '符合条件的Airflow总数据量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'ExecutionConfig' => [ + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => ['description' => '是否跳过计划确认步骤', 'type' => 'boolean', 'example' => 'true'], + 'SkipSqlConfirm' => ['description' => '是否跳过所有SQL确认', 'type' => 'boolean', 'example' => 'true'], + 'SkipWebReportConfirm' => ['description' => '是否跳过绘制网页报告确认', 'type' => 'boolean', 'example' => 'true'], + 'SkipAskHuman' => ['description' => '是否禁止过程中用户询问', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'TextReportConfig' => ['description' => '文字报告格式', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + 'WebReportConfig' => ['description' => '网页报告格式', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + 'CreatorUserName' => ['description' => '创建者名称', 'type' => 'string', 'example' => 'HaoY*****'], + 'ModifierUserName' => ['description' => '修改者名称', 'type' => 'string', 'example' => 'HaoY*****'], + 'DMSUnit' => ['description' => '当前DMS单元', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'IsScheduleTask' => ['description' => '是否配置周期运行任务', 'type' => 'boolean', 'example' => 'false'], + 'NextRuntime' => ['description' => '周期任务下次运行时间'."\n" + .'- 时间戳格式', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200'], + 'ScheduleTaskConfig' => [ + 'description' => '周期任务配置', + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => ['description' => '参考的历史会话 id', 'type' => 'string', 'example' => '4m24*****mg7j2v'], + 'CronExpression' => ['description' => '时间周期调度的 Cron 表达式', 'type' => 'string', 'example' => '0 0 0 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'example' => '分析一下这份数据，给出简报'], + ], + ], + 'CallbackConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], ], + 'RelatedSessionId' => ['type' => 'string'], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建自定义Agent', + 'summary' => '在个人空间、工作空间中创建自定义Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"NEW\\",\\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\\": \\"20923*****7291\\",\\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 \\"KnowledgeConfigList\\": [\\n {\\n \\"AccessType\\": \\"mcp\\",\\n \\"McpServerId\\": \\"nhdpt9adf6ac**********ca\\",\\n \\"KbUuid\\": \\"\\"\\n }\\n ],\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": true,\\n \\"SkipAskHuman\\": true\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\",\\n \\"DMSUnit\\": \\"cn-hangzhou\\",\\n \\"IsScheduleTask\\": false,\\n \\"NextRuntime\\": 1767715200,\\n \\"ScheduleTaskConfig\\": {\\n \\"RelatedSessionId\\": \\"4m24*****mg7j2v\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1-7\\",\\n \\"Query\\": \\"分析一下这份数据，给出简报\\"\\n },\\n \\"CallbackConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ToolId\\": \\"\\",\\n \\"CallbackPrompt\\": \\"\\",\\n \\"CallbackArgs\\": \\"\\",\\n \\"CallbackTime\\": 0\\n },\\n \\"RelatedSessionId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'CreateDataAgentAccuracyTest' => [ + 'summary' => '创建准确率自测实例', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。', - 'type' => 'string', - 'required' => false, - 'example' => 'token-****', - ], + 'schema' => ['description' => '数据中心中的FileId', 'type' => 'string', 'required' => false, 'example' => 'f-xxxxxxxxxxxxxxxxxxxx'], ], [ - 'name' => 'AirflowId', + 'name' => 'CustomAgentId', 'in' => 'query', - 'schema' => [ - 'description' => 'Airflow的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'af-test****', - ], + 'schema' => ['description' => '需要准确率测试的自定义agentId', 'type' => 'string', 'required' => false, 'example' => 'ca-xxxxxxxxxxxxxxxxxxxx'], + ], + [ + 'name' => 'Dataset', + 'in' => 'query', + 'schema' => ['description' => '数据源（推荐在自定义agent中配置）', 'type' => 'string', 'required' => false, 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxx49\\",\\"DmsDatabaseId\\":\\"75xxx6\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]'], + ], + [ + 'name' => 'EvaluationPrompt', + 'in' => 'query', + 'schema' => ['description' => '准确率评判标准（空表示默认标准）', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => ['description' => '分析模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '86302423828****', - ], + 'schema' => ['description' => '协作空间 ID', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxxxxxxxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DmsUnit', + 'in' => 'query', + 'schema' => ['description' => '创建资源使用的dmsUnit', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => '分析任务所用语言', 'type' => 'string', 'required' => false, 'example' => 'ENGLISH'], + ], + [ + 'name' => 'MaxConcurrent', + 'in' => 'query', + 'schema' => ['description' => '测试中最大并发会话数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'NeedDelete', + 'in' => 'query', + 'schema' => ['description' => '分析后会话是否展示（暂不支持）', 'type' => 'boolean', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '测试项名称', 'type' => 'string', 'required' => false, 'example' => 'Test01'], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E0D21075-CD3E-4D98-8264-****', - ], - 'AccessDeniedDetail' => [ - 'description' => '权限校验失败详情。', - 'type' => 'string', - 'example' => 'NOT_FOUND', - ], - 'Root' => [ - 'description' => '删除实例的详情。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A61C2009-xxx-BE7E95CEDF2F'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息', 'type' => 'string', 'example' => 'UnknownError'], + 'Data' => [ + '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", - ], - ], - ], - ], + 'AccuracyTestInsId' => ['description' => '准确率测试实例ID', 'type' => 'string', 'example' => 'at-xxxxxxxxxxxxxxxxxxxx'], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建准确率测试实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A61C2009-xxx-BE7E95CEDF2F\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Data\\": {\\n \\"AccuracyTestInsId\\": \\"at-xxxxxxxxxxxxxxxxxxxx\\"\\n }\\n}","type":"json"}]', + ], + 'CreateDataAgentKnowledgeBase' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249748', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DMSUnit', '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', - ], + 'schema' => ['description' => '当前DMS单元。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SearchKey', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '搜索数据库名称的关键字。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '8i5tw7omgaax*********n909jid'], ], [ - 'name' => 'Tid', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '知识库的名称。', 'type' => 'string', 'required' => true, 'example' => 'KnowledgeBaseTest'], ], [ - 'name' => 'NextToken', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '知识库的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'KnowledgeBaseTest'], + ], + [ + 'name' => 'FromKbUuid', 'in' => 'query', + 'schema' => ['description' => '从行业知识库构建的知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'kb-HZ-ra99********ss0xp1bku'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', + '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' => 'InvalidTid'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.'], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['description' => '知识库ID', 'type' => 'string', 'example' => 'kb-HZ-ra99akg0t*********1bku'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建DataAgent知识库', + 'summary' => '创建DataAgent知识库。知识库的创建人拥有有读写操作权限，空间内的其他成员拥有使用权限。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"kb-HZ-ra99akg0t*********1bku\\"\\n }\\n}","type":"json"}]', + ], + 'CreateDataAgentSession' => [ + 'summary' => '创建DataAgent会话', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MaxResults', + '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' => [ - 'description' => '分页大小。最大值为100。', - 'type' => 'integer', - 'format' => 'int32', + '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, + ], + 'KbUuidList' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'UserOssBucket' => ['description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', 'type' => 'string', 'required' => false, 'example' => 'user-oss-bucket'], + 'EncryptType' => ['title' => '加密方式', 'type' => 'string'], + 'EncryptKey' => ['title' => '加密秘钥', 'type' => 'string'], + 'ReportWaterMark' => ['title' => '报告水印', 'type' => 'string'], + 'ReportPageWidth' => ['title' => '报告页面宽度', 'type' => 'integer', 'format' => 'int64'], + ], 'required' => false, - 'minimum' => '0', - 'example' => '20', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -2898,133 +2487,126 @@ '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', + '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'], + ], + 'KbUuidList' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'UserOssBucket' => ['description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', 'type' => 'string', 'example' => 'user-oss-bucket'], + 'EncryptType' => ['title' => '加密类型', 'type' => 'string'], + 'EncryptKey' => ['title' => '加密密钥', 'type' => 'string'], + 'ReportWaterMark' => ['title' => '报告水印', 'type' => 'string'], + 'ReportPageWidth' => ['title' => '报告页面宽度', 'type' => 'integer', 'format' => 'int64'], + ], + ], + 'CreateTime' => ['description' => '会话的创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1765262307992'], + 'Saved' => ['description' => '是否被当前登录人收藏', 'type' => 'boolean', 'example' => 'false'], ], ], - 'NextToken' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。', - 'type' => 'string', - 'example' => 'NesLoKLEdIZrKhDT7I2g****', - ], - 'MaxResults' => [ - 'description' => '限定每次返回的最大条数，可以和NextToken搭配使用实现翻页能力。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建DataAgent会话', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖的数据库列表', + '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 \\"KbUuidList\\": [\\n \\"\\"\\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"}]', ], - 'GetDataLakeDatabase' => [ - 'summary' => '调用此API可以获取数据湖中的数据库信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataAgentWorkspace' => [ + 'summary' => '创建DataAgent协作空间', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249583', - 'abilityTreeNodes' => [ - 'FEATUREdms25Q07S', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Name', + 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '协作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspaceTest'], ], [ - 'name' => 'Tid', + 'name' => 'WorkspaceDesc', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + 'schema' => ['description' => '协作空间描述', 'type' => 'string', 'required' => false, 'example' => 'Space for test'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'IsSessionShareEnabled', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '空间内会话是否共享', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -3034,106 +2616,114 @@ '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', + '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'], + 'IsSessionShareEnabled' => ['description' => '是否支持空间内会话共享', 'type' => 'boolean', 'example' => 'true'], + 'Type' => ['description' => '空间类型(personal:个人空间，common/null:多人协作空间)', 'type' => 'string', 'example' => 'personal/common'], + ], ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建协作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => ' 获取数据湖的数据库信息', + '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 \\"IsSessionShareEnabled\\": true,\\n \\"Type\\": \\"personal/common\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"DMS-DA-40114\\",\\n \\"ErrorMessage\\": \\"Specified parameter is not valid.\\"\\n}","type":"json"}]', ], - 'ListDataLakeCatalog' => [ - 'summary' => '调用此API可以获取数据湖的数据目录列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataLakeDatabase' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'SearchKey', + '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' => 'string', + 'description' => '数据库属性的键值对。', + 'type' => 'object', 'required' => false, - 'docRequired' => true, - 'example' => 'hive', + 'additionalProperties' => ['type' => 'string', 'example' => '{"key":"value"}', 'description' => '参数key和value。'], ], ], [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3143,72 +2733,44 @@ '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', - ], - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建湖仓数据库', + 'summary' => '调用此API可新建湖仓数据库。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '获取数据湖的数据目录列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetDataLakeCatalog' => [ - 'summary' => '调用此API可以获取数据湖的数据目录。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataLakeFunction' => [ + 'summary' => '调用此API可以新建湖仓自定义函数。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249777', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3216,37 +2778,29 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hive', - ], + '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，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3256,150 +2810,105 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新建数据湖自定义函数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖的数据目录', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE214ECD-4330-503A-82F0-FFB03975****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"my_funciton\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"CreateTime\\": 1731586286,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar\\"\\n }\\n ],\\n \\"ClassName\\": \\"com.example.hive.MyCustomUDF\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', ], - 'ListDataLakeTablebaseInfo' => [ - 'summary' => '调用此API可以获取数据湖中表的基本信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataLakePartition' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249769', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Rows', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页的行数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'Page', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时列表的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'SearchKey', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '搜索表名称的关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], ], [ - 'name' => 'DbName', + 'name' => 'PartitionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => '新增分区的信息。', 'required' => true, '$ref' => '#/components/schemas/DLPartitionInput'], + ], + [ + 'name' => 'IfNotExists', 'in' => 'query', - 'schema' => [ - 'description' => '表所在的数据库的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '当新增的分区名称与已有的分区名称重复，是否忽略该异常。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'CatalogName', + 'name' => 'NeedResult', 'in' => 'query', - 'schema' => [ - 'description' => '查询的数据目录名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '是否需要返回新建的分区信息，为**true**时结果会返回Partition。取值：'."\n" + ."\n" + .'- **true**：返回新建的分区信息。'."\n" + ."\n" + .'- **false**：不返回新建的分区信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3409,77 +2918,58 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建湖仓表分区', + 'summary' => '调用此API可新建湖仓表分区。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖中表的基本信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Partition\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n },\\n \\"CreateTime\\": 1735109884,\\n \\"Values\\": [\\n \\"part_val1\\"\\n ],\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"LastAccessTime\\": 1608707407\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetDataLakeTable' => [ - 'summary' => '调用此API可以获取数据湖的表信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataLakeTable' => [ + 'summary' => '调用此API可新建湖仓表。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249771', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3487,59 +2977,29 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '表所在的数据库的名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '表名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100g_customer', - ], + 'name' => 'TableInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => '表的信息。', 'required' => true, '$ref' => '#/components/schemas/DLTableInput'], ], [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3549,163 +3009,308 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新建湖仓表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖的表信息', + '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\\": \\"zhangsan\\",\\n \\"TableType\\": \\"EXTERNAL_TABLE\\",\\n \\"Parameters\\": {\\n \\"EXTERNAL\\": \\"TRUE\\",\\n \\"delta.minReaderVersion\\": \\"1\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 1731586286,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"LastAccessTime\\": 1608707407,\\n \\"Retention\\": 300,\\n \\"Name\\": \\"100g_customer\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ViewExpandedText\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DbId\\": 19,\\n \\"DbName\\": \\"default\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"ModifierId\\": 1410769,\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n}","type":"json"}]', ], - 'BatchCreateDataLakePartitions' => [ - 'summary' => '调用此API可批量新建湖仓表分区。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteAirflow' => [ + 'summary' => '删除Airflow实例。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '客户端Token，用于保证请求的幂等性。', 'type' => 'string', 'required' => false, 'example' => 'token-****'], ], [ - 'name' => 'DbName', + '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' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + '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'], + ], ], ], + ], + 'title' => '删除Airflow实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'DeleteCustomAgent' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + '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' => true, 'example' => 'ca-4y3ca4khkcu**********ysf'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', + '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'], + 'Success' => ['description' => '删除是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '删除操作的信息', 'type' => 'string', 'example' => 'Custom agent successfully deleted'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除自定义Agent', + 'summary' => '在个人空间、工作空间中删除自定义Agent'."\n" + .'注意：只有新建、已下线状态的自定义Agent才可以删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ [ - 'name' => 'PartitionInputs', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '新增分区的信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据湖分区信息。', - 'required' => false, - '$ref' => '#/components/schemas/DLPartitionInput', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => true, ], ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"Custom agent successfully deleted\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteDataAgentAccuracyTest' => [ + 'summary' => '删除准确率测试配置项', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'IfNotExists', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '若新增的分区名称与已有的分区名称重复，是否忽略该异常。取值：'."\n" - ."\n" - .'- **true**：忽略。'."\n" - ."\n" - .'- **false**：不忽略。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], ], [ - 'name' => 'NeedResult', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要返回分区信息，为**true**时结果会返回Partitions。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'Tid', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DmsUnit', 'in' => 'query', + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', + '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' => 'E0D21075-xxx-FD8AD04A63B6'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'UnknownError'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除准确率测试项', + 'description' => '删除准确率测试项', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-xxx-FD8AD04A63B6\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]', + ], + 'DeleteDataAgentKnowledgeBase' => [ + 'summary' => '删除DataAgent知识库。', + 'path' => '', + 'methods' => ['post'], + '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'], + ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '2dl4opo5vbh*******frxfsmw'], + ], + [ + 'name' => 'KbUuid', + 'in' => 'query', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-HZ-rtl5lwx********q32d3ux'], ], ], 'responses' => [ @@ -3715,58 +3320,94 @@ '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', + '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' => 'InvalidTid'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.'], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'kb-HZ-rtl5lwx********q32d3ux'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除DataAgent知识库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '批量新建湖仓表分区', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"kb-HZ-rtl5lwx********q32d3ux\\"\\n }\\n}","type":"json"}]', ], - 'UpdateDataLakeTable' => [ - 'summary' => '调用此API可更新湖仓表信息。', + 'DeleteDataAgentWorkspace' => [ + 'summary' => '删除DataAgent协作空间', 'path' => '', - 'methods' => [ - 'post', - 'get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + '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'], + 'title' => '删除协作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'DeleteDataLakeDatabase' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3775,12 +3416,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3788,65 +3427,110 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + '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' => 'Tid', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', + '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'], + 'title' => '删除湖仓数据库', + 'summary' => '调用此API可删除湖仓数据库。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataLakeFunction' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableName', + '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' => '被更新表的名称。若无需更新表名，则与TableInput的Name保持一致即可。', - 'type' => 'string', - 'required' => false, - 'example' => '100g_customer', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3856,53 +3540,32 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除湖仓自定义函数', + 'summary' => '调用此API可删除湖仓自定义函数。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '更新湖仓表信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateDataLakePartition' => [ - 'summary' => '调用此API可更新湖仓表分区信息。', + 'DeleteDataLakePartition' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3911,12 +3574,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3924,65 +3585,44 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_name', - ], + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_name'], ], [ - 'name' => 'PartitionInput', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'PartitionValues', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '新增分区的信息。', + 'description' => '分区值列表。', + 'type' => 'array', + 'items' => ['description' => '分区列的值。', 'type' => 'string', 'required' => false, 'example' => 'part_val1'], 'required' => true, - '$ref' => '#/components/schemas/DLPartitionInput', ], ], [ + '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****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -3992,50 +3632,32 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除湖仓表分区', + 'summary' => '调用此API可删除湖仓表分区。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '更新湖仓表分区信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateDataLakeDatabase' => [ - 'summary' => '调用此API可更新湖仓数据库信息。', + 'DeleteDataLakeTable' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4044,12 +3666,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -4057,79 +3677,171 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Description', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '表名。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], ], [ - 'name' => 'Location', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '数据库存储路径。支持oss、s3、s3a。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://path/to/database', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3****'], ], [ - 'name' => 'Parameters', + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库属性的键值对。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"key":"value"}'."\n", - 'description' => '参数key和value。', + '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'], + 'title' => '删除湖仓表', + 'summary' => '调用此API可删除湖仓表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAE66****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDocument' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Tid', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => ['description' => '删除是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'."\n"], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除文档', + 'summary' => '删除文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\\\n\\"\\n}","type":"json"}]', + ], + 'DeleteDocumentChunks' => [ + 'summary' => '删除知识块', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + [ + 'name' => 'ChunkIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', + 'description' => '知识库ID列表。', + 'type' => 'array', + 'items' => ['description' => '知识块ID。', 'type' => 'string', 'required' => false, 'example' => '52b00647-7065-4ad8-ac51-9cf7e762415****'], + 'required' => true, ], ], ], @@ -4140,172 +3852,201 @@ '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => ['description' => '返回删除的知识块数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除知识块', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '更新湖仓数据库信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', ], - 'ListDataLakeTableName' => [ - 'summary' => '调用此API可获取数据湖表名列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteFileUpload' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'Tid', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'CatalogName', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '文件ID', 'type' => 'string', 'required' => true, 'example' => 'f-8*******01m'."\n"], ], [ - 'name' => 'DbName', + 'name' => 'CallFrom', 'in' => 'query', + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => 'TrailCenter'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + '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'], + 'title' => '删除上传文件', + 'summary' => 'DeleteFileUpload', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'DeleteWorkspaceCode' => [ + 'summary' => '删除工作空间代码以及目录', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableNamePattern', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据表名称匹配正则表达式。', - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12****'], ], [ - 'name' => 'NextToken', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', - ], + 'schema' => ['description' => '代码的完整路径，注意/Workspace/code/ 前缀', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb'], ], [ - 'name' => 'MaxResults', + 'name' => 'Repo', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。最大值为100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '20', - ], + 'schema' => ['description' => '仓库信息。', 'type' => 'string', 'required' => false, 'example' => 'database/adb'], ], [ - 'name' => 'TableType', + 'name' => 'Symlink', 'in' => 'query', + 'schema' => ['description' => '是否是symlink的文件', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'InvalidTid'], + 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- True：请求成功。 '."\n" + .'- False：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除工作空间的代码及目录', + 'description' => '发布工作空间的代码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeCustomAgent' => [ + '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' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + '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' => [ @@ -4315,188 +4056,446 @@ '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', + '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'], + 'KbUuid' => ['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' => ['type' => 'string', 'example' => 'cn-hangzhou'], + 'IsScheduleTask' => ['description' => '是否配置周期运行任务', 'type' => 'boolean', 'example' => 'true'], + 'NextRuntime' => ['description' => '周期任务下次运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200'], + 'ScheduleTaskConfig' => [ + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => ['description' => '参考的历史会话id', 'type' => 'string', 'example' => '4m24*****mg7j2v'], + 'CronExpression' => ['description' => '时间周期调度的Cron表达式', 'type' => 'string', 'example' => '0 0 0 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'example' => '分析一下这份数据，给出简报'], + ], + 'description' => '', + ], + 'CallbackConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'RelatedSessionId' => ['type' => 'string', 'example' => '5xyz...'], ], ], - 'NextToken' => [ - 'description' => '令牌（Token）信息。', - 'type' => 'string', - 'example' => 'NesLoKLEdIZrKhDT7I2gS****', - ], - 'MaxResults' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取自定义Agent详细描述', + 'summary' => 'DescribeCustomAgent 根据自定义Agent ID获取详情描述信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖表名列表', + '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 \\"KnowledgeConfigList\\": [\\n {\\n \\"AccessType\\": \\"\\",\\n \\"McpServerId\\": \\"\\",\\n \\"KbUuid\\": \\"\\"\\n }\\n ],\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": false,\\n \\"SkipAskHuman\\": false\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"DefaultAgent\\": 0,\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\",\\n \\"DMSUnit\\": \\"cn-hangzhou\\",\\n \\"IsScheduleTask\\": true,\\n \\"NextRuntime\\": 1767715200,\\n \\"ScheduleTaskConfig\\": {\\n \\"RelatedSessionId\\": \\"4m24*****mg7j2v\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1-7\\",\\n \\"Query\\": \\"分析一下这份数据，给出简报\\"\\n },\\n \\"CallbackConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ToolId\\": \\"\\",\\n \\"CallbackPrompt\\": \\"\\",\\n \\"CallbackArgs\\": \\"\\",\\n \\"CallbackTime\\": 0\\n },\\n \\"RelatedSessionId\\": \\"5xyz...\\"\\n }\\n}","type":"json"}]', ], - 'ListDataLakeTable' => [ - 'summary' => '调用此API可获取数据湖表列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeDataAgentSession' => [ + 'summary' => '获取DataAgent会话描述信息', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Tid', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CatalogName', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => 'DataAgent会话ID，可通过CreateDataAgentSession获取。', 'type' => 'string', 'required' => false, 'example' => 'c61n7gm******rj'], ], [ - 'name' => 'DbName', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + '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'], + ], + 'KbUuidList' => [ + 'description' => '本次会话的知识库ID列表', + 'type' => 'array', + 'items' => ['description' => '单个知识库ID', 'type' => 'string', 'example' => 'asdf****zsdv'], + ], + 'UserOssBucket' => ['description' => '用户OSS Bucket名称'."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', 'type' => 'string', 'example' => 'user-oss-bucket'], + 'EncryptType' => ['title' => '加密类型', 'description' => '产物存放到OSS（含内置和用户）的加密类型', 'type' => 'string', 'example' => 'null'], + 'EncryptKey' => ['title' => '加密秘钥', 'description' => '产物存放到OSS（含内置和用户）的加密秘钥，通常在CreateDataAgentSession中指定', 'type' => 'string', 'example' => 'ay***1Te'], + 'ReportWaterMark' => ['title' => '报告水印', 'description' => '报告水印', 'type' => 'string', 'example' => '""'], + 'ReportPageWidth' => ['title' => '报告页面宽度', 'description' => '报告页面宽度', 'type' => 'integer', 'format' => 'int64', 'example' => '300mm'], + ], + ], + '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******'], + 'Artifacts' => [ + 'description' => '会话产出的产物列表。当前只包含报告。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '产物ID，全局唯一。如果是通过SendChatMessage指定MessageType为REPORT产出的报告，则产物ID会和SendChatMessage接口返回值中的MessageId保持一致。', 'type' => 'string', 'example' => 'bab******33e1'], + 'Type' => ['description' => '产物类型。当前可能为：[TextReport, WebReport]', 'type' => 'string', 'example' => 'WebReport'], + 'Status' => ['description' => '产物状态。当前可能为如下枚举之一：'."\n" + ."\n" + .'- PENDING，表示后端已收到任务，尚未启动'."\n" + ."\n" + .'- RUNNING，表示后端已启动任务，尚未完成'."\n" + ."\n" + .'- SUCCESS，表示任务已成功，可在LIstFileUpload接口中查询到文件信息'."\n" + ."\n" + .'- FAILED，表示任务已失败', 'type' => 'string', 'example' => 'PENDING'], + 'Name' => ['description' => '产物名称，通常为工程拼接的字符串，会和LIstFileUpload接口的name字段对齐，可以通过该字段关联查询到产物文件的下载链接。', 'type' => 'string', 'example' => 'report_****_2026****'], + 'Description' => ['description' => '产物的简要描述，可能为空。', 'type' => 'string', 'example' => 'a simple report'], + 'ReceiveTime' => ['description' => '后端收到该产物请求的时间，UNIX时间戳，精确到秒', 'type' => 'string', 'example' => '1778743587'], + 'StartTime' => ['description' => '后端实际开始运行该产物任务的时间。UNIX时间戳，精确到秒', 'type' => 'string', 'example' => '1778743587'], + 'FinishTime' => ['description' => '后端完成该产物任务的时间。UNIX时间戳，精确到秒', 'type' => 'string', 'example' => '1778743587'], + ], + 'description' => '', + ], + ], + 'DataSources' => [ + 'description' => '当前会话用到的数据源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => '数据源来源。当前包含如下枚举'."\n" + ."\n" + .'- **CHAT**: 来自对话中通过CreateDataAgentSession或SendChatMessage接口指定'."\n" + ."\n" + .'- **CUSTOM_AGENT**: 来自自定义Agent中预设的分析数据范围'."\n", 'type' => 'string', 'example' => 'CHAT'], + 'Detail' => ['description' => '数据源详情。'."\n" + ."\n" + .'当Category是CHAT或者CUSTOM_AGENT的时候，Detail的结构和SendChatMessage接口的DataSources中单个元素的结构是对齐的。', 'type' => 'string', 'example' => '{}'], + ], + 'description' => '', + ], + ], + 'RecallResults' => [ + 'description' => '本次会话在知识库、记忆召回的结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '召回知识类别', 'type' => 'string', 'example' => 'memory'], + 'Content' => ['description' => '召回知识块内容', 'type' => 'string', 'example' => 'sky is blue'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', 'type' => 'number', 'format' => 'double', 'example' => '0.65'], + ], + 'description' => '', + ], + ], + ], + ], + 'Success' => ['description' => '返回值说明。'."\n" + ."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'success'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'UnknownError'], + ], ], ], - [ - 'name' => 'TableNamePattern', - 'in' => 'query', - 'schema' => [ - 'description' => '元数据表名称，正则表达式匹配。', - 'type' => 'string', - 'required' => false, - 'example' => '.*', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取DataAgent会话描述', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:DescribeDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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 \\"KbUuidList\\": [\\n \\"asdf****zsdv\\"\\n ],\\n \\"UserOssBucket\\": \\"user-oss-bucket\\",\\n \\"EncryptType\\": \\"null\\",\\n \\"EncryptKey\\": \\"ay***1Te\\",\\n \\"ReportWaterMark\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReportPageWidth\\": 0\\n },\\n \\"CreateTime\\": 1731645908000,\\n \\"Saved\\": true,\\n \\"FavoriteInWorkspace\\": \\"true\\",\\n \\"UserId\\": \\"2096******\\",\\n \\"Artifacts\\": [\\n {\\n \\"Id\\": \\"bab******33e1\\",\\n \\"Type\\": \\"WebReport\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"Name\\": \\"report_****_2026****\\",\\n \\"Description\\": \\"a simple report\\",\\n \\"ReceiveTime\\": \\"1778743587\\",\\n \\"StartTime\\": \\"1778743587\\",\\n \\"FinishTime\\": \\"1778743587\\"\\n }\\n ],\\n \\"DataSources\\": [\\n {\\n \\"Category\\": \\"CHAT\\",\\n \\"Detail\\": \\"{}\\"\\n }\\n ],\\n \\"RecallResults\\": [\\n {\\n \\"Type\\": \\"memory\\",\\n \\"Content\\": \\"sky is blue\\",\\n \\"Score\\": 0.65\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]', + ], + 'DescribeDocument' => [ + 'summary' => '查看文档详细信息', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableType', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'kb-***'], + 'Name' => ['description' => '文档名称。', 'type' => 'string', 'example' => 'test.md'], + 'Description' => ['description' => '文档描述。', 'type' => 'string', 'example' => 'abc'], + 'FileExt' => ['description' => '文档扩展类型。', 'type' => 'string', 'example' => 'md'], + 'DocumentLoaderName' => ['description' => '文档加载器名称。', 'type' => 'string', 'example' => 'ADBPGLoader'], + 'TextSplitterName' => ['description' => '文档分词器名称。', 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter'], + 'FileSize' => ['description' => '文档大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '20307'], + 'DocsCount' => ['description' => '知识块数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'State' => ['description' => '文档状态，返回值如下：'."\n" + ."\n" + .'- **0**：文档解析完成。'."\n" + .'- **-1**：文档未解析。'."\n" + .'- **-2**：文档解析中。'."\n" + .'- **-3**：文档解析失败。'."\n" + .'- **-4**：文档解析取消。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GmtCreate' => ['description' => '文档创建时间。', 'type' => 'string', 'example' => '2026-04-22 22:59:35'], + 'GmtModified' => ['description' => '文档修改时间。', 'type' => 'string', 'example' => '2026-04-24 21:22:53'], + 'Summary' => ['description' => '文档摘要。', 'type' => 'string', 'example' => 'This is a test document.'], + 'Keywords' => ['description' => '文档关键词。', 'type' => 'string', 'example' => '["test","abc"]'], + ], + ], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'."\n"], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看文档详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"kb-***\\",\\n \\"Name\\": \\"test.md\\",\\n \\"Description\\": \\"abc\\",\\n \\"FileExt\\": \\"md\\",\\n \\"DocumentLoaderName\\": \\"ADBPGLoader\\",\\n \\"TextSplitterName\\": \\"ChineseRecursiveTextSplitter\\",\\n \\"FileSize\\": 20307,\\n \\"DocsCount\\": 123,\\n \\"State\\": 0,\\n \\"GmtCreate\\": \\"2026-04-22 22:59:35\\",\\n \\"GmtModified\\": \\"2026-04-24 21:22:53\\",\\n \\"Summary\\": \\"This is a test document.\\",\\n \\"Keywords\\": \\"[\\\\\\"test\\\\\\",\\\\\\"abc\\\\\\"]\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\\\n\\"\\n}","type":"json"}]', + ], + 'DescribeFileUploadSignature' => [ + 'summary' => 'DescribeFileUploadSignature', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NextToken', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'MaxResults', + 'name' => 'CallFrom', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。最大值为100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '20', - ], + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => '仅前端使用'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -4506,166 +4505,233 @@ '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', + '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**********'], ], ], - 'NextToken' => [ - 'description' => '令牌（Token）信息。', - 'type' => 'string', - 'example' => 'NesLoKLEdIZrKhDT7I2gS****', - ], - 'MaxResults' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取文件上传签名信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeFileUploadSignature', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖表列表', + '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"}]', ], - 'ListDataLakePartitionName' => [ - 'summary' => '调用此API可获取数据湖表分区名列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeKnowledgeBaseStats' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'Tid', + 'name' => 'KbUuid', 'in' => 'query', + 'schema' => ['title' => '知识库uuid', 'description' => '知识库ID', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => [ + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'KbUuid' => ['title' => '知识库uuid', 'description' => '知识库ID', 'type' => 'string', 'example' => 'kb-***'], + 'TotalFileSize' => ['description' => '知识库中的文件总大小，单位：字节', 'type' => 'integer', 'format' => 'int64', 'example' => '4194588751'], + 'DocumentCount' => ['title' => '知识库文档数', 'description' => '知识库文档数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalChunkCount' => ['title' => '知识库总知识块数目', 'description' => '知识库总知识块数目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'KbHits' => ['title' => '知识库命中数', 'description' => '知识库命中数', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + ], + ], + 'Success' => ['description' => '请求是否成功，返回值如下：true：请求成功 false：请求失败', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'Permission denied.'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Knowledge base limit exceeded. Current: xxx'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取知识库的统计信息', + 'summary' => '获取知识库的统计信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"kb-***\\",\\n \\"TotalFileSize\\": 4194588751,\\n \\"DocumentCount\\": 100,\\n \\"TotalChunkCount\\": 10,\\n \\"KbHits\\": 18\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Permission denied.\\",\\n \\"ErrorMessage\\": \\"Knowledge base limit exceeded. Current: xxx\\"\\n}","type":"json"}]', + ], + 'DescribeKnowledgeBaseUploadSignature' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'KbUuid', 'in' => 'query', + 'schema' => ['description' => '知识库ID', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + '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' => '文件上传权限限制和约束条件（Base64）', 'type' => 'string', 'example' => 'eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aRmR2RDJRWlFSeWlwZmpkS295NEYxb2ovMjAyNjA1MTQvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjA1MTRUMDMzMjI3WiJ9LHsieC1vc3Mtc2VjdXJpdHktdG9rZW4iOiJDQUlTMmdKMXE2RnQ1QjJ5ZlNqSXI1bnpMOHp3MzQ1NzVwQ1NhMWJYam1RZVkvWVlxZlRFaUR6MklIaE1**'], + 'UploadHost' => ['description' => '文件上传的目标地址', 'type' => 'string', 'example' => 'https://onemeta-kb-staging.oss-cn-hangzhou.aliyuncs.com'], + 'UploadDir' => ['description' => '文件上传的路径前缀', 'type' => 'string', 'example' => 'knowledge_base/1666698***/kb-***'], + ], + ], + 'Success' => ['description' => '请求是否成功，返回值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found xxx'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取知识库上传文档的签名', + 'summary' => '获取知识库上传文档的签名', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\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\\": \\"eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aRmR2RDJRWlFSeWlwZmpkS295NEYxb2ovMjAyNjA1MTQvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjA1MTRUMDMzMjI3WiJ9LHsieC1vc3Mtc2VjdXJpdHktdG9rZW4iOiJDQUlTMmdKMXE2RnQ1QjJ5ZlNqSXI1bnpMOHp3MzQ1NzVwQ1NhMWJYam1RZVkvWVlxZlRFaUR6MklIaE1**\\",\\n \\"UploadHost\\": \\"https://onemeta-kb-staging.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"UploadDir\\": \\"knowledge_base/1666698***/kb-***\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found xxx\\"\\n}","type":"json"}]', + ], + 'FileUploadCallback' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DbName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'TableName', + 'name' => 'Filename', 'in' => 'query', - 'schema' => [ - 'description' => '表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_name', - ], + 'schema' => ['description' => '文件名称', 'type' => 'string', 'required' => true, 'example' => 'conversion_metrics.csv'], ], [ - 'name' => 'NextToken', + 'name' => 'UploadLocation', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', - ], + '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' => 'MaxResults', + 'name' => 'FileSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。最大值为100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '20', - ], + 'schema' => ['description' => '文件大小，单位为字节', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8110'], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => 'TrailCenter'], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -4675,69 +4741,149 @@ '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', + '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"], ], ], - 'NextToken' => [ - 'description' => '令牌（Token）信息。', - 'type' => 'string', - 'example' => 'NesLoKLEdIZrKhDT7I2gS****', - ], - 'MaxResults' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '文件上传后回调', + 'summary' => 'FileUploadCallback', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:FileUploadCallback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取数据湖表分区名列表', + '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"}]', ], - 'ListDataLakePartitionByFilter' => [ - 'summary' => '调用此API可根据筛选条件获取数据湖表分区列表。', - 'methods' => [ - 'post', - 'get', + 'GetAirflow' => [ + '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****'], + ], ], - 'schemes' => [ - 'https', + '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.', 'description' => ''], + ], ], + 'title' => '获取Airflow实例详情', + 'summary' => '查询Airflow实例详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'GetChatContent' => [ + 'summary' => '通过指定会话ID和AgentId，从特定检查点开始获取聊天内容。', + 'path' => '/api/v1/chat/stream', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], @@ -4749,108 +4895,169 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Tid', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + 'schema' => ['description' => '当前所在的DMS单元，阿里云国内站用户默认填入cn-hangzhou。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CatalogName', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '会话 ID，必须字段'."\n", 'type' => 'string', 'required' => false, 'example' => 'sess_12345'], ], [ - 'name' => 'DbName', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'AgentId，必填'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxxx-xxxx'], ], [ - 'name' => 'TableName', + 'name' => 'Checkpoint', 'in' => 'query', + 'schema' => ['description' => '后端将从这个接口开始返回输出'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', + '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'], + 'timestamp' => ['description' => '这条消息在Agent产生的UNIX时间戳，单位为秒', 'type' => 'string', 'example' => '1774578047'], + ], ], ], - [ - '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', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取聊天内容', + 'description' => '## 请求说明'."\n" + .'- 响应将以SSE流的形式返回，其中每个事件都遵循`SSEEvent`模式，包含有关消息级别的元信息等。'."\n" + .'- 每个SSE事件中的`content`字段可能携带实际的消息文本或JSON对象，具体取决于`content_type`的值。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetChatContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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 \\"timestamp\\": \\"1774578047\\"\\n}","type":"json"}]', + ], + 'GetDataAgentSubAccountInfo' => [ + 'summary' => '获取主账号下的子账号信息', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NextToken', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'MaxResults', + 'name' => 'SubAccountId', 'in' => 'query', + 'schema' => ['description' => '子账号的阿里云uid', 'type' => 'string', 'required' => false, 'example' => '20282*****7591'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页大小。最大值为 100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '20', + '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'], + 'title' => '获取主账号下的子账号信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + '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' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '20923*****7291'], ], ], 'responses' => [ @@ -4860,68 +5067,56 @@ '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', + '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'], + 'IsSessionShareEnabled' => ['type' => 'boolean'], + 'Type' => ['type' => 'string'], ], ], - 'NextToken' => [ - 'description' => '令牌（Token）信息。', - 'type' => 'string', - 'example' => 'NesLoKLEdIZrKhDT7I2gS****', - ], - 'MaxResults' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取协作空间详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataAgentWorkspaceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '根据筛选条件获取数据湖表分区列表', + '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 \\"IsSessionShareEnabled\\": true,\\n \\"Type\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'ListDataLakePartition' => [ - 'summary' => '调用此API可获取数据湖表分区列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetDataLakeCatalog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4933,110 +5128,198 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], + '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' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', + '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'], + 'title' => '获取数据湖的数据目录', + 'summary' => '调用此API可以获取数据湖的数据目录。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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\\": \\"init default catalog\\",\\n \\"Name\\": \\"hive\\",\\n \\"Location\\": \\"oss://xxxx\\"\\n }\\n}","type":"json"}]', + ], + 'GetDataLakeDatabase' => [ + '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, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hive'], ], [ - 'name' => 'DbName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'TableName', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'PartNames', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分区名列表。', - 'type' => 'array', - 'items' => [ - 'description' => '分区名。', - 'type' => 'string', - 'required' => false, - 'example' => 'part_1', + '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'], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => ' 获取数据湖的数据库信息', + 'summary' => '调用此API可以获取数据湖中的数据库信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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\\": \\"Default database for catalog hive\\\\n\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 19,\\n \\"CatalogName\\": \\"hive\\",\\n \\"Name\\": \\"default\\",\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n}","type":"json"}]', + ], + 'GetDataLakeFunction' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NextToken', + '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' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'f056501ada12****', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'MaxResults', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。范围在0~100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '20', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -5046,68 +5329,34 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取湖仓自定义函数的详细信息', + 'summary' => '调用此API可获取湖仓自定义函数的详细信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '获取数据湖表分区列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"my_funciton\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"CreateTime\\": 1731586286,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar\\"\\n }\\n ],\\n \\"ClassName\\": \\"com.example.hive.MyCustomUDF\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', ], 'GetDataLakePartition' => [ 'summary' => '调用此API可获取湖仓表分区详情。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5119,9 +5368,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -5129,32 +5376,17 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], ], [ 'name' => 'PartitionValues', @@ -5163,37 +5395,20 @@ 'schema' => [ 'description' => '分区值列表。', 'type' => 'array', - 'items' => [ - 'description' => '分区列的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'part_val1', - ], + '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****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -5203,68 +5418,44 @@ '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', - ], + '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取湖仓表分区详情', - ], - 'DeleteDataLakeTable' => [ - 'summary' => '调用此API可删除湖仓表。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n },\\n \\"CreateTime\\": 1735109884,\\n \\"Values\\": [\\n \\"part_val1\\"\\n ],\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"LastAccessTime\\": 1608707407\\n }\\n}","type":"json"}]', + ], + 'GetDataLakeTable' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249771', + 'abilityTreeNodes' => ['FEATUREdms90TD19'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -5272,55 +5463,27 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '表所在的数据库的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'TableName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => '表名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100g_customer'], ], [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -5330,258 +5493,256 @@ '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', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖的表信息', + 'summary' => '调用此API可以获取数据湖的表信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAE66****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除湖仓表', + '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\\": \\"zhangsan\\",\\n \\"TableType\\": \\"EXTERNAL_TABLE\\",\\n \\"Parameters\\": {\\n \\"EXTERNAL\\": \\"TRUE\\",\\n \\"delta.minReaderVersion\\": \\"1\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 1731586286,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"LastAccessTime\\": 1608707407,\\n \\"Retention\\": 300,\\n \\"Name\\": \\"100g_customer\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ViewExpandedText\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DbId\\": 19,\\n \\"DbName\\": \\"default\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"ModifierId\\": 1410769,\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n}","type":"json"}]', ], - 'DeleteDataLakePartition' => [ - 'summary' => '调用此API可删除湖仓表分区。', + 'GetNotebookAndSubmitTask' => [ + 'summary' => '调度运行Notebook文件。', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['description' => 'Notebook文件路径。', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb'], ], [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'name' => 'Params', + 'in' => 'formData', + 'schema' => ['description' => 'Notebook文件的传入参数，按字典格式传入。', 'type' => 'string', 'required' => true, 'example' => '{\'dt\': \'2022-10-14\'}'], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_name', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '8vkixxxxx***'], ], [ - 'name' => 'PartitionValues', + 'name' => 'Retry', + 'in' => 'formData', + 'schema' => ['description' => '调度失败后重试次数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'WorkspaceId', 'in' => 'query', - 'style' => 'simple', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '8630242382****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分区值列表。', - 'type' => 'array', - 'items' => [ - 'description' => '分区列的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'part_val1', + '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'], ], - 'required' => true, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '提交Notebook调度任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'GetNotebookTaskStatus' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'IfExists', - 'in' => 'query', - 'schema' => [ - 'description' => '如果需要删除的分区不存在，是否要忽略该异常。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Tid', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '调度任务ID。', 'type' => 'string', 'required' => false, 'example' => 'c2b4cb5a-7420-49a8-aa7c-528becd6e1bf'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + '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' => 'Schema of Response', + 'description' => '请求返回。', '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Notebook调度任务执行状态', + 'summary' => '查看Notebook任务运行结果。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除湖仓表分区', + 'ramActions' => [], + '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"}]', ], - 'DeleteDataLakeDatabase' => [ - 'summary' => '调用此API可删除湖仓数据库。', + 'GetSqlConsoleOperationLog' => [ + 'summary' => '查询SQL窗口操作日志', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsCYIMWT'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DbName', + 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'user'], ], [ - 'name' => 'Tid', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '数据库 Schema。', 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'SqlType', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => 'SQL语句类型。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '日志开始时间。', 'type' => 'string', 'required' => true, 'example' => '2026-01-01 00:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '日志结束时间。', 'type' => 'string', 'required' => true, 'example' => '2026-06-01 00:00:00'], ], ], 'responses' => [ @@ -5591,50 +5752,49 @@ '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', + 'RequestId' => ['description' => '请求ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'C0A813EB-4623-523A-8598-86390CB4****'], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '日志开始时间。', 'type' => 'string', 'example' => '2026-01-01 00:00:00'], + 'Schema' => ['description' => '数据库 Schema。', 'type' => 'string', 'example' => 'mysql'], + 'Sql' => ['description' => 'SQL 语句。', 'type' => 'string', 'example' => 'SELECT * FROM user;'], + 'Success' => ['description' => '语句是否执行成功。', 'type' => 'boolean', 'example' => 'true'], + 'AffectRows' => ['description' => '影响行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => '执行时长。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Error' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Access Denied'], + 'Username' => ['description' => '用户名。', 'type' => 'string', 'example' => 'user'], + 'DatabaseSearchName' => ['description' => '数据库搜索名。', 'type' => 'string', 'example' => 'mysql@xxx.com'], + 'SqlType' => ['description' => 'SQL 类型。', 'type' => 'string', 'example' => 'SELECT'], + ], + ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '400'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'TotalCount' => ['description' => '日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询SQL窗口操作日志', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除湖仓数据库', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0A813EB-4623-523A-8598-86390CB4****\\",\\n \\"Data\\": [\\n {\\n \\"StartTime\\": \\"2026-01-01 00:00:00\\",\\n \\"Schema\\": \\"mysql\\",\\n \\"Sql\\": \\"SELECT * FROM user;\\",\\n \\"Success\\": true,\\n \\"AffectRows\\": 100,\\n \\"Cost\\": 10,\\n \\"Error\\": \\"Access Denied\\",\\n \\"Username\\": \\"user\\",\\n \\"DatabaseSearchName\\": \\"mysql@xxx.com\\",\\n \\"SqlType\\": \\"SELECT\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', ], - 'CreateDataLakeTable' => [ - 'summary' => '调用此API可新建湖仓表。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkspaceCode' => [ + 'summary' => '读取工作空间的代码文件内容，返回文件的内容，mtime（在header中）', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5643,68 +5803,96 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12****'], ], [ - 'name' => 'DbName', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['title' => 'code文件路径: /Workspace/code/test.py'."\n" + .'请求路径', 'description' => 'code文件路径: /Workspace/code/test.py'."\n" + .'请求路径', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb'], ], [ - 'name' => 'TableInput', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'Iac', + 'in' => 'query', + 'schema' => ['title' => '如果文件是个json，Iac=true时， 返回的内容会从json格式专业yaml格式', 'description' => '如果文件是个json，Iac=true时， 返回的内容会从json格式专业yaml格式', 'type' => 'string', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表的信息。', - 'required' => true, - '$ref' => '#/components/schemas/DLTableInput', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'Data' => ['title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'example' => 'log info'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], + 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '读取工作空间文件内容', + 'description' => '获取工作空间的资源配置上限信息和实例购买状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ [ - 'name' => 'Tid', - 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"Data\\": \\"log info\\",\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetWorkspaceCodePublishSetting' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '8630242382****'], ], ], 'responses' => [ @@ -5714,158 +5902,359 @@ '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', + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'Repos' => [ + 'description' => '工作空间中的git仓库列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Repo' => ['description' => '仓库信息。', 'type' => 'string', 'example' => 'analyticscomputing/dide'], + 'Path' => ['description' => 'Notebook文件路径。', 'type' => 'string', 'example' => '/luna-public/'], + 'Branch' => ['description' => '分支名', 'type' => 'string', 'example' => 'main'], + ], + 'description' => '', + ], + ], + 'Exclude' => [ + 'description' => '用于描述排除哪些文件的过滤器。仅用于归档功能中的数据源分析，其他场景请勿使用。', + 'type' => 'array', + 'items' => ['description' => '当**SourceType**取值为**ECS_FILE**、**File**、**NAS**、**COMMON_NAS**、**COMMON_FILE_SYSTEM**时，可以配置该参数。表示不需要进行备份的文件类型，该类型的所有文件都不备份。最多支持255个字符。', 'type' => 'string', 'example' => '[\\"/exclude_*.log\\", \\"temp_file.tmp\\"]'], + ], + 'LockRepoBranch' => ['description' => '是否锁定发布分支。 设置为true，则workspaceCodePublish接口提交的配置无效； flase则workspaceCodePublish接口提交的config可以覆盖这个配置', 'type' => 'boolean', 'example' => 'false'], + ], ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], + 'HttpStatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Code' => ['description' => '状态码，Success表示成功。', 'type' => 'string', 'example' => '200'], ], ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间部署配置', + 'summary' => '获取工作空间的部署配置', + 'description' => '获取工作空间的部署配置，主要包含repo的分支信息，exclude 目录等', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"Data\\": {\\n \\"Repos\\": [\\n {\\n \\"Repo\\": \\"analyticscomputing/dide\\",\\n \\"Path\\": \\"/luna-public/\\",\\n \\"Branch\\": \\"main\\"\\n }\\n ],\\n \\"Exclude\\": [\\n \\"[\\\\\\\\\\\\\\"/exclude_*.log\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"temp_file.tmp\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"LockRepoBranch\\": false\\n },\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetWorkspaceQuota' => [ + 'summary' => '获取工作空间配额', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'AccessDeniedDetail' => ['title' => '拒绝访问的详情', 'description' => '拒绝访问的详情', 'type' => 'string', 'example' => 'NOT_FOUND'], + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'example' => '20923*****7291'], + 'InstanceId' => ['title' => '计费实例ID', 'description' => '计费实例ID', 'type' => 'string', 'example' => 'i-bp16pha0zu99yybi59qr'], + 'CuQuota' => ['title' => 'CU配额', 'description' => 'CU配额', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'CuQuotaUsage' => ['title' => '已使用CU配额', 'description' => '已使用CU配额', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Status' => ['title' => '实例状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'RELEASED'], + 'NotebookFreeQuotaAvailable' => ['title' => 'Notebook免费配额可用量(CU-H)', 'description' => 'Notebook免费配额可用量(CU-H)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'NotebookFreeQuotaTotal' => ['title' => 'Notebook免费配额总量(CU-H)', 'description' => 'Notebook免费配额总量(CU-H)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Message' => ['title' => '日志信息', 'description' => '日志信息', 'type' => 'string', 'example' => 'Successful'], + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'InvalidTid'], + 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间配额', + 'description' => '获取工作空间的资源配置上限信息和实例购买状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": \\"20923*****7291\\",\\n \\"InstanceId\\": \\"i-bp16pha0zu99yybi59qr\\",\\n \\"CuQuota\\": 200,\\n \\"CuQuotaUsage\\": 20,\\n \\"Status\\": \\"RELEASED\\",\\n \\"NotebookFreeQuotaAvailable\\": 0,\\n \\"NotebookFreeQuotaTotal\\": 0\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ListAirflowVersions' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DbName', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID', 'type' => 'string', 'required' => true, 'example' => '8630242382****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + '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' => '版本列表', + 'type' => 'array', + 'items' => ['description' => '数据详情。', 'type' => 'string', 'example' => '{\'Responses\': {\'responses\': [{\'Uuid\': \'af-63ly5o1yuf076ifrpbxpka396\', \'Success\': True}]}}'], + ], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + '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'], + ], + 'description' => '', ], ], + ], + 'title' => '获取可用的Airflow版本列表', + 'summary' => '获取可用的Airflow版本列表', + 'description' => '获取可用的Airflow版本列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": [\\n \\"{\'Responses\': {\'responses\': [{\'Uuid\': \'af-63ly5o1yuf076ifrpbxpka396\', \'Success\': True}]}}\\"\\n ],\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ListAirflows' => [ + 'summary' => '获取工作空间的Airflow实例列表。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TableName', + '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' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '86302423828****'], ], [ - 'name' => 'PartitionInput', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '新增分区的信息。', - 'required' => true, - '$ref' => '#/components/schemas/DLPartitionInput', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '10'], ], [ - 'name' => 'IfNotExists', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '当新增的分区名称与已有的分区名称重复，是否忽略该异常。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '下一次查询的令牌（Token）。', 'type' => 'string', 'required' => false, 'example' => 'f056501ada12****'], ], [ - 'name' => 'NeedResult', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要返回新建的分区信息，为**true**时结果会返回Partition。取值：'."\n" - ."\n" - .'- **true**：返回新建的分区信息。'."\n" - ."\n" - .'- **false**：不返回新建的分区信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Tid', + 'name' => 'Skip', 'in' => 'query', + 'schema' => ['description' => '跳过n条记录，用于分页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', + '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'], + ], ], ], + ], + 'title' => '获取工作空间的Airflow实例列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'ListCustomAgent' => [ + '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' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '自定义Agent状态。', + 'type' => 'string', 'required' => false, - 'example' => '12****', + '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 => [ @@ -5874,149 +6263,323 @@ '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', + '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'], + 'KbUuid' => ['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' => ['type' => 'string', 'example' => 'cn-hangzhou'], + 'IsScheduleTask' => ['description' => '是否配置周期运行任务', 'type' => 'boolean', 'example' => 'true'], + 'NextRuntime' => ['description' => '周期任务下次运行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200'], + 'ScheduleTaskConfig' => [ + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => ['description' => '参考的历史会话id', 'type' => 'string', 'example' => '4m24*****mg7j2v'."\n"], + 'CronExpression' => ['description' => '时间周期调度的Cron表达式', 'type' => 'string', 'example' => '0 0 0 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'example' => '分析一下这份数据，给出简报'], + ], + 'description' => '', + ], + 'CallbackConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'RelatedSessionId' => ['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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取自定义Agent列表', + 'summary' => 'ListCustomAgent 获取个人空间、工作空间中所有自定义Agent列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '创建湖仓表分区', + '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 \\"KnowledgeConfigList\\": [\\n {\\n \\"AccessType\\": \\"\\",\\n \\"McpServerId\\": \\"\\",\\n \\"KbUuid\\": \\"\\"\\n }\\n ],\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": false,\\n \\"SkipAskHuman\\": false\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"DefaultAgent\\": 0,\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\",\\n \\"DMSUnit\\": \\"cn-hangzhou\\",\\n \\"IsScheduleTask\\": true,\\n \\"NextRuntime\\": 1767715200,\\n \\"ScheduleTaskConfig\\": {\\n \\"RelatedSessionId\\": \\"4m24*****mg7j2v\\\\n\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1-7\\",\\n \\"Query\\": \\"分析一下这份数据，给出简报\\"\\n },\\n \\"CallbackConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ToolId\\": \\"\\",\\n \\"CallbackPrompt\\": \\"\\",\\n \\"CallbackArgs\\": \\"\\",\\n \\"CallbackTime\\": 0\\n },\\n \\"RelatedSessionId\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalElements\\": 5,\\n \\"TotalPages\\": 1\\n }\\n}","type":"json"}]', ], - 'CreateDataLakeDatabase' => [ - 'summary' => '调用此API可新建湖仓数据库。', + 'ListDataAgentAccuracyTestInstances' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], ], [ - 'name' => 'DbName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '协作空间 ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '数据库描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '当前页大小', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Location', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据库存储路径。支持oss、s3、s3a。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://path/to/database', - ], + 'schema' => ['description' => '当前页码', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Parameters', + 'name' => 'MaxResults', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '令牌（Token）信息', 'type' => 'string', 'required' => false, 'example' => 'Nes****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库属性的键值对。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"key":"value"}', - 'description' => '参数key和value。', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'], + 'Success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.'], + 'MaxResults' => ['description' => '限定每次返回的最大条数，可以和NextToken搭配使用实现翻页能力。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['description' => '令牌（Token）信息', 'type' => 'string', 'example' => 'zCXS*****'], + 'Total' => ['description' => '总记录数。', 'type' => 'string', 'example' => '3'], + 'PageNumber' => ['description' => '当前页码', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '当前页大小', 'type' => 'string', 'example' => '10'], + 'Timestamp' => ['description' => '操作时间戳', 'type' => 'string', 'example' => '1768270172'], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'AccuracyTestInsId' => ['description' => '准确率测试实例ID', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], + 'Name' => ['description' => '自定义Agent名称', 'type' => 'string', 'example' => 'Agent测试名称'], + 'Creator' => ['description' => '空间创建者的uid', 'type' => 'string', 'example' => '20282*****7591'], + 'AgentId' => ['description' => '自定义AgentId', 'type' => 'string', 'example' => 'ca-4x8uzp5wjqu4xxxxxxxxxx'], + 'MaxConcurrent' => ['description' => '测试中最大并发会话数', 'type' => 'string', 'example' => '5'], + 'WorkspaceId' => ['description' => '空间ID', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx'], + 'FileId' => ['description' => '测试集文件ID', 'type' => 'string', 'example' => 'f-8*******01m'."\n"], + 'Language' => ['description' => '分析任务所用语言', 'type' => 'string', 'example' => 'CHINESE'], + 'Mode' => ['description' => '需测试的分析模式', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'NeedDelete' => ['description' => '分析后会话是否展示（暂不支持）', 'type' => 'string', 'example' => 'true'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2026-06-30T07:31:09.000+00:00'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2026-06-30T07:31:09.000+00:00'], + ], + ], + ], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出准确率自测配置项', + 'summary' => '列出满足条件的准确率测试配置项', + 'description' => '列出满足条件的准确率测试配置项', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-xxx-FD8AD04A63B6\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"zCXS*****\\",\\n \\"Total\\": \\"3\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"Timestamp\\": \\"1768270172\\",\\n \\"Data\\": [\\n {\\n \\"AccuracyTestInsId\\": \\"at-106n4rg17gv9fxxxxxxxxxx\\",\\n \\"Name\\": \\"Agent测试名称\\",\\n \\"Creator\\": \\"20282*****7591\\",\\n \\"AgentId\\": \\"ca-4x8uzp5wjqu4xxxxxxxxxx\\",\\n \\"MaxConcurrent\\": \\"5\\",\\n \\"WorkspaceId\\": \\"8wfig6l33n4f4xxxxxxxxxx\\",\\n \\"FileId\\": \\"f-8*******01m\\\\n\\",\\n \\"Language\\": \\"CHINESE\\",\\n \\"Mode\\": 0,\\n \\"NeedDelete\\": \\"true\\",\\n \\"GmtCreate\\": \\"2026-06-30T07:31:09.000+00:00\\",\\n \\"GmtModified\\": \\"2026-06-30T07:31:09.000+00:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDataAgentAccuracyTestResults' => [ + 'summary' => '获取自测任务的执行结果', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Tid', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '所属的准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], + ], + [ + 'name' => 'AccuracyTestTaskId', + 'in' => 'query', + 'schema' => ['description' => '准确率测试任务ID', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + ], + [ + 'name' => 'AccuracyTestSubtaskId', + 'in' => 'query', + 'schema' => ['description' => ' 按子任务ID筛选', 'type' => 'string', 'required' => false, 'example' => 'f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + ], + [ + 'name' => 'AccuracyTestResultId', + 'in' => 'query', + 'schema' => ['description' => '按结果ID精确筛选单条', 'type' => 'string', 'required' => false, 'example' => 'at-emhnbwewfngrxxxxxxxxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '当前页大小', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'nu use'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '令牌（Token）信息', 'type' => 'string', 'required' => false, 'example' => 'NesLoKLEdIZrKhDT7I2gS****'], ], ], 'responses' => [ @@ -6026,135 +6589,252 @@ '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', + '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' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息', 'type' => 'string', 'example' => 'UnknownError'], + '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' => [ + 'ResultId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => 'at-emhnbwewfngrxxxxxxxxxx'], + 'SubtaskId' => ['description' => '子任务ID。', 'type' => 'string', 'example' => 'f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + 'Question' => ['description' => '测试问题', 'type' => 'string', 'example' => '拥有Senior Engineer头衔的员工有多少人？'], + 'AnswerResult' => ['description' => '期望答案', 'type' => 'string', 'example' => '97750'], + 'AnswerSql' => ['description' => '期望SQL', 'type' => 'string', 'example' => 'SELECT COUNT(*) FROM titles WHERE title = \'Senior Engineer\';'], + 'AgentResult' => ['description' => 'Agent 实际回答', 'type' => 'string', 'example' => '在公司历史职位记录中，共有97,750名员工曾拥有Senior Engineer头衔。'], + 'IsTrue' => ['description' => 'AI 评判结果', 'type' => 'boolean', 'example' => ' true'], + 'Reason' => ['description' => '错误原因', 'type' => 'string', 'example' => 'SQL 中不应该使用COUNT(DISTINCT)'], + 'Recommendation' => ['description' => ' 改进建议', 'type' => 'string', 'example' => '在问题中描述清楚是否需去重'], + 'AccuracyTestTaskId' => ['description' => '准确率测试任务ID', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + ], + ], + ], + 'CorrectCount' => ['description' => '评判通过的用例数 ', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'AccuracyRate' => ['description' => '准确率', 'type' => 'number', 'format' => 'double', 'example' => '90'], + 'AccuracyTestTaskId' => ['description' => '准确率测试任务ID', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + 'TotalElements' => ['description' => '结果总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], + 'MaxResults' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => 'no use'], + 'NextToken' => ['description' => '分页游标标识。', 'type' => 'string', 'example' => 'no use'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取自测任务的执行结果', + 'description' => '获取自测任务的执行结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '创建湖仓数据库', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Data\\": {\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"Content\\": [\\n {\\n \\"ResultId\\": \\"at-emhnbwewfngrxxxxxxxxxx\\",\\n \\"SubtaskId\\": \\"f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"Question\\": \\"拥有Senior Engineer头衔的员工有多少人？\\",\\n \\"AnswerResult\\": \\"97750\\",\\n \\"AnswerSql\\": \\"SELECT COUNT(*) FROM titles WHERE title = \'Senior Engineer\';\\",\\n \\"AgentResult\\": \\"在公司历史职位记录中，共有97,750名员工曾拥有Senior Engineer头衔。\\",\\n \\"IsTrue\\": true,\\n \\"Reason\\": \\"SQL 中不应该使用COUNT(DISTINCT)\\",\\n \\"Recommendation\\": \\"在问题中描述清楚是否需去重\\",\\n \\"AccuracyTestTaskId\\": \\"692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\"\\n }\\n ],\\n \\"CorrectCount\\": 9,\\n \\"AccuracyRate\\": 90,\\n \\"AccuracyTestTaskId\\": \\"692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"TotalElements\\": 10,\\n \\"TotalPages\\": 1\\n },\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"no use\\"\\n}","type":"json"}]', ], - 'BatchUpdateDataLakePartitions' => [ - 'summary' => '调用此API可批量更新湖仓表分区信息。', + 'ListDataAgentAccuracyTestTasks' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '协作空间 ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'DbName', + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], ], [ - 'name' => 'TableName', + 'name' => 'AccuracyTestTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => '按任务ID精确筛选', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], ], [ - 'name' => 'PartitionInputs', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '当前页大小', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + '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****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '新增分区的信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据湖分区信息。', - 'required' => false, - '$ref' => '#/components/schemas/DLPartitionInput', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.'], + 'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '当前页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Data' => [ + 'description' => '返回结构体', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'AccuracyTestTaskId' => ['description' => '准确率测试任务ID', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + 'AccuracyTestInsId' => ['description' => '所属的准确率测试实例ID', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], + 'TotalTaskNumber' => ['description' => '准确率测试任务中包含的子任务数量（个）', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'FinishedTaskNumber' => ['description' => '当前已完成的测试子任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'MaxConcurrent' => ['description' => '测试中最大并发会话数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'NeedDelete' => ['description' => '分析后会话是否展示（暂不支持）', 'type' => 'boolean', 'example' => 'true'], + 'WorkspaceId' => ['description' => '协作空间ID', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx'], + 'Status' => ['description' => '自定义Agent状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0 PENDING,1 RUNNING,2 COMPLETED,3 STOPPED,4 FAILED'], + 'GmtCreate' => ['description' => '文档创建时间', 'type' => 'string', 'example' => '2026-06-30T08:03:30.000+00:00'], + 'GmtModified' => ['description' => '文档修改时间', 'type' => 'string', 'example' => '2026-06-30T08:03:30.000+00:00'], + ], + ], + ], + 'MaxResults' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['description' => '令牌（Token）信息', 'type' => 'string', 'example' => 'NesLo****'], ], - 'required' => true, + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出准确率测试任务', + 'summary' => '分页查询自测任务运行状态', + 'description' => '分页查询自测任务运行状态'."\n" + .'AccuracyTestInsId/AccuracyTestTaskId为空，表示查询所有测试任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-xxx-FD8AD04A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Total\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"AccuracyTestTaskId\\": \\"692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",\\n \\"AccuracyTestInsId\\": \\"at-106n4rg17gv9fxxxxxxxxxx\\",\\n \\"TotalTaskNumber\\": 20,\\n \\"FinishedTaskNumber\\": 16,\\n \\"MaxConcurrent\\": 5,\\n \\"NeedDelete\\": true,\\n \\"WorkspaceId\\": \\"8wfig6l33n4f4xxxxxxxxxx\\",\\n \\"Status\\": 0,\\n \\"GmtCreate\\": \\"2026-06-30T08:03:30.000+00:00\\",\\n \\"GmtModified\\": \\"2026-06-30T08:03:30.000+00:00\\"\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"NesLo****\\"\\n}","type":"json"}]', + ], + 'ListDataAgentSession' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Tid', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '当前 DMS 单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'CreateStartTime', + 'in' => 'query', + 'schema' => ['description' => '会话创建开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1770825600000'], + ], + [ + 'name' => 'CreateEndTime', + 'in' => 'query', + 'schema' => ['description' => '会话创建结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1770912000000'], + ], + [ + 'name' => 'IsSaved', + 'in' => 'query', + 'schema' => ['description' => '是否仅获取已收藏的会话', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '协作空间 ID', 'type' => 'string', 'required' => false, 'example' => '20923*****7291'], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '会话类型，指定协作空间的情况下必传', + 'type' => 'string', 'required' => false, - 'example' => '12****', + 'enumValueTitles' => ['mySession' => '我创建的会话', 'all' => '协作空间下的所有会话', 'myFavorite' => '已收藏的会话'], + 'example' => 'myFavorite', ], ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => 'Data Agent标题（支持模糊查询）', 'type' => 'string', 'required' => false, 'example' => '帮我分析一下这份数据'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'CustomAgentId', + 'in' => 'query', + 'schema' => ['description' => '自定义Agent Id', 'type' => 'string', 'required' => false, 'example' => 'ca-4y3ca4khkcu**********ysf'], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -6163,159 +6843,149 @@ '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' => '错误列表信息。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-****'], + 'Data' => [ + 'description' => '返回结构体', 'type' => 'array', 'items' => [ - 'description' => '错误信息。', - '$ref' => '#/components/schemas/PartitionError', + 'description' => 'Data Agent会话描述', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'Data Agent会话Id', 'type' => 'string', 'example' => 'h8r********4fch'], + 'SessionStatus' => ['description' => '会话状态', 'type' => 'string', 'example' => 'RUNNING'], + 'Title' => ['description' => '标题', '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' => 'prod'], + 'Mode' => ['description' => '模式：'."\n" + .' - **ASK_DATA** 问数模式'."\n" + .' - **ANALYSIS** 分析模式'."\n" + .' - **INSIGHT** 洞察模式', 'type' => 'string', 'example' => 'ANALYSIS'], + 'EnableSearch' => ['description' => '是否开启联网搜索', 'type' => 'boolean', 'example' => 'true'], + 'UserOssBucket' => ['description' => '用户 OSS Bucket 名称'."\n" + ."\n" + .'- 分析过程文件、报告产物可上传到用户指定的OSS Bucket', 'type' => 'string', 'example' => 'user-oss-bucket'], + ], + ], + 'CreateTime' => ['description' => '会话创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1731645908000'], + 'Saved' => ['description' => '是否被当前登录人收藏', 'type' => 'boolean', 'example' => 'true'], + 'AgentId' => ['description' => '当前Agent Id', 'type' => 'string', 'example' => 'cu0cs*******mf'], + 'AgentStatus' => ['description' => '当前Agent 状态', 'type' => 'string', 'example' => 'RUNNING'], + 'FavoriteInWorkspace' => ['description' => '是否在工作空间中被当前登录人收藏', 'type' => 'boolean', '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'], + 'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'TotalPages' => ['description' => '总页数（页）', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '当前页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取DataAgent会话列表', + 'summary' => '获取Data Agent历史会话描述列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '批量更新湖仓表分区', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-****\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"h8r********4fch\\",\\n \\"SessionStatus\\": \\"RUNNING\\",\\n \\"Title\\": \\"分析一下这份文件，给出报告。\\",\\n \\"File\\": \\"f-8*******01m\\",\\n \\"SessionConfig\\": {\\n \\"Language\\": \\"CHINESE\\",\\n \\"CustomAgentId\\": \\"ca-e*******ckd\\",\\n \\"CustomAgentStage\\": \\"prod\\",\\n \\"Mode\\": \\"ANALYSIS\\",\\n \\"EnableSearch\\": true,\\n \\"UserOssBucket\\": \\"user-oss-bucket\\"\\n },\\n \\"CreateTime\\": 1731645908000,\\n \\"Saved\\": true,\\n \\"AgentId\\": \\"cu0cs*******mf\\",\\n \\"AgentStatus\\": \\"RUNNING\\",\\n \\"FavoriteInWorkspace\\": true,\\n \\"UserId\\": \\"2096******\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Total\\": 3,\\n \\"TotalPages\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', ], - 'BatchDeleteDataLakePartitions' => [ - 'summary' => '调用此API可批量删除湖仓表分区。', + 'ListDataAgentWorkspace' => [ + 'summary' => '获取主账号下的协作空间（分页）', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DbName', + 'name' => 'WorkspaceType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '查询空间类型', 'type' => 'string', 'required' => true, 'example' => 'MY'], ], [ - 'name' => 'TableName', + 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_name', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'workspaceTest'], ], [ - 'name' => 'PartitionValuesList', + 'name' => 'PageNumber', '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, - ], + 'schema' => ['description' => '开始页号', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'IfExists', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '如果需要删除的分区不存在，是否要忽略该异常。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '每页记录数（个）', 'type' => 'string', 'required' => true, 'example' => '10'], ], [ - 'name' => 'Tid', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'no use'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + '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' => [ @@ -6325,126 +6995,138 @@ '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', + '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'], + 'IsSessionShareEnabled' => ['type' => 'boolean'], + 'Type' => ['type' => 'string'], + ], + ], + ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取主账号下的协作空间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '批量删除湖仓表分区', + '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 \\"IsSessionShareEnabled\\": true,\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"TotalElements\\": 122,\\n \\"TotalPages\\": 12\\n },\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"no use\\"\\n}","type":"json"}]', ], - 'CreateDataLakeFunction' => [ - 'summary' => '调用此API可以新建湖仓自定义函数。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataAgentWorkspaceMember' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DbName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '20923*****7291'], ], [ - 'name' => 'FunctionInput', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '函数的详细信息。', - 'required' => true, - '$ref' => '#/components/schemas/DLFunctionInput', - ], + 'name' => 'SearchMemberId', + 'in' => 'query', + 'schema' => ['description' => '用于查询的成员ID前缀', 'type' => 'string', 'required' => false, 'example' => '20273'], ], [ - 'name' => 'Tid', + 'name' => 'SearchRoleName', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '用于查询的成员名称前缀', 'type' => 'string', 'required' => false, 'example' => 'yunqi'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + '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' => [ @@ -6454,122 +7136,101 @@ '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间的成员信息', + 'summary' => '获取空间所有成员', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '新建数据湖自定义函数', + 'ramActions' => [], + '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"}]', ], - 'GetDataLakeFunction' => [ - 'summary' => '调用此API可获取湖仓自定义函数的详细信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataCenterDatabase' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'DbName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'FunctionName', + 'name' => 'ImportType', 'in' => 'query', - 'schema' => [ - 'description' => '函数名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_funciton', - ], + 'schema' => ['description' => '导入类型'."\n" + .' - FILE', 'type' => 'string', 'required' => false, 'example' => 'FILE'], ], [ - 'name' => 'Tid', + 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '模糊搜索数据库关键字', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'CallFrom', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => 'Frontend only'], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => 'Frontend only'], ], ], 'responses' => [ @@ -6579,132 +7240,257 @@ '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', + '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' => [ + 'DbId' => ['description' => '数据库 ID', 'type' => 'string', 'example' => '6kv159u9vtpvl**********b8'], + 'DbType' => ['description' => '- ImportType为FILE'."\n" + .' - 文件类型：dbType为文件格式，例如csv、xlsx、xls', 'type' => 'string', 'example' => 'csv'], + 'ImportType' => ['description' => '导入类型'."\n" + .' - FILE'."\n" + .' - RDS'."\n" + .' - ADB'."\n" + .' - PolarDB'."\n" + .' - Hologres'."\n" + .' - DMS', 'type' => 'string', 'example' => 'FILE'], + 'InstanceName' => ['description' => '实例名称'."\n" + .'- ImportType为File时，表示数据中心的文件ID', 'type' => 'string', 'example' => 'f-ean8u5881qk4*********xh5y'], + 'DatabaseName' => ['description' => '数据库名'."\n" + .'- ImportType为File时，表示文件名', 'type' => 'string', 'example' => 'diamonds.csv'], + 'DatabaseDesc' => ['description' => '数据库描述', 'type' => 'string', 'example' => 'This is a sample database.'], + 'DescUpdateTime' => ['description' => '数据库描述更新时间', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00'], + 'Size' => ['description' => '文件大小，单位字节', 'type' => 'integer', 'format' => 'int64', 'example' => '999'], + 'IsInternal' => ['description' => '是否为内置数据集'."\n" + .'- Y：内置数据集'."\n" + .'- N：非内置数据集', 'type' => 'string', 'example' => 'N'], + 'DmsInstanceId' => ['description' => '实例托管在 DMS 实例 ID'."\n" + .' - 当ImportType为FILE时，不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '2740966'], + 'DmsDbId' => ['description' => '实例托管在 DMS 数据库 ID'."\n" + .' - 当ImportType为FILE时，不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '73088962'], + 'UseUserOssBucket' => ['type' => 'boolean'], + 'OssBucket' => ['type' => 'string'], + 'DownloadLink' => ['type' => 'string'], + 'IntranetDownloadLink' => ['type' => 'string'], + ], + ], ], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据中心用户上传的文件列表', + 'summary' => '获取数据中心用户上传的文件列表，仅支持文件类型，不支持数据库类型', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataCenterDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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 \\"DbId\\": \\"6kv159u9vtpvl**********b8\\",\\n \\"DbType\\": \\"csv\\",\\n \\"ImportType\\": \\"FILE\\",\\n \\"InstanceName\\": \\"f-ean8u5881qk4*********xh5y\\",\\n \\"DatabaseName\\": \\"diamonds.csv\\",\\n \\"DatabaseDesc\\": \\"This is a sample database.\\",\\n \\"DescUpdateTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"GmtCreated\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"Size\\": 999,\\n \\"IsInternal\\": \\"N\\",\\n \\"DmsInstanceId\\": 2740966,\\n \\"DmsDbId\\": 73088962,\\n \\"UseUserOssBucket\\": true,\\n \\"OssBucket\\": \\"\\",\\n \\"DownloadLink\\": \\"\\",\\n \\"IntranetDownloadLink\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDataCenterTable' => [ + 'summary' => '获取数据中心用户上传的表列表，仅支持文件类型，不支持数据库类型', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'CatalogName', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ - 'name' => 'DbName', + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => '实例名称'."\n" + .'- ImportType为File时，表示数据中心的文件ID', 'type' => 'string', 'required' => false, 'example' => 'f-ean8u5881qk4*********xh5y'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => '数据库名'."\n" + .'- ImportType为File时，表示文件名', 'type' => 'string', 'required' => false, 'example' => 'diamonds.csv'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => '表名', 'type' => 'string', 'required' => false, 'example' => 'diamonds'], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => '模糊搜索数据库表关键字', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'ImportType', + 'in' => 'query', + 'schema' => ['description' => '导入类型'."\n" + .' - FILE', 'type' => 'string', 'required' => false, 'example' => 'FILE'], + ], + [ + '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'], + ], + [ + 'name' => 'CallFrom', + 'in' => 'query', + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => '仅前端使用'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + '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' => [ + 'TableId' => ['description' => '数据表ID', 'type' => 'string', 'example' => 'xa8wib4ga3a2*********fjbx'], + 'ImportType' => ['description' => '导入类型'."\n" + .' - FILE', 'type' => 'string', 'example' => 'FILE'], + 'InstanceName' => ['description' => '实例名称'."\n" + .'- ImportType为File时，表示数据中心的文件ID', 'type' => 'string', 'example' => 'f-ean8u5881qk4*********xh5y'], + 'DatabaseName' => ['description' => '数据库名'."\n" + .'- ImportType为File时，表示文件名', 'type' => 'string', 'example' => 'diamonds.csv'], + 'TableName' => ['description' => '表名', 'type' => 'string', 'example' => 'diamonds'."\n"], + 'TableDesc' => ['description' => '表的描述信息', 'type' => 'string', 'example' => '这是一份钻石数据。'], + 'DescUpdateTime' => ['description' => '数据库描述更新时间', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00'], + 'DmsInstanceId' => ['description' => '实例托管在 DMS 实例 ID'."\n" + .' - 当ImportType为FILE时，不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '2310246'], + 'DmsDbId' => ['description' => '实例托管在 DMS 数据库 ID'."\n" + .' - 当ImportType为FILE时，不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '69950353'], + ], + ], + ], + 'TotalElements' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TotalPages' => ['description' => '总页数（页）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageNumber' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据中心用户上传的表列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ [ - 'name' => 'FunctionInput', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '函数的详细信息。', - 'required' => true, - '$ref' => '#/components/schemas/DLFunctionInput', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataCenterTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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 \\"TableId\\": \\"xa8wib4ga3a2*********fjbx\\",\\n \\"ImportType\\": \\"FILE\\",\\n \\"InstanceName\\": \\"f-ean8u5881qk4*********xh5y\\",\\n \\"DatabaseName\\": \\"diamonds.csv\\",\\n \\"TableName\\": \\"diamonds\\\\n\\",\\n \\"TableDesc\\": \\"这是一份钻石数据。\\",\\n \\"DescUpdateTime\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"GmtCreated\\": \\"2025-12-11T14:04:32.000+00:00\\",\\n \\"DmsInstanceId\\": 2310246,\\n \\"DmsDbId\\": 69950353\\n }\\n ],\\n \\"TotalElements\\": 20,\\n \\"TotalPages\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + ], + 'ListDataLakeCatalog' => [ + 'summary' => '调用此API可以获取数据湖的数据目录列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Tid', + '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' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + 'schema' => ['description' => '搜索数据库目录名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hive'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '租户ID，可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'FunctionName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '函数名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_funciton', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -6714,66 +7500,61 @@ '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖的数据目录列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '更新湖仓自定义函数', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CataLogList\\": [\\n {\\n \\"Description\\": \\"init default catalog\\",\\n \\"Name\\": \\"hive\\",\\n \\"Location\\": \\"oss://xxxx\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteDataLakeFunction' => [ - 'summary' => '调用此API可删除湖仓自定义函数。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataLakeDatabase' => [ + 'summary' => '调用此API可以获取数据湖的数据库列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249748', + 'abilityTreeNodes' => ['FEATUREdms90TD19'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -6781,55 +7562,36 @@ [ 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '数据目录名。', - 'type' => 'string', - 'required' => true, - 'example' => 'hive', - ], + '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' => 'DbName', + 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '搜索数据库名称的关键字。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'FunctionName', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '函数名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_funciton', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3****'], ], [ - 'name' => 'Tid', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3****', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -6839,49 +7601,49 @@ '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖的数据库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除湖仓自定义函数', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Description\\": \\"Default database for catalog hive\\\\n\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 19,\\n \\"CatalogName\\": \\"hive\\",\\n \\"Name\\": \\"default\\",\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2g****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', ], 'ListDataLakeFunction' => [ - 'summary' => '调用此API可获取数据湖函数列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6894,10 +7656,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -6905,82 +7664,41 @@ [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'FunctionNamePattern', 'in' => 'query', - 'schema' => [ - 'description' => '函数名匹配的正则表达式，用于过滤返回的函数名称。', - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], + '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****', - ], + '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', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -6990,68 +7708,50 @@ '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', - ], + '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', + '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取数据湖函数列表', + 'summary' => '调用此API可获取数据湖函数列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"FunctionList\\": [\\n {\\n \\"FunctionName\\": \\"my_funciton\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"CreateTime\\": 1731586286,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar\\"\\n }\\n ],\\n \\"ClassName\\": \\"com.example.hive.MyCustomUDF\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"ModifierId\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"f056501ada12****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', ], 'ListDataLakeFunctionName' => [ - 'summary' => '调用此API可获取数据湖函数名称列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7064,10 +7764,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '249778', - 'abilityTreeNodes' => [ - 'FEATUREdms90TD19', - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -7075,82 +7772,41 @@ [ 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID。'."\n" - .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '3****', - ], + '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', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ 'name' => 'FunctionNamePattern', 'in' => 'query', - 'schema' => [ - 'description' => '函数名匹配的正则表达式，用于过滤返回的函数名称。', - 'type' => 'string', - 'required' => false, - 'example' => '.*', - ], + '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****', - ], + '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', - ], + '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****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -7160,205 +7816,170 @@ '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', - ], + '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖函数名称列表', + 'summary' => '调用此API可获取数据湖函数名称列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeFunctionName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], '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', - ], + 'ListDataLakePartition' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Path', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Notebook文件路径。', - 'type' => 'string', - 'required' => true, - 'example' => '/Workspace/code/default/test.ipynb', - ], + 'name' => 'Tid', + 'in' => 'query', + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'Params', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Notebook文件的传入参数，按字典格式传入。', - 'type' => 'string', - 'required' => true, - 'example' => '{\'dt\': \'2022-10-14\'}', - ], + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'example' => '8vkixxxxx***', - ], + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Retry', + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], + ], + [ + 'name' => 'PartNames', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '调度失败后重试次数。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '分区名列表。', + 'type' => 'array', + 'items' => ['description' => '分区名。', 'type' => 'string', 'required' => false, 'example' => 'part_1'], 'required' => false, - 'example' => 'true', ], ], [ + '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' => 'string', - 'required' => false, - 'example' => '8630242382****', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求返回。', + 'description' => 'Schema of Response', '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖表分区列表', + 'summary' => '调用此API可获取数据湖表分区列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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调度任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"table_name\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n },\\n \\"CreateTime\\": 1735109884,\\n \\"Values\\": [\\n \\"part_val1\\"\\n ],\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"LastAccessTime\\": 1608707407\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', ], - 'GetNotebookTaskStatus' => [ - 'summary' => '查看Notebook任务运行结果。', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataLakePartitionByFilter' => [ + 'summary' => '调用此API可根据筛选条件获取数据湖表分区列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7370,167 +7991,154 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsXSH6IQ', - ], + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '调度任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c2b4cb5a-7420-49a8-aa7c-528becd6e1bf', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '8630242382****', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'SessionId', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => 'Notebook会话ID。', - 'type' => 'string', - 'required' => false, - 'example' => '8141456676986429894916354', - ], + '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' => '请求返回。', + 'description' => 'Schema of Response', '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', - ], - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '根据筛选条件获取数据湖表分区列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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调度任务执行状态', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"table_name\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n },\\n \\"CreateTime\\": 1735109884,\\n \\"Values\\": [\\n \\"part_val1\\"\\n ],\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"LastAccessTime\\": 1608707407\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', ], - 'DescribeFileUploadSignature' => [ - 'summary' => 'DescribeFileUploadSignature', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataLakePartitionName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DmsUnit', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'CallFrom', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '仅前端使用', - 'type' => 'string', - 'required' => false, - 'example' => '仅前端使用', - ], + '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' => [ @@ -7540,164 +8148,120 @@ '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.', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖表分区名列表', + 'summary' => '调用此API可获取数据湖表分区名列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakePartitionName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取文件上传签名信息', + '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"}]', ], - 'FileUploadCallback' => [ - 'summary' => 'FileUploadCallback', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListDataLakeTable' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DmsUnit', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'Filename', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '文件名称', - 'type' => 'string', - 'required' => true, - 'example' => 'conversion_metrics.csv', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'UploadLocation', + 'name' => 'DbName', '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', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'FileSize', + 'name' => 'TableNamePattern', 'in' => 'query', - 'schema' => [ - 'description' => '文件大小，单位为字节', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8110', - ], + 'schema' => ['description' => '元数据表名称，正则表达式匹配。', 'type' => 'string', 'required' => false, 'example' => '.*'], ], [ - 'name' => 'CallFrom', + 'name' => 'TableType', 'in' => 'query', - 'schema' => [ - 'description' => '仅前端使用', - 'type' => 'string', - 'required' => false, - 'example' => 'TrailCenter', - ], + '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' => [ @@ -7707,61 +8271,49 @@ '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.', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖表列表', + 'summary' => '调用此API可获取数据湖表列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '文件上传后回调', + '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\\": \\"zhangsan\\",\\n \\"TableType\\": \\"EXTERNAL_TABLE\\",\\n \\"Parameters\\": {\\n \\"EXTERNAL\\": \\"TRUE\\",\\n \\"delta.minReaderVersion\\": \\"1\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 1731586286,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"LastAccessTime\\": 1608707407,\\n \\"Retention\\": 300,\\n \\"Name\\": \\"100g_customer\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ViewExpandedText\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DbId\\": 19,\\n \\"DbName\\": \\"default\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"ModifierId\\": 1410769,\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', ], - 'GetChatContent' => [ - 'summary' => '通过指定会话ID和AgentId，从特定检查点开始获取聊天内容。', - 'path' => '/api/v1/chat/stream', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'ListDataLakeTableName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7773,162 +8325,281 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249778', + 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '当前所在的DMS单元，阿里云国内站用户默认填入cn-hangzhou。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 取自系统右上角头像处悬停展示的租户ID信息，详情请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '3****'], ], [ - 'name' => 'SessionId', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '会话 ID，必须字段'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sess_12345', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'AgentId', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => 'AgentId，必填'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx-xxxx-xxxx', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'Checkpoint', + 'name' => 'TableNamePattern', 'in' => 'query', - 'schema' => [ - 'description' => '后端将从这个接口开始返回输出'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + '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' => [ - 'description' => 'SSE响应流的每条data都符合该json结构', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据湖表名列表', + 'summary' => '调用此API可获取数据湖表名列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTableName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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`的值。', + '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"}]', ], - 'DeleteFileUpload' => [ - 'summary' => 'DeleteFileUpload', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListDataLakeTablebaseInfo' => [ + 'summary' => '调用此API可以获取数据湖中表的基本信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeCode' => '249769', + 'abilityTreeNodes' => ['FEATUREdms90TD19'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DmsUnit', + 'name' => 'Rows', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['description' => '分页查询时每页的行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'example' => '10'], ], [ - 'name' => 'FileId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => '文件ID', - 'type' => 'string', - 'required' => true, - 'example' => 'f-8*******01m'."\n", - ], + 'schema' => ['description' => '分页查询时列表的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'CallFrom', + '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' => [ - 'description' => '仅前端使用', - 'type' => 'string', - 'required' => false, - 'example' => 'TrailCenter', + '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'], + 'title' => '获取数据湖中表的基本信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTablebaseInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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\\": \\"test\\",\\n \\"ViewOriginalText\\": \\"\\\\\\"\\\\\\"\\\\n\\",\\n \\"TableType\\": \\"EXTERNAL_TABLE\\\\n\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\\\\\"table\\\\\\"\\\\n\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 1608707407,\\n \\"LastAccessTime\\": 1731586286,\\n \\"Retention\\": 30000,\\n \\"Name\\": \\"100g_customer\\\\n\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\\\\\"\\\\\\"\\\\n\\",\\n \\"DbId\\": 19,\\n \\"DbName\\": \\"default\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"ModifierId\\": 1731585286,\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n ],\\n \\"TotalCount\\": \\"100\\"\\n}","type":"json"}]', + ], + 'ListDocumentChunks' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => false, 'example' => 'test.md'], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => '分页游标标识。说明 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的NextToken作为参数再次请求获得下一页的数据，直到返回为Null为止，表示获取到了所有的数据。', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20'], + ], + [ + 'name' => 'ChunkTitlePattern', + 'in' => 'formData', + 'schema' => ['description' => '知识块过滤，返回知识块标题中包含该值的知识块。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SortFieldName', + 'in' => 'formData', + 'schema' => ['description' => '排序字段。取值范围：'."\n" + ."\n" + .'- **id**（默认值）：知识块ID。'."\n" + .'- **hits**：热度。'."\n" + .'- **modifyTime**：修改时间。', 'type' => 'string', 'required' => false, 'example' => 'hits'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => ['description' => '排序方向。取值范围：'."\n" + .'- **ASC**（默认值）：升序。'."\n" + .'- **DESC**：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7936,59 +8607,145 @@ '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], 'Data' => [ - 'description' => '返回结构体', - 'type' => 'object', - 'properties' => [ - 'FileId' => [ - 'description' => '文件ID', - 'type' => 'string', - 'example' => 'f-8*******01m'."\n", - ], - ], - ], + 'description' => '知识块列表。', + 'type' => 'array', + 'items' => ['description' => '返回结构体。', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseChunk'], + ], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + 'TotalCount' => ['description' => '满足条件的知识块总数（目前暂不支持，返回值恒定为 0）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'MaxResults' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['description' => '分页游标标识。', 'type' => 'string', 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询知识块列表', + 'summary' => '查询知识块列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '删除上传文件', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"DocName\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"ChunkTitle\\": \\"\\",\\n \\"ChunkMtime\\": \\"\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\",\\n \\"TotalCount\\": 0,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"zCXSmY0CJbybp6FZV7vo0Wjw64X-*****\\"\\n}","type":"json"}]', ], - 'SendChatMessage' => [ - 'summary' => '向指定会话发送用户消息或取消会话。', - 'methods' => [ - 'post', + 'ListDocuments' => [ + 'summary' => '查询知识库中的文档列表', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => '分页游标标识。说明 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的NextToken作为参数再次请求获得下一页的数据，直到返回为Null为止，表示获取到了所有的数据。', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'NamePattern', + 'in' => 'formData', + 'schema' => ['description' => '文档名称过滤，返回文档名称中包含该值的文档', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SortFieldName', + 'in' => 'formData', + 'schema' => ['description' => '排序字段，取值：'."\n" + ."\n" + .'- id：文档ID（默认值）。'."\n" + .'- hits：热度。'."\n" + .'- modifyTime：修改时间。', 'type' => 'string', 'required' => false, 'example' => 'hits'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => ['description' => '排序方向，取值范围：'."\n" + .'- **ASC**（默认值）：升序。'."\n" + .'- **DESC**：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'Filters', + 'in' => 'formData', + 'schema' => ['description' => '文档属性过滤，支持以下两种属性：'."\n" + ."\n" + .'- fileExt：文档扩展类型。'."\n" + .'- state：文档状态。', 'type' => 'string', 'required' => false, 'example' => '{"fileExt":"pdf","state":0}'], + ], ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'TotalCount' => ['description' => '满足条件的文档总数（目前暂不支持，返回值恒定为 0）。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Data' => [ + 'description' => '文档列表。', + 'type' => 'array', + 'items' => ['description' => '返回结构体', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument'], + ], + 'NextToken' => ['description' => '分页游标标识。', 'type' => 'string', 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****'], + 'MaxResults' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询文档列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"TotalCount\\": 0,\\n \\"Data\\": [\\n {\\n \\"KbUuid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"FileExt\\": \\"\\",\\n \\"DocumentLoaderName\\": \\"\\",\\n \\"TextSplitterName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"FileSize\\": 0,\\n \\"DocsCount\\": 0,\\n \\"State\\": 0,\\n \\"Summary\\": \\"\\",\\n \\"Keywords\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"zCXSmY0CJbybp6FZV7vo0Wjw64X-*****\\",\\n \\"MaxResults\\": 20,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', + ], + 'ListFileUpload' => [ + 'summary' => 'ListFileUpload', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7997,228 +8754,223 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '您当前所在的DMS单元。若您选择分析数据库，该信息将用于后续通过DMS正确连接到您的DMS实例。您可前往DMS控制台查看您当前所在的DMS单元，若您是阿里云中国站用户，可以直接填入cn-hangzhou。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话 ID，必须字段。您可以通过CreateAgentSession获取SessionId。', - 'type' => 'string', - 'required' => true, - 'example' => 'sess_***', - ], + 'schema' => ['description' => '会话ID', 'type' => 'string', 'required' => false, 'example' => 'h8r********4fch'], ], [ - 'name' => 'AgentId', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'AgentId，必填。您可通过CreateAgentSession接口的返回值获取当前的AgentID。Agent资源存在生命周期，因此您每次请求需要填入的AgentID可能变化。', - 'type' => 'string', - 'required' => true, - 'example' => 'agent_***', - ], + 'schema' => ['description' => '文件ID', 'type' => 'string', 'required' => false, 'example' => 'f-8*******01m'."\n"], ], [ - 'name' => 'Message', + 'name' => 'CallFrom', 'in' => 'query', - 'schema' => [ - 'description' => '本次向Agent发送的消息内容', - 'type' => 'string', - 'required' => true, - 'example' => 'what can you do?', - ], + 'schema' => ['description' => '仅前端使用', 'type' => 'string', 'required' => false, 'example' => '仅前端使用'], ], [ - 'name' => 'MessageType', + 'name' => 'FileFrom', 'in' => 'query', - 'schema' => [ - 'description' => '消息类型，默认为 `[primary]`。当该消息为响应Agent的Human-in-Loop问题时，类型应当是`[additional]`；当该消息是要取消当前会话时，类型应当是`[cancel]`。', - 'type' => 'string', - 'required' => false, - 'example' => 'primary', - 'default' => 'primary', - 'enum' => [ - 'primary', - 'additional', - 'cancel', - 'operate', - ], - ], + 'schema' => ['description' => '文件来源', 'type' => 'string', 'required' => false, 'example' => 'Agent'], ], [ - 'name' => 'ReplyTo', + 'name' => 'FileCategory', 'in' => 'query', 'schema' => [ - 'description' => '表示这条消息是对哪条Agent消息的响应。该字段应当传入当前收到的最大的Checkpoint序号，若是首条消息则填入0。该字段会用于偶发网络问题或者消息重复发送时的消息去重。', + 'description' => '文件种类', 'type' => 'string', 'required' => false, - 'example' => '0', - 'default' => '0', + 'enumValueTitles' => ['WebReport' => '网页报告', 'TextReport' => '文字报告', 'DefaultArtifact' => '默认产物'], + 'example' => 'TextReport', ], ], [ - 'name' => 'QuotedMessage', + 'name' => 'SortColumn', 'in' => 'query', 'schema' => [ - 'description' => '传入当前引用内容，通常在与Agent交互时使用。', + 'description' => '排序列', 'type' => 'string', 'required' => false, - 'example' => '{"version":"v0"}', + 'enumValueTitles' => ['gmtCreated' => '创建时间'], + 'example' => 'gmtCreated', ], ], [ - 'name' => 'Question', + 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ - 'description' => '当消息类型为`additional`时为必须字段，传入Agent通过Human-in-Loop向用户提问的具体问题。', + 'description' => '排列顺序', 'type' => 'string', 'required' => false, - 'example' => '请提供计算GMV的口径。', + 'enumValueTitles' => ['asc' => '升序', 'desc' => '降序'], + 'example' => 'asc', ], ], [ - 'name' => 'DataSource', + 'name' => 'DownloadLinkExpire', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '下载链接有效时长（仅支持用户OSS上的文件），单位秒，默认3600秒'."\n" + .'- 最小时长：3600秒（1小时）'."\n" + .'- 最大时长：129600秒（36小时）'."\n" + ."\n" + .'其他注意：'."\n" + .'- 内置OSS（非用户OSS）上的文件下载链接，有效期为1小时'."\n" + .'- 用户OSS上的文件下载链接，该参数才生效，有效期支持设置1小时~36小时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据源信息，可为空'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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' => '需要分析的表名称的列表', + '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' => 'string', - 'required' => false, - 'example' => 'my_table', + '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' => '公网下载链接', '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' => '内网下载链接', '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'], + ], ], - '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, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取文件上传的列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListFileUpload', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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"}]', + ], + 'ListKnowledgeBases' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SessionConfig', - 'in' => 'query', - 'style' => 'json', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'formData', + 'schema' => ['description' => '知识库标签。在DataAgent产品里是空间ID', 'type' => 'string', 'required' => true, 'example' => '1dq7qod8hxtt1***'], + ], + [ + 'name' => 'NamePattern', + 'in' => 'formData', + 'schema' => ['description' => '知识库名字包含的字段', 'type' => 'string', 'required' => false, 'example' => 'order'], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => '限定每次返回的最大条数，可以和NextToken搭配使用实现翻页能力。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20'], + ], + [ + 'name' => 'Filters', + 'in' => 'formData', + 'schema' => ['description' => '知识库的过滤条件，JSON字符串表示。'."\n" + .'JSON取值：'."\n" + .'state：0/1', 'type' => 'string', 'required' => false, 'example' => '{"state":1}'], + ], + [ + 'name' => 'SortFieldName', + 'in' => 'formData', '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' => '示例水印', - ], - ], + 'description' => '排序字段，取值：'."\n" + ."\n" + .'- id：知识库ID（默认值）'."\n" + .'- name: 知识库名字', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['name' => 'name', 'id' => 'id'], + 'example' => 'name', ], ], [ - 'name' => 'ParentSessionId', - 'in' => 'query', + 'name' => 'SortOrder', + 'in' => 'formData', 'schema' => [ + 'description' => '排序方向。取值范围：'."\n" + .'- **ASC**（默认值）：升序'."\n" + .'- **DESC**：降序', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], + 'example' => 'Desc', ], ], ], @@ -8226,124 +8978,68 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Jarvis Web应用收到请求并缓存之后，会直接响应200。'."\n", + 'description' => 'Schema of Response', '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' => '""', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], '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', - ], + 'description' => '返回的结构体', + 'type' => 'array', + 'items' => ['description' => '返回结果', '$ref' => '#/components/schemas/OneMetaKnowledgeBase'], + ], + 'Success' => ['description' => '请求是否成功，返回值如下：true：请求成功 false：请求失败', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Specified parameter Tag is not valid.'], + 'TotalCount' => ['description' => '满足条件的知识库总数（目前暂不支持，返回值恒定为0）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'MaxResults' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20'], + 'NextToken' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取知识库的列表', + 'summary' => '分页查询知识库的列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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` 等字段均为可选，但提供了更详细的上下文信息。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"Data\\": [\\n {\\n \\"KbUuid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"State\\": 0,\\n \\"Tag\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"Domain\\": \\"\\",\\n \\"ExtraInfo\\": \\"\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tag is not valid.\\",\\n \\"TotalCount\\": 0,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\"\\n}","type":"json"}]', ], - 'DescribeDataAgentSession' => [ - 'summary' => '获取DataAgent会话描述信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkspaceCode' => [ + 'summary' => '列出工作空间目录下的code文件', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', - 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SessionId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Agent会话ID', - 'type' => 'string', - 'required' => false, - 'example' => 'c61n7gm******rj', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => true, 'example' => '56kv1pvl9uvt9**********bb'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => 'Notebook文件路径。', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb'], ], ], 'responses' => [ @@ -8353,202 +9049,58 @@ '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' => '返回的结构体', + 'title' => '返回的结果信息', + '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' => '会话回放历史', + 'List' => [ + 'description' => 'OSS Bucket名称。', 'type' => 'array', 'items' => [ - 'description' => '会话回放的元素', + 'description' => 'Airflow实例创建时间。', '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', + 'Name' => ['description' => '列的名称。', 'type' => 'string', 'example' => 'default'], + 'Symlink' => ['description' => 'symlink 软连接', 'type' => 'string', 'example' => '../abc.py'], + 'IsDir' => ['description' => '是否目录', 'type' => 'boolean', 'example' => 'true'], + 'Size' => ['description' => '文件大小，单位字节', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], + 'Mtime' => ['description' => '文件修改时间。'."\n" + ."\n" + .'执行ISO8601标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。'."\n" + ."\n" + .'仅当Type为File时，返回该值且有意义。', 'type' => 'string', 'example' => '2026-01-01T10:11:12Z'], ], ], ], - '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', - ], + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'InvalidTid'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求是否成功，返回值如下：true：请求成功 false：请求失败', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出工作空间里的代码文件', + 'description' => '发布工作空间的代码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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会话描述', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Name\\": \\"default\\",\\n \\"Symlink\\": \\"../abc.py\\",\\n \\"IsDir\\": true,\\n \\"Size\\": 59,\\n \\"Mtime\\": \\"2026-01-01T10:11:12Z\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'CreateDataAgentSession' => [ - 'summary' => '创建DataAgent会话', + 'ModifyCustomAgent' => [ + 'summary' => '在个人空间、工作空间中修改自定义Agent', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8557,146 +9109,227 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb'], ], [ - 'name' => 'Title', + 'name' => 'CustomAgentId', + 'in' => 'query', + 'schema' => ['description' => '自定义Agent Id', 'type' => 'string', 'required' => true, 'example' => 'ca-4y3ca4khkcu**********ysf'], + ], + [ + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => '自定义Agent名称', 'type' => 'string', 'required' => false, 'example' => 'Agent测试名称'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '自定义Agent描述', 'type' => 'string', 'required' => false, 'example' => 'Agent测试描述'], + ], + [ + 'name' => 'DataJson', + 'in' => 'query', + 'schema' => ['description' => '指定的数据范围，**JSON字符串格式**'."\n" + .'- 通用参数说明'."\n" + .' - tableFlag：true为指定数据范围'."\n" + .' - scope：personal为固定值'."\n" + .' - personal：文件、数据库类型的传参'."\n" + ."\n" + .'**文件类型**，按如下格式传参：'."\n" + .'- DataSourceType：remote_data_center为固定值'."\n" + .'- FileId：文件ID'."\n" + .'- Database：ListDataCenterTable接口返回的库名，通常为文件名'."\n" + .'- Tables：ListDataCenterTable接口返回的表名'."\n" + .'- TableIds：ListDataCenterTable接口返回的TableId'."\n" + .'- RegionId：当前地域'."\n" + .'```'."\n" + .'{'."\n" + .' "tableFlag": true,'."\n" + .' "scope": "personal",'."\n" + .' "personal": {'."\n" + .' "DataSourceType": "remote_data_center",'."\n" + .' "FileId": "f-f0jksn001ibmkoo********6v2zn6",'."\n" + .' "Database": "diamonds.csv",'."\n" + .' "Tables": ['."\n" + .' "diamonds"'."\n" + .' ],'."\n" + .' "TableIds": ['."\n" + .' "35hfn94pxl********50pi"'."\n" + .' ],'."\n" + .' "RegionId": "cn-hangzhou"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'**数据库类型**，按如下参数传参：'."\n" + .'- DataSourceType：database为固定值'."\n" + .'- DmsInstanceId：数据中心接口返回的DMS实例ID'."\n" + .'- DmsDatabaseId：数据中心接口返回的DMS数据库ID'."\n" + .'- FileId：实例名（已废弃）'."\n" + .'- DbName：数据中心接口返回的数据库名称'."\n" + .'- Database：数据中心接口返回的数据库名称'."\n" + .'- Tables：数据中心接口返回的表名'."\n" + .'- TableIds：数据中心接口返回的TableId'."\n" + .'- Engine：引擎类型（mysql、postgresql）'."\n" + .'- RegionId：当前地域'."\n" + .'```'."\n" + .'{'."\n" + .' "tableFlag": true,'."\n" + .' "scope": "personal",'."\n" + .' "personal": {'."\n" + .' "DataSourceType": "database",'."\n" + .' "DmsInstanceId": "284***8",'."\n" + .' "DmsDatabaseId": "769***45",'."\n" + .' "FileId": "pgm-bp15095e*******6t",'."\n" + .' "DbName": "pg_catalog",'."\n" + .' "Database": "pg_catalog",'."\n" + .' "Tables": ['."\n" + .' "pg_aggregate"'."\n" + .' ],'."\n" + .' "TableIds": ['."\n" + .' "5263****31"'."\n" + .' ],'."\n" + .' "Engine": "postgresql",'."\n" + .' "RegionId": "cn-hangzhou"'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'string', 'required' => false, '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" + .'}'."\n"], + ], + [ + 'name' => 'Instruction', + 'in' => 'query', + 'schema' => ['description' => '指示'."\n" + .'- 输入限制：最大 10000 字符', 'type' => 'string', 'required' => false, 'example' => '分析框架：'."\n" + .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n" + .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n" + .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；'], + ], + [ + 'name' => 'Knowledge', + 'in' => 'query', + 'schema' => ['description' => '知识'."\n" + .'- 输入限制：最大 10000 字符', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n" + .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n" + .'2、订单量为每日有效下单笔数；'."\n" + .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n" + .'4、转化率=支付订单数 / UV，反映流量转化效率；'], + ], + [ + 'name' => 'KnowledgeConfigList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '标题，支持中英文，最大长度128位。', - 'type' => 'string', + 'description' => '外部知识库', + 'type' => 'array', + 'items' => [ + 'description' => '外部知识库结构', + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'description' => '接入类型。'."\n" + ."\n" + .'- mcp：MCP方式接入', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['mcp' => 'MCP方式接入'], + 'example' => 'mcp', + ], + 'McpServerId' => ['description' => 'MCP Server 的 Id', 'type' => 'string', 'required' => false, 'example' => 'nhdpt9adf6ac**********ca'], + 'KbUuid' => ['type' => 'string'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '帮我分析一下这份数据，给出报告。', ], ], [ - 'name' => 'File', + 'name' => 'ExecutionConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '文件Id', - 'type' => 'string', + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => ['description' => '是否跳过计划确认步骤', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipSqlConfirm' => ['description' => '是否跳过所有SQL确认', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipWebReportConfirm' => ['description' => '是否跳过绘制网页报告确认', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SkipAskHuman' => ['description' => '是否禁止过程中用户询问', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'f-8*******01m', ], ], [ - 'name' => 'SessionConfig', + 'name' => 'ScheduleTaskConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '会话配置', - 'description' => '会话配置信息', + '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, - ], + 'RelatedSessionId' => ['description' => '参考的历史会话 id', 'type' => 'string', 'required' => false, 'example' => '4m24*****mg7j2v'], + 'CronExpression' => ['description' => '时间周期调度的 Cron 表达式', 'type' => 'string', 'required' => false, 'example' => '0 0 0,1 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'required' => false, 'example' => '分析一下这份数据，给出简报'], ], 'required' => false, ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'TextReportConfig', + 'in' => 'query', + 'schema' => ['description' => '文字报告格式'."\n" + .' - 输入限制：最大 10000 字符', 'type' => 'string', 'required' => false, 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + ], + [ + 'name' => 'WebReportConfig', + 'in' => 'query', + 'schema' => ['description' => '网页报告格式'."\n" + .'- 输入限制：最大 50000 字符', 'type' => 'string', 'required' => false, 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + ], + [ + 'name' => 'DMSUnit', + 'in' => 'query', + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'CallbackConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12****', + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], ], ], + [ + 'name' => 'RelatedSessionId', + 'in' => 'query', + 'schema' => ['title' => '参考历史会话Id', 'type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -8705,173 +9338,142 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1CB***********3F1A', - ], + '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' => '返回结构体', + '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', + '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', '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********'."\n"], + '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' => [ + 'description' => '外部知识库', + 'type' => 'array', + 'items' => [ + 'description' => '外部知识库结构', + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'description' => '接入类型'."\n" + .'- mcp：MCP方式接入', 'type' => 'string', - 'example' => '2q1tu90**********6uttu2nw', + 'enumValueTitles' => ['mcp' => 'MCP方式接入'], + 'example' => 'mcp', ], - ], - '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', + 'McpServerId' => ['description' => 'MCP Server 的 Id', 'type' => 'string', 'example' => 'nhdpt9adf6ac**********ca'], + 'KbUuid' => ['type' => 'string'], ], ], ], - 'CreateTime' => [ - 'description' => '会话的创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1765262307992', + 'ExecutionConfig' => [ + 'description' => '执行配置', + 'type' => 'object', + 'properties' => [ + 'SkipPlan' => ['description' => '是否跳过计划确认步骤', 'type' => 'boolean', 'example' => 'true'], + 'SkipSqlConfirm' => ['description' => '是否跳过所有SQL确认', 'type' => 'boolean', 'example' => 'true'], + 'SkipWebReportConfirm' => ['description' => '是否跳过绘制网页报告确认', 'type' => 'boolean', 'example' => 'true'], + 'SkipAskHuman' => ['description' => '是否禁止过程中用户询问', 'type' => 'boolean', 'example' => 'true'], + ], ], - 'Saved' => [ - 'description' => '是否被当前登录人收藏', - 'type' => 'boolean', - 'example' => 'false', + 'TextReportConfig' => ['description' => '文字报告格式', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + 'WebReportConfig' => ['description' => '网页报告格式', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字'], + 'CreatorUserName' => ['description' => '创建者名称', 'type' => 'string', 'example' => 'HaoY*****'], + 'ModifierUserName' => ['description' => '修改者名称', 'type' => 'string', 'example' => 'HaoY*****'], + 'DMSUnit' => ['description' => '当前DMS单元', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'IsScheduleTask' => ['description' => '是否配置周期运行任务', 'type' => 'boolean', 'example' => 'false'], + 'NextRuntime' => ['description' => '周期任务下次运行时间'."\n" + .'- 时间戳格式', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200'], + 'ScheduleTaskConfig' => [ + 'description' => '周期任务配置', + 'type' => 'object', + 'properties' => [ + 'RelatedSessionId' => ['description' => '参考的历史会话 id', 'type' => 'string', 'example' => '4m24*****mg7j2v'], + 'CronExpression' => ['description' => '时间周期调度的 Cron 表达式', 'type' => 'string', 'example' => '0 0 0 ? * 1-7'], + 'Query' => ['description' => '周期任务的问题', 'type' => 'string', 'example' => '分析一下这份数据，给出简报'], + ], ], + 'CallbackConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string'], + 'ToolId' => ['type' => 'string'], + 'CallbackPrompt' => ['type' => 'string'], + 'CallbackArgs' => ['type' => 'string'], + 'CallbackTime' => ['type' => 'integer', 'format' => 'int32'], + ], + ], + 'RelatedSessionId' => ['title' => '参考历史会话Id', 'type' => 'string'], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改自定义Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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会话', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:ModifyCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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\\",\\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 \\"KnowledgeConfigList\\": [\\n {\\n \\"AccessType\\": \\"mcp\\",\\n \\"McpServerId\\": \\"nhdpt9adf6ac**********ca\\",\\n \\"KbUuid\\": \\"\\"\\n }\\n ],\\n \\"ExecutionConfig\\": {\\n \\"SkipPlan\\": true,\\n \\"SkipSqlConfirm\\": true,\\n \\"SkipWebReportConfirm\\": true,\\n \\"SkipAskHuman\\": true\\n },\\n \\"TextReportConfig\\": \\"文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"WebReportConfig\\": \\"网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字\\",\\n \\"CreatorUserName\\": \\"HaoY*****\\",\\n \\"ModifierUserName\\": \\"HaoY*****\\",\\n \\"DMSUnit\\": \\"cn-hangzhou\\",\\n \\"IsScheduleTask\\": false,\\n \\"NextRuntime\\": 1767715200,\\n \\"ScheduleTaskConfig\\": {\\n \\"RelatedSessionId\\": \\"4m24*****mg7j2v\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1-7\\",\\n \\"Query\\": \\"分析一下这份数据，给出简报\\"\\n },\\n \\"CallbackConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ToolId\\": \\"\\",\\n \\"CallbackPrompt\\": \\"\\",\\n \\"CallbackArgs\\": \\"\\",\\n \\"CallbackTime\\": 0\\n },\\n \\"RelatedSessionId\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'ListFileUpload' => [ - 'summary' => 'ListFileUpload', + 'OperateCustomAgent' => [ + 'summary' => '在个人空间、工作空间中操作自定义Agent', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8880,107 +9482,346 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'DmsUnit', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb'], ], [ - 'name' => 'SessionId', + 'name' => 'CustomAgentId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID', - 'type' => 'string', - 'required' => false, - 'example' => 'h8r********4fch', - ], + 'schema' => ['description' => '自定义Agent Id', 'type' => 'string', 'required' => true, 'example' => 'ca-4y3ca4khkcu**********ysf'], ], [ - 'name' => 'FileId', + 'name' => 'OperateType', 'in' => 'query', 'schema' => [ - 'description' => '文件ID', + 'description' => '操作类型', 'type' => 'string', - 'required' => false, - 'example' => 'f-8*******01m'."\n", + 'required' => true, + 'enumValueTitles' => ['SET_DEFAULT' => '设置默认Agent', 'RELEASE' => '发布', 'CANCEL_DEFAULT' => '取消默认Agent', 'OFFLINE' => '下线'], + 'example' => 'RELEASE', ], ], - [ - 'name' => 'CallFrom', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '仅前端使用', - 'type' => 'string', - 'required' => false, - 'example' => '仅前端使用', + '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'], + 'Success' => ['description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '操作消息', 'type' => 'string', 'example' => 'Custom agent successfully released'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '操作自定义Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ [ - 'name' => 'FileFrom', - 'in' => 'query', - 'schema' => [ - 'description' => '文件来源', - 'type' => 'string', - 'required' => false, - 'example' => 'Agent', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:OperateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"Custom agent successfully released\\"\\n }\\n}","type":"json"}]', + ], + 'RedeployAirflow' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FileCategory', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + ], + 'parameters' => [ + [ + 'name' => 'AirflowId', 'in' => 'query', - 'schema' => [ - 'description' => '文件种类', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'WebReport' => '网页报告', - 'TextReport' => '文字报告', - 'DefaultArtifact' => '默认产物', - ], - 'example' => 'TextReport', - ], + 'schema' => ['title' => 'Airflow实例的唯一ID', 'description' => 'Airflow实例的唯一ID', 'type' => 'string', 'required' => true, 'example' => 'af-b3a7f110a6vmvn7****'], ], [ - 'name' => 'SortColumn', + 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '排序列', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'gmtCreated' => '创建时间', + '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' => '重部署结果', 'type' => 'boolean', 'example' => '{\'Responses\': {\'responses\': [{\'Uuid\': \'af-63ly5o1yuf076ifrpbxpka396\', \'Success\': True}]}}'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Successful'], + 'HttpStatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], - 'example' => 'gmtCreated', + 'description' => '', ], ], + ], + 'title' => '重新部署Airflow实例', + 'summary' => '重新部署Airflow实例', + 'description' => '重新部署Airflow实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Root\\": true,\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'RemoveUserToDataAgentWorkspace' => [ + 'summary' => '从空间中移除用户', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SortDirection', + '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' => [ - 'description' => '排列顺序', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '升序', - 'desc' => '降序', + '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.'], ], - 'example' => 'asc', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '从空间中移除用户', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + '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"}]', + ], + 'RetrieveKnowledgeBase' => [ + 'summary' => '检索知识库', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['description' => '查询内容。', 'type' => 'string', 'required' => true, 'example' => 'What is GraphRAG?'], + ], + [ + 'name' => 'TopK', + 'in' => 'formData', + 'schema' => ['description' => '返回 top 数量的结果。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => '要查询的数据的过滤条件，格式为 SQL 的 WHERE 格式。', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\''], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => ['description' => '检索时的相似度算法。此值为空时则采用创建知识库时指定的算法，建议如无特殊需求不需设置。'."\n" + ."\n" + .'可选值：'."\n" + .'- l2：欧氏距离。'."\n" + .'- ip：点积（内积）距离。'."\n" + .'- cosine：余弦相似度。', 'type' => 'string', 'required' => false, 'example' => 'cosine'], + ], + [ + 'name' => 'HybridSearch', + 'in' => 'formData', + 'schema' => ['description' => '多路召回算法，默认为空(即直接将稠密向量和全文的分数比较并排序)。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数k控制融合效果，详见HybridSearchArgs配置。'."\n" + .'- Weight：比重排序，采用参数控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置。'."\n" + .'- Cascaded：先全文检索再在其基础上进行向量检索。', 'type' => 'string', 'required' => false, 'example' => 'RRF'], + ], + [ + 'name' => 'HybridSearchArgs', + 'in' => 'formData', + 'schema' => ['description' => '多路召回的算法参数。目前支持RRF和Weight两种。HybridPathsSetting可以指定召回稠密向量（dense）、稀疏向量（sparse）和全文检索（fulltext），如果值为空，默认召回稠密向量（dense）和全文检索（fulltext）。'."\n" + ."\n" + .'- RRF：指定计算分数的算法的`1/(k+rank_i)`中的k常数，范围大于1的正整数，格式为：'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,fulltext"'."\n" + .' },'."\n" + .' "RRF": {'."\n" + .' "k": 60'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Weight: '."\n" + .' - 双路召回（不指定HybridPathsSetting，仅指定 alpha）：'."\n" + .' - 计算公式：alpha * dense_score + (1-alpha) * fulltext_score，参数 alpha 表示稠密向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只稠密向量：'."\n" + .'```'."\n" + .'{ '."\n" + .' "Weight": {'."\n" + .' "alpha": 0.5'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - 三路召回模式：'."\n" + .' - 计算公式：normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。其中dense、sparse、fulltext 分别代表稠密向量、稀疏向量、全文检索的权重，取值范围大于等于 0。系统会自动将权重归一化到 0～1（即 normalized_x = x / (dense + sparse + fulltext)）。'."\n" + .'```'."\n" + .'{'."\n" + .' "HybridPathsSetting": {'."\n" + .' "paths": "dense,sparse,fulltext"'."\n" + .' },'."\n" + .' "Weight": {'."\n" + .' "dense": 0.5,'."\n" + .' "sparse": 0.3,'."\n" + .' "fulltext": 0.2'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => '{ \\"Weight\\": { \\"alpha\\": 0.5 } }'], + ], + [ + 'name' => 'IncludeVector', + 'in' => 'formData', + 'schema' => ['description' => '是否返回向量。默认为false。'."\n" + .'> - **false**：不返回向量。'."\n" + .'> - **true**：返回向量。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'IncludeMetadataFields', + 'in' => 'formData', + 'schema' => ['description' => '默认为空，表示要返回的metadata字段，多个字段用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'title,page'], + ], + [ + 'name' => 'RerankFactor', + 'in' => 'formData', + 'schema' => ['description' => '重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1<RerankFactor<=5。'."\n" + .'> - 当文档切分稀疏时，重排效率慢。'."\n" + .'> - 建议重排个数（TopK*Factor（向上取整））不超过50。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RecallWindow', + 'in' => 'formData', + 'schema' => ['description' => '召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为2个元素的数组：List<A, B>，其中-10<=A<=0，0<=B<=10。'."\n" + .'> - 推荐当文档切分过碎、检索可能会丢失上下文信息时使用该参数。'."\n" + .'> - 重排优先窗口化，即先rerank，再窗口化处理。', 'type' => 'string', 'required' => false, 'example' => '[-5,5]'], + ], + [ + 'name' => 'OrderBy', + 'in' => 'formData', + 'schema' => ['description' => '默认为空，表示排序的依据字段。'."\n" + ."\n" + .'字段必须属于 metadata 或表里的默认字段比如 id，格式支持：'."\n" + ."\n" + .'单个字段，如 chunk_id； 多个字段，用逗号连接，如 block_id, chunk_id； 支持反序，如: block_id DESC, chunk_id DESC；', 'type' => 'string', 'required' => false, 'example' => 'created_at'], + ], + [ + 'name' => 'Offset', + 'in' => 'formData', + 'schema' => ['description' => '偏移量，用于分页查询', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -8988,809 +9829,586 @@ '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], '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' => '默认产物', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Results' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '向量数据的唯一 Id。', 'type' => 'string', 'example' => '3b35c95-57f3-442f-9220-xxxxx'], + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.'], + 'FileName' => ['description' => '文档名称。', 'type' => 'string', 'example' => '1.txt'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'string', 'example' => '{"page_pos": 1}'], + 'Score' => ['description' => '此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。', 'type' => 'number', 'format' => 'double', 'example' => '0.81'], + 'Vector' => [ + 'description' => '向量数据列表。', + 'type' => 'array', + 'items' => ['description' => '向量数据。', 'type' => 'number', 'format' => 'double', 'example' => '1.2123'], + ], + 'Metadata' => ['description' => '元数据 Map。', 'type' => 'object', 'example' => '{"title":"test"}'], + 'RerankScore' => ['description' => '重排分数。', 'type' => 'number', 'format' => 'double', 'example' => '6.2345'], + 'RetrievalSource' => ['description' => '检索结果的来源。1表示向量检索，2表示全文检索，3表示双路召回。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], - 'example' => 'TextReport', ], - 'GmtCreated' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-12-11T14:04:32.000+00:00', + ], + 'Matches' => [ + 'description' => '窗口化匹配到的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => '文本内容。', 'type' => 'string', 'example' => 'GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.'], + 'FileName' => ['description' => '文档名称。', 'type' => 'string', 'example' => '1.txt'], + 'Id' => ['description' => '向量数据的唯一 Id。', 'type' => 'string', 'example' => '3b35c95-57f3-442f-9220-xxxxx'], + 'LoaderMetadata' => ['description' => '文档加载器加载时的元信息。', 'type' => 'string', 'example' => '{"page_pos": 1}'], + 'Metadata' => ['description' => '元数据 Map。', 'type' => 'object', 'example' => '{"title":"test"}'], + ], ], ], ], ], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检索知识库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '获取文件上传的列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": {\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"3b35c95-57f3-442f-9220-xxxxx\\",\\n \\"Content\\": \\"GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.\\",\\n \\"FileName\\": \\"1.txt\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"Score\\": 0.81,\\n \\"Vector\\": [\\n 1.2123\\n ],\\n \\"Metadata\\": {\\n \\"title\\": \\"test\\"\\n },\\n \\"RerankScore\\": 6.2345,\\n \\"RetrievalSource\\": 1\\n }\\n ],\\n \\"Matches\\": [\\n {\\n \\"Content\\": \\"GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.\\",\\n \\"FileName\\": \\"1.txt\\",\\n \\"Id\\": \\"3b35c95-57f3-442f-9220-xxxxx\\",\\n \\"LoaderMetadata\\": \\"{\\\\\\"page_pos\\\\\\": 1}\\",\\n \\"Metadata\\": {\\n \\"title\\": \\"test\\"\\n }\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', ], - 'ListCustomAgent' => [ - 'summary' => 'ListCustomAgent 获取个人空间、工作空间中所有自定义Agent列表', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SaveWorkspaceCode' => [ + 'summary' => '保存工作空间代码，如果文件不存在则自动新建', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'operationType' => 'update', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['title' => '发布的工作空间ID（数字ID）', 'description' => '发布的工作空间ID（数字ID）', 'type' => 'string', 'required' => true, 'example' => '12345678'], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['title' => '发布的配置，json string。 repos列表为工作空间内的git repo，主要是设置发布的branch； exclude指定哪些目录跳过', 'description' => '保存的文件路径', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/test.py'], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => '代码内容', 'type' => 'string', 'required' => true, 'example' => 'print(123)'], + ], + [ + 'name' => 'Force', + 'in' => 'formData', + 'schema' => ['description' => '是否强制覆盖。不关心文件是否已经被其他改动，直接覆盖', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + ], + [ + 'name' => 'Repo', + 'in' => 'formData', + 'schema' => ['description' => '仓库信息。在save动作是创建一个 git repo 目录时传入', 'type' => 'string', 'required' => false, 'example' => 'git@codeup.aliyun.com:test/abc.git'], + ], + [ + 'name' => 'Mtime', + 'in' => 'formData', + 'schema' => ['description' => '文件修改时间。GetWorkspaceCode接口会返回这个mtime，'."\n" + .'在SaveWorkspaceCode的时候，带上这个mtime，来比对服务端是否有变化。'."\n" + .'如果mtime不匹配会提示保存失败，说明服务端的版本有变更了', 'type' => 'string', 'required' => false, 'example' => '2026-01-01T10:11:12Z'], + ], + [ + 'name' => 'Iac', + 'in' => 'formData', + 'schema' => ['description' => '是否是iac的模板文件，可视化编辑的yaml配置文件，请设置为true', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '56kv1pvl9uvt9**********bb', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '返回数据', 'type' => 'string', 'example' => '1'], + 'Message' => ['title' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'description' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'type' => 'string', 'example' => 'Failed to publish，repo branch empty'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'InvalidTid'], + 'Success' => ['description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '保存工作空间代码（新建、编辑）', + 'description' => '发布工作空间的代码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ [ - 'name' => 'SearchKey', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:SaveWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"1\\",\\n \\"Message\\": \\"Failed to publish，repo branch empty\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => false, 'example' => 'sess_***'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => 'AgentId，必填。您可通过CreateAgentSession接口的返回值获取当前的AgentID。Agent资源存在生命周期，因此您每次请求需要填入的AgentID可能变化。', 'type' => 'string', 'required' => false, 'example' => 'agent_***'], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => ['description' => '本次向Agent发送的消息内容', 'type' => 'string', 'required' => true, 'example' => 'what can you do?'], + ], + [ + 'name' => 'MessageType', 'in' => 'query', 'schema' => [ - 'description' => '搜索关键词，支持自定义Agent名称和描述模糊搜索。', + 'description' => '消息类型，默认为 `[primary]`。 '."\n" + ."\n" + .'- 常规情况下，和Agent交互，消息类型为 `[primary]`'."\n" + ."\n" + .'- 当该消息为响应Agent的Human-in-Loop问题时，类型应当是`[additional]`'."\n" + ."\n" + .'- 当该消息是要触发一次报告绘制时，类型应当是 `[report]`'."\n" + ."\n" + .'- 当该消息是要取消当前会话时，类型应当是`[cancel]`。', 'type' => 'string', 'required' => false, - 'example' => '测试Agent', + 'example' => 'primary', + 'default' => 'primary', + 'enum' => ['primary', 'additional', 'cancel', 'operate', 'report'], ], ], [ - 'name' => 'Status', + 'name' => 'ReplyTo', + 'in' => 'query', + 'schema' => ['description' => '**重要**'."\n" + ."\n" + .'当本消息是回复Agent消息（如：Agent通过 ASK_HUMAN进行问题澄清），则reply_to应当精确传入这条Agent消息携带的 Checkpoint 序号。若本消息无针对性的回复，如分析完成后要求Agent进一步深度分析，则 reply_to 可不填入或者填入"0"。 '."\n" + ."\n" + .'该字段会影响Agent决策如何处理该消息，若传递错误可能导致分析效果不及预期。', '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' => '自定义Agent状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NEW' => '新建-未发布', - 'RELEASED' => '已发布', - 'DRAFT' => '草稿-未发布', - 'OFFLINE' => '已下线', + 'description' => '数据源信息，可为空。此参数仅能传入一个数据源，建议更换为DataSources参数。', + '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******'], ], - 'example' => 'RELEASED', + 'required' => false, + 'example' => 'null', ], ], [ - 'name' => 'QueryAllReleased', + 'name' => 'SessionConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '查询所有已发布状态的自定义Agent，默认为false。', - 'type' => 'boolean', + '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' => '示例水印'], + 'Mode' => ['description' => '模式：'."\n" + .' - **ASK_DATA** 问数模式'."\n" + .' - **ANALYSIS** 分析模式'."\n" + .' - **INSIGHT** 洞察模式', 'type' => 'string', 'required' => false, 'example' => 'ANALYSIS'], + 'SkipPlan' => ['description' => '是否跳过计划确认步骤', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'SkipSqlConfirm' => ['description' => '是否跳过所有SQL确认', 'type' => 'boolean', 'required' => false, 'example' => 'False'], + 'SkipWebReportConfirm' => ['description' => '是否跳过绘制网页报告确认', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'SkipAskHuman' => ['description' => '是否禁止过程中用户询问', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'EnableSearch' => ['description' => '是否开启联网搜索。', 'type' => 'string', 'required' => false, 'example' => 'false'], + 'KbUuidList' => ['description' => '知识库ID列表', 'type' => 'string', 'required' => false, 'example' => 'dasd***cc211'], + 'McpServerIds' => ['description' => '会话配置中的 MCP 服务器 ID', 'type' => 'string', 'required' => false, 'example' => '2q1tu90**********6uttu2nw'], + 'PlanMode' => ['description' => '是否开启计划，可选[disable, enable, force]，默认值是enable', 'type' => 'string', 'required' => false, 'example' => 'disable'], + ], 'required' => false, - 'example' => 'true', ], ], [ - 'name' => 'PageNumber', + 'name' => 'ParentSessionId', + 'in' => 'query', + 'schema' => ['description' => '主会话id', 'type' => 'string', 'required' => false, 'example' => '20qrliuoo7p2vlsfg*****'], + ], + [ + 'name' => 'DataSources', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '分页页码，从1开始。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '数据源信息详细，可为空', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息详细，可为空', + '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' => 'f-4w*******'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'], + 'DbName' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'mydatabase'], + 'DmsInstanceId' => ['description' => '实例在 DMS 的 ID', 'type' => 'string', 'required' => false, 'example' => '248*****'], + 'DmsDatabaseId' => ['description' => '数据库在 DMS 的 ID', 'type' => 'string', 'required' => false, 'example' => '123****'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '1', ], ], [ - 'name' => 'PageSize', + 'name' => 'TaskConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '每页记录数，默认20。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '仅影响本次任务的配置项。', + 'type' => 'object', + 'properties' => [ + 'ReportConfig' => [ + 'description' => '报告规则的配置。仅当MesageType是REPORT时，会根据本次配置，执行一个报告任务。', + 'type' => 'object', + 'properties' => [ + 'ReportType' => ['description' => '服务类型。可填入TextReport和WebReport，表示本次任务是要生成一个文字报告或者网页报告。当前只支持WebReport类型。', 'type' => 'string', 'required' => false, 'example' => 'WebReport'], + 'ReportTheme' => ['description' => '报告主题。当前支持[default,journal,legacy,neobrutalism]', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'ReportPrompt' => ['description' => '本次报告需要遵循的prompt', 'type' => 'string', 'required' => false, 'example' => 'generate a report'], + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => '20', ], ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => 'c1p71ne***baexrt3o'], + ], + [ + 'name' => 'UserOssBucket', + 'in' => 'query', + 'schema' => ['description' => '用户OSS的Bucket，若不填，分析过程将安全存储在内置存储中。', 'type' => 'string', 'required' => false, 'example' => 'my-bucket'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Jarvis Web应用收到请求并缓存之后，会直接响应200。'."\n", '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.', - ], + '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' => '返回的结构体', + 'description' => '响应数据'."\n", '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', - ], + 'Message' => ['description' => 'Message'."\n", 'type' => 'string', 'example' => 'success'], + 'SessionId' => ['description' => 'SessionId'."\n", 'type' => 'string', 'example' => '6zbqbho********'], + 'AgentId' => ['description' => 'AgentId'."\n", 'type' => 'string', 'example' => '3jqqdiuxun******'], + 'MessageId' => ['description' => '消息ID。', 'type' => 'string', 'example' => '922d7fd2-77fb-4549-9091-d51da225d47f'], ], ], + 'Success' => ['description' => 'Success'."\n", 'type' => 'string', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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` 等字段均为可选，但提供了更详细的上下文信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:SendChatMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE65CE1F-****-****-****-******\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"SessionId\\": \\"6zbqbho********\\",\\n \\"AgentId\\": \\"3jqqdiuxun******\\",\\n \\"MessageId\\": \\"922d7fd2-77fb-4549-9091-d51da225d47f\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'DescribeCustomAgent' => [ - 'summary' => 'DescribeCustomAgent 根据自定义Agent ID获取详情描述信息', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SetWorkspaceCodePublishSetting' => [ + 'summary' => '设置工作空间代码部署配置。这是个异步接口，请求返回一个key，请根据key查询 WorkspaceActionStatus接口获取状态', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', + 'operationType' => 'update', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['title' => '发布的工作空间ID（数字ID）', 'description' => '发布的工作空间ID（数字ID）', 'type' => 'string', 'required' => true, 'example' => '12345678'], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['title' => '发布的配置，json string。 repos列表为工作空间内的git repo，主要是设置发布的branch； exclude指定哪些目录跳过', 'description' => '发布的配置，json string。 repos列表为工作空间内的git repo，主要是设置发布的branch； exclude指定哪些目录跳过', 'type' => 'string', 'required' => true, 'example' => '{"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '56kv1pvl9uvt9**********bb', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'description' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'type' => 'string', 'example' => 'Failed to publish，repo branch empty'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'HttpStatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '设置工作空间的代码发布配置', + 'description' => '设置工作空间的默认代码部署配置，主要是git repo的分支，以及需要排除的目录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Failed to publish，repo branch empty\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SetWorkspaceQuota' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CustomAgentId', + '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' => [ - 'description' => '自定义Agent Id。', - 'type' => 'string', - 'required' => false, - 'example' => 'ca-4y3ca4khkcu**********ysf', - ], + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20923*****7291'], + ], + [ + 'name' => 'CuQuota', + 'in' => 'query', + 'schema' => ['title' => 'CU配额', 'description' => 'CU配额', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['title' => '计费区域', 'description' => '计费区域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => ['title' => '是否自动支付', 'description' => '是否自动支付', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。', 'type' => 'string', 'required' => false, 'example' => 'acdxxx'], ], ], '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.', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'AccessDeniedDetail' => ['title' => '拒绝访问的详情', 'description' => '拒绝访问的详情', 'type' => 'string', 'example' => 'NOT_FOUND'], 'Data' => [ - 'description' => '返回结构体', + 'title' => '返回数据', + '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', - ], - ], - ], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'example' => '20923*****7291'], + 'InstanceId' => ['title' => '计费实例ID', 'description' => '计费实例ID', 'type' => 'string', 'example' => 'i-2zehld3y1tphzctyyq7o'], + 'CuQuota' => ['title' => 'CU配额', 'description' => 'CU配额', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'CuQuotaUsage' => ['title' => '已使用CU配额', 'description' => '已使用CU配额', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Status' => ['title' => '实例状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'Success'], + 'OrderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'string', 'example' => '263013787210103'], + 'State' => ['title' => '订单状态', 'description' => '订单状态', 'type' => 'string', 'example' => 'Catched'], ], ], + 'Message' => ['title' => '日志信息', 'description' => '日志信息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '设置工作空间配额', + 'summary' => '设置工作空间配额', + 'description' => '设置工作空间配额', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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详细描述', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"AccessDeniedDetail\\": \\"NOT_FOUND\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": \\"20923*****7291\\",\\n \\"InstanceId\\": \\"i-2zehld3y1tphzctyyq7o\\",\\n \\"CuQuota\\": 200,\\n \\"CuQuotaUsage\\": 20,\\n \\"Status\\": \\"Success\\",\\n \\"OrderId\\": \\"263013787210103\\",\\n \\"State\\": \\"Catched\\"\\n },\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateDataAgentWorkspaceMemberRole' => [ - 'summary' => '调整空间成员的角色', + 'StartDataAgentAccuracyTestTask' => [ + 'summary' => '发起准确率自测任务', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9799,54 +10417,37 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '协作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'MemberId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要调整的成员账号uid', - 'type' => 'string', - 'required' => false, - 'example' => '20282*****7591', - ], + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RoleName', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '需要调整到的角色名称', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => '创建资源使用的dmsUnit', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], + ], + [ + 'name' => 'CsvFile', + 'in' => 'query', + 'schema' => ['description' => '准确率测试样例', 'type' => 'string', 'required' => false, 'example' => '包含问题、答案[、SQL]的文件'], ], ], 'responses' => [ @@ -9856,342 +10457,277 @@ '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D94F5232-xxx-EH0H28FGGI5I'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- True：请求成功。 '."\n" + .'- False：请求失败。', 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Specified parameter Tid 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', - ], + 'AccuracyTestTaskId' => ['description' => '准确率测试任务ID', 'type' => 'string', 'example' => '692abb8f-xxx-77fec862db34'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动自测任务', + 'description' => '发起准确率自测任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '调整空间成员的角色', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D94F5232-xxx-EH0H28FGGI5I\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"AccuracyTestTaskId\\": \\"692abb8f-xxx-77fec862db34\\"\\n }\\n}","type":"json"}]', ], - 'ListDataAgentWorkspace' => [ - 'summary' => '获取主账号下的协作空间（分页）', + 'StopDataAgentAccuracyTestTask' => [ 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'AccuracyTestTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '准确率测试任务ID', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'."\n"], ], [ - 'name' => 'WorkspaceType', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询空间类型', - 'type' => 'string', - 'required' => true, - 'example' => 'MY', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'WorkspaceName', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => false, - 'example' => 'workspaceTest', + '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' => 'E0D21075-xxx-FD8AD04A63B6'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'UnknownError'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止准确率测试任务', + 'summary' => '停止准确率自测任务', + 'description' => '停止准确率自测任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-xxx-FD8AD04A63B6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]', + ], + 'UpdateAirflow' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', + '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' => '开始页号', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '客户端Token，用于保证请求的幂等性。', 'type' => 'string', 'required' => false, 'example' => 'token-****'], ], [ - 'name' => 'PageSize', + 'name' => 'AirflowId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数（个）', - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => 'Airflow的唯一键ID', 'description' => 'Airflow的唯一键ID。', 'type' => 'string', 'required' => true, 'example' => 'af-test****'], ], [ - 'name' => 'MaxResults', + 'name' => 'AirflowName', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'no use', - ], + 'schema' => ['title' => 'Airflow实例的名字', 'description' => 'Airflow实例的名称。', 'type' => 'string', 'required' => false, 'example' => 'testairflow'], ], [ - 'name' => 'NextToken', + 'name' => 'StartupFile', 'in' => 'query', - 'schema' => [ - 'description' => '令牌（Token）信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'no use', - ], + 'schema' => ['title' => 'Airflow实例的启动时加载的脚本', 'description' => 'Airflow实例的启动时加载的脚本。', 'type' => 'string', 'required' => false, 'example' => 'default/startup.sh'], ], [ - 'name' => 'Order', + 'name' => 'WorkerServerlessReplicas', 'in' => 'query', - 'schema' => [ - 'description' => '排序方式', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['title' => 'Worker节点个数', 'description' => 'Worker节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'OrderBy', + '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' => 'DataMountInfoList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '排序字段名称', - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/DataMountInfo'], ], ], + [ + 'name' => 'GracefulShutdownTimeout', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '60'], + ], + [ + 'name' => 'EnableServerless', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => 'DMS工作空间ID', 'description' => 'DMS工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '863024238280****'], + ], ], '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' => '返回结构体', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-F****'], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'NOT_FOUND'], + 'Root' => [ + 'description' => '更新后的详情信息。', 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => '每页空间数量（个）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'PageNumber' => [ - 'description' => '总共页数（页）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Content' => [ - 'description' => '配置内容', + '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' => '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', + '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'], + 'AirflowVersion' => ['type' => 'string', 'example' => '3.1'], + 'DataMountInfoList' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/DataMountInfo'], ], + 'EnableServerless' => ['type' => 'boolean'], + 'GracefulShutdownTimeout' => ['type' => 'integer', 'format' => 'int32', 'example' => '60'], ], ], - 'MaxResults' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'nu use', - ], - 'NextToken' => [ - 'description' => '令牌（Token）信息', - 'type' => 'string', - 'example' => 'no use', - ], + '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'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '更新Airflow实例信息', + 'summary' => '更新Airflow实例信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '将用户添加到指定的工作空间中', + 'UpdateDataAgentAccuracyTest' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10200,54 +10736,77 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'AccuracyTestInsId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '准确率测试实例ID', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => '数据中心中的FileId', 'type' => 'string', 'required' => false, 'example' => 'f-8*******01m'."\n"], + ], + [ + 'name' => 'CustomerAgentId', + 'in' => 'query', + 'schema' => ['description' => '新的自定义 Agent ID', 'type' => 'string', 'required' => false, 'example' => 'ca-xxxxxxxxxxxxxxxxxxxx'], + ], + [ + 'name' => 'Dataset', + 'in' => 'query', + 'schema' => ['description' => '数据源', 'type' => 'string', 'required' => false, 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxxxx\\",\\"DmsDatabaseId\\":\\"752xxxxx\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]'], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => ['description' => '需测试的分析模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'EvaluationPrompt', + 'in' => 'query', + 'schema' => ['description' => '准确率评判标准（空表示默认标准）', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '20923*****7291', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx'], ], [ - 'name' => 'MemberId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '用户的阿里云uid', - 'type' => 'string', - 'required' => false, - 'example' => '20282*****7591', - ], + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RoleName', + 'name' => 'DmsUnit', 'in' => 'query', - 'schema' => [ - 'description' => '用户在空间中的角色名称', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n"], + ], + [ + 'name' => 'MaxConcurrent', + 'in' => 'query', + 'schema' => ['description' => '测试中最大并发会话数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'NeedDelete', + 'in' => 'query', + 'schema' => ['description' => '分析后会话是否展示（暂不支持）', 'type' => 'boolean', 'required' => false, 'example' => 'no use'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '测试项名称', 'type' => 'string', 'required' => false, 'example' => 'test123'], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -10257,85 +10816,47 @@ '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'UnknownError'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Specified parameter Tid 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', - ], + 'FileId' => ['description' => '文件ID', 'type' => 'string', 'example' => 'f-8*******01m'."\n"], + 'AgentId' => ['description' => 'Agent Id', 'type' => 'string', 'example' => 'cu0cs*******mf'], + 'Dataset' => ['description' => '数据源（推荐在自定义agent中配置）', 'type' => 'string', 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxxxx\\",\\"DmsDatabaseId\\":\\"752xxxxx\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]'], + 'Mode' => ['description' => '分析模式', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'EvaluationPrompt' => ['description' => '准确率评判标准（空表示默认标准）', 'type' => 'string', 'example' => 'null'], + 'WorkspaceId' => ['description' => '空间ID', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx'], + 'AccuracyTest' => ['description' => '准确率测试项ID', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新准确率测试项', + 'summary' => '更新准确率测试项内容', + 'description' => '更新准确率测试项', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '为协作空间添加成员', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-xxx-FD8AD04A63B6\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"Data\\": {\\n \\"FileId\\": \\"f-8*******01m\\\\n\\",\\n \\"AgentId\\": \\"cu0cs*******mf\\",\\n \\"Dataset\\": \\"[{\\\\\\\\\\\\\\"DataSourceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"database\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"RegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DmsInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"27xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DmsDatabaseId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"752xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Database\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"employees\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tables\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"employees\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"salaries\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"departments\\\\\\\\\\\\\\"]}]\\",\\n \\"Mode\\": 0,\\n \\"EvaluationPrompt\\": \\"null\\",\\n \\"WorkspaceId\\": \\"8wfig6l33n4f4xxxxxxxxxx\\",\\n \\"AccuracyTest\\": \\"at-106n4rg17gv9fxxxxxxxxxx\\"\\n }\\n}","type":"json"}]', ], 'UpdateDataAgentSpaceInfo' => [ 'summary' => '更新空间的信息', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10347,50 +10868,39 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '协作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '20923*****7291', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '20923*****7291'], ], [ 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => '空间的新名称', - 'type' => 'string', - 'required' => false, - 'example' => 'yunqitest_v2', - ], + 'schema' => ['description' => '空间的新名称', 'type' => 'string', 'required' => false, 'example' => 'yunqitest_v2'], ], [ 'name' => 'WorkspaceDesc', 'in' => 'query', + 'schema' => ['description' => '空间的新描述', 'type' => 'string', 'required' => false, 'example' => 'space for test new'], + ], + [ + 'name' => 'IsSessionShareEnabled', + 'in' => 'query', 'schema' => [ - 'description' => '空间的新描述', - 'type' => 'string', + 'description' => '是否打开空间会话共享功能', + 'type' => 'boolean', 'required' => false, - 'example' => 'space for test new', + 'enumValueTitles' => ['false' => 'false'], + 'example' => 'true', ], ], ], @@ -10401,75 +10911,28 @@ '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.', - ], + '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', + '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'], + 'IsSessionShareEnabled' => [ + 'description' => '是否支持空间内会话共享', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', ], ], ], @@ -10477,21 +10940,33 @@ ], ], ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新空间的信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataAgentSpaceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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 \\"IsSessionShareEnabled\\": true\\n }\\n}","type":"json"}]', ], - 'CreateDataAgentWorkspace' => [ - 'summary' => '创建DataAgent协作空间', + 'UpdateDataAgentWorkspaceMemberRole' => [ + 'summary' => '调整空间成员的角色', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10500,44 +10975,32 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DMSUnit', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '当前DMS单元', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'WorkspaceName', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '协作空间名称', - 'type' => 'string', - 'required' => false, - 'example' => 'workspaceTest', - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => false, 'example' => '12****'], ], [ - 'name' => 'WorkspaceDesc', + 'name' => 'MemberId', 'in' => 'query', - 'schema' => [ - 'description' => '协作空间描述', - 'type' => 'string', - 'required' => false, - 'example' => 'Space for test', - ], + 'schema' => ['description' => '需要调整的成员账号uid', 'type' => 'string', 'required' => false, 'example' => '20282*****7591'], + ], + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => ['description' => '需要调整到的角色名称', 'type' => 'string', 'required' => false, 'example' => 'admin'], ], ], 'responses' => [ @@ -10547,220 +11010,287 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E0D2-*****-A63B6', - ], + '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', - ], - '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', - ], + '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'], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '调整空间成员的角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '创建协作空间', + 'ramActions' => [], + '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"}]', ], - 'ListDataAgentWorkspaceMember' => [ - 'summary' => '获取空间所有成员', + 'UpdateDataLakeDatabase' => [ + 'summary' => '调用此API可更新湖仓数据库信息。', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + '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' => '当前DMS单元', - 'type' => 'string', + 'description' => '数据库属性的键值对。', + 'type' => 'object', 'required' => false, - 'example' => 'cn-hangzhou', + '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' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '20923*****7291', + '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'], + 'title' => '更新湖仓数据库信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Description\\": \\"Default database for catalog hive\\\\n\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 19,\\n \\"CatalogName\\": \\"hive\\",\\n \\"Name\\": \\"default\\",\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateDataLakeFunction' => [ + 'summary' => '调用此API可更新湖仓自定义函数。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SearchMemberId', + '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' => '用于查询的成员ID前缀', - 'type' => 'string', - 'required' => false, - 'example' => '20273', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'SearchRoleName', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '用于查询的成员名称前缀', - 'type' => 'string', - 'required' => false, - 'example' => 'yunqi', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'PageNumber', + 'name' => 'FunctionInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => '函数的详细信息。', 'required' => true, '$ref' => '#/components/schemas/DLFunctionInput'], + ], + [ + 'name' => 'Tid', 'in' => 'query', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '租户ID。'."\n" + .'> 鼠标移动到界面右上角的头像处，查看租户ID。具体操作，请参见[查看租户信息](~~181330~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3****'], ], [ - 'name' => 'PageSize', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页空间数量（个）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], [ - 'name' => 'MaxResults', + 'name' => 'FunctionName', 'in' => 'query', + 'schema' => ['description' => '函数名称。', 'type' => 'string', 'required' => true, 'example' => 'my_funciton'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页大小（个）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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'], + 'title' => '更新湖仓自定义函数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1D39814-9808-47F8-AFE0-AF167239****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"my_funciton\\",\\n \\"OwnerName\\": \\"zhangsan\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"JAVA\\",\\n \\"CreateTime\\": 1731586286,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"JAR\\",\\n \\"Uri\\": \\"hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar\\"\\n }\\n ],\\n \\"ClassName\\": \\"com.example.hive.MyCustomUDF\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"DbName\\": \\"default\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]', + ], + 'UpdateDataLakePartition' => [ + 'summary' => '调用此API可更新湖仓表分区信息。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NextToken', + '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' => '令牌（Token）信息', - 'type' => 'string', - 'required' => false, - 'example' => 'NesLoK****', - ], + 'schema' => ['description' => '数据目录名。', 'type' => 'string', 'required' => true, 'example' => 'hive'], ], [ - 'name' => 'Order', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '升序/降序', - 'type' => 'string', - 'required' => false, - 'example' => 'Desc', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'OrderBy', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '排序依据', - 'type' => 'string', - 'required' => false, - 'example' => 'gmt_create', - ], + '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' => [ @@ -10770,165 +11300,90 @@ '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', - ], - ], - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新湖仓表分区信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取工作空间的成员信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteDataAgentWorkspace' => [ - 'summary' => '删除DataAgent协作空间', + 'UpdateDataLakeTable' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'CatalogName', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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' => 'string', - 'required' => false, - 'example' => '20923*****7291', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'], ], ], 'responses' => [ @@ -10938,46 +11393,109 @@ '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.', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新湖仓表信息', + 'summary' => '调用此API可更新湖仓表信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '删除协作空间', + '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\\": \\"zhangsan\\",\\n \\"TableType\\": \\"EXTERNAL_TABLE\\",\\n \\"Parameters\\": {\\n \\"EXTERNAL\\": \\"TRUE\\",\\n \\"delta.minReaderVersion\\": \\"1\\"\\n },\\n \\"Description\\": \\"test\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 1731586286,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 1,\\n \\"Col\\": \\"col1\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\\\\\"123\\\\\\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"col1\\"\\n ]\\n },\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.SequenceFileInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"IsCompressed\\": false,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"DeserializerClass\\": \\"org.apache.hadoop.hive.serde2.OpenCSVSerde\\",\\n \\"Parameters\\": {\\n \\"serialization.format\\": \\"1\\"\\n },\\n \\"Description\\": \\"\\\\\\"serialize\\\\\\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"Name\\": \\"name\\"\\n },\\n \\"BucketCols\\": [\\n \\"2010\\"\\n ],\\n \\"NumBuckets\\": -1,\\n \\"Location\\": \\"oss://xxx\\"\\n },\\n \\"LastAccessTime\\": 1608707407,\\n \\"Retention\\": 300,\\n \\"Name\\": \\"100g_customer\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"ViewExpandedText\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DbId\\": 19,\\n \\"DbName\\": \\"default\\",\\n \\"CatalogName\\": \\"hive\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"from deserializer\\",\\n \\"Type\\": \\"string\\",\\n \\"Name\\": \\"col\\"\\n }\\n ],\\n \\"ModifierId\\": 1410769,\\n \\"Location\\": \\"oss://xxx\\"\\n }\\n}","type":"json"}]', ], - 'RemoveUserToDataAgentWorkspace' => [ - 'summary' => '从空间中移除用户', + 'UpdateDocument' => [ 'path' => '', - 'methods' => [ - 'post', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + [ + 'name' => 'NewDescription', + 'in' => 'formData', + 'schema' => ['description' => '新的文档描述。', 'type' => 'string', 'required' => true, 'example' => 'test123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => ['description' => '返回结构体。', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument'], + 'Success' => ['description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新文档', + 'summary' => '更新文档的描述信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"FileExt\\": \\"\\",\\n \\"DocumentLoaderName\\": \\"\\",\\n \\"TextSplitterName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"FileSize\\": 0,\\n \\"DocsCount\\": 0,\\n \\"State\\": 0,\\n \\"Summary\\": \\"\\",\\n \\"Keywords\\": \\"\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', + ], + 'UpdateKnowledgeBase' => [ + 'summary' => '更新知识库', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10986,45 +11504,145 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'KbUuid', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-HZ-zgr1***'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '知识库名称', 'type' => 'string', 'required' => false, 'example' => 'updated kb name'], + ], + [ + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => '知识库描述', 'type' => 'string', 'required' => false, 'example' => 'updated kb desc'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '协作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '20923*****7291'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], + 'Data' => ['description' => '返回结构体', '$ref' => '#/components/schemas/OneMetaKnowledgeBase'], + 'Success' => ['description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新知识库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"State\\": 0,\\n \\"Tag\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"Domain\\": \\"\\",\\n \\"ExtraInfo\\": \\"\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', + ], + 'UploadDocument' => [ + 'summary' => '上传文档到知识库', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MemberId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], + ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + [ + 'name' => 'Location', + 'in' => 'formData', + 'schema' => ['description' => '输入文件的OSS Location，格式：'."\n" + .'DescribeKnowledgeBaseUploadSignature接口的UploadDir字段值 + 文件名。', 'type' => 'string', 'required' => true, 'example' => 'knowledge_base/1666698629****/kb-***'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => '文档描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'ChunkSize', + 'in' => 'formData', + 'schema' => ['description' => '要切分的知识块大小。默认值为250，最大值为 2048。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '250'], + ], + [ + 'name' => 'ChunkOverlap', + 'in' => 'formData', + 'schema' => ['description' => '知识块之间重叠的数据大小。此参数的最大值不能大于 ChunkSize 参数的值，默认值为50。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'Separators', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '要移除的成员账号uid', - 'type' => 'string', + 'description' => '用于分割大量数据的分隔符。'."\n" + .'> * 这是一个重要的参数，决定了数据分块的效果。此参数与由TextSplitterName参数指定的分隔器相关。'."\n" + .'>* 在大多数情况下，您不需要指定此参数。服务器会根据TextSplitterName参数的值来分配分隔符。', + 'type' => 'array', + 'items' => ['description' => '分隔符。', 'type' => 'string', 'required' => false, 'example' => '\\n'], 'required' => false, - 'example' => '21482*****7584', ], ], + [ + 'name' => 'ZhTitleEnhance', + 'in' => 'formData', + 'schema' => ['description' => '指定是否启用标题增强。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'TextSplitterName', + 'in' => 'formData', + 'schema' => ['description' => '分隔器的名称。', 'type' => 'string', 'required' => false, 'example' => 'ChineseRecursiveTextSplitter'], + ], + [ + 'name' => 'DocumentLoaderName', + 'in' => 'formData', + 'schema' => ['description' => '文档加载器的名称，默认采用 ADBPGLoader。', 'type' => 'string', 'required' => false, 'example' => 'ADBPGLoader'], + ], + [ + 'name' => 'VlEnhance', + 'in' => 'formData', + 'schema' => ['description' => '指定是否开启复杂文档的 VL 增强内容识别，默认值为 false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'SplitterModel', + 'in' => 'formData', + 'schema' => ['description' => '切分模型，默认值为 qwen3-8b。', 'type' => 'string', 'required' => false, 'example' => 'qwen3-8b'], + ], ], 'responses' => [ 200 => [ @@ -11033,85 +11651,202 @@ '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。 '."\n" + .'- **false**：请求失败。', 'type' => 'boolean'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + 'Data' => ['description' => '返回结构体', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '上传文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '从空间中移除用户', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\",\\n \\"Data\\": {\\n \\"KbUuid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"FileExt\\": \\"\\",\\n \\"DocumentLoaderName\\": \\"\\",\\n \\"TextSplitterName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"FileSize\\": 0,\\n \\"DocsCount\\": 0,\\n \\"State\\": 0,\\n \\"Summary\\": \\"\\",\\n \\"Keywords\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'GetDataAgentSubAccountInfo' => [ - 'summary' => '获取主账号下的子账号信息', + 'UpsertDocumentChunks' => [ 'path' => '', - 'methods' => [ - 'get', - 'post', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'], ], + 'parameters' => [ + [ + 'name' => 'KbUuid', + 'in' => 'formData', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'kb-***'], + ], + [ + 'name' => 'DocumentName', + 'in' => 'formData', + 'schema' => ['description' => '文档名称。', 'type' => 'string', 'required' => true, 'example' => 'test.md'], + ], + [ + 'name' => 'Chunks', + 'in' => 'formData', + 'schema' => ['description' => '文档块列表。', 'type' => 'string', 'required' => true, 'example' => '['."\n" + .' {'."\n" + .' "Id": "2e12aeb5-52cd-4834-bcd8-****",'."\n" + .' "Content": "test1"'."\n" + .' },'."\n" + .' {'."\n" + .' "Id": "2fdnwefi5-dsad-4t35-bcd8-****",'."\n" + .' "Content": "test2"'."\n" + .' }'."\n" + .']'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'Data' => ['description' => '更新是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：更新成功。'."\n" + .'- **false**：更新失败。', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码，请求异常时返回。', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound'], + 'ErrorMessage' => ['description' => '调用失败时，返回的错误信息。', 'type' => 'string', 'example' => 'Resource not found kb-***'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新知识块', + 'summary' => '更新知识块', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"KnowledgeBaseNotFound\\",\\n \\"ErrorMessage\\": \\"Resource not found kb-***\\"\\n}","type":"json"}]', + ], + 'WorkspaceActionLog' => [ + 'summary' => '工作空间异步操作日志查询接口', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DmsUnit', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['description' => '协作空间ID', 'type' => 'string', 'required' => true, 'example' => '12****'], ], [ - 'name' => 'SubAccountId', + 'name' => 'Key', 'in' => 'query', + 'schema' => ['description' => '会话回放历史的Key', 'type' => 'string', 'required' => true, 'example' => 'qps'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '子账号的阿里云uid', - 'type' => 'string', - 'required' => false, - 'example' => '20282*****7591', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'Data' => ['title' => '日志文本', 'description' => '日志文本', 'type' => 'string', 'example' => 'log info'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'], + 'HttpStatusCode' => ['description' => '错误码描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '请求是否成功，取值'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '异步任务日志查看', + 'description' => '传入key，可查看异步任务的执行日志，供问题排查用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"Data\\": \\"log info\\",\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'WorkspaceActionStatus' => [ + 'summary' => '工作空间异步操作状态查询接口，比如部署代码接口返回一个key，根据这个key来查这个status接口，即可获取到状态', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '会话回放历史的Key', 'type' => 'string', 'required' => true, 'example' => 'ws-xxx-xxxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -11119,116 +11854,83 @@ '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' => '返回结构体', + 'title' => '返回的结果信息', + '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', + 'Status' => [ + 'title' => '异步动作的执行结果: SUCCESS/ERROR/TIMEOUT/CANCEL', + 'description' => '异步动作的执行结果: SUCCESS/ERROR/TIMEOUT/CANCEL', 'type' => 'string', - 'example' => '167*****166', + 'required' => true, + 'example' => '{\'phase\': \'Created\', \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}', + 'enum' => ['ERROR', 'TIMEOUT', 'SUCCESS', 'CANCEL', 'QUEUED', 'RUNNING'], ], + 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'example' => '2026-01-13T14:30:20.582182728+08:00'], + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'example' => '2026-01-13T14:30:20.582182728+08:00'], + 'Data' => ['title' => '当错误时，这里返回错误信息', 'description' => '当错误时，这里返回错误信息', 'type' => 'string', 'example' => 'action failed'], ], ], + 'Message' => ['title' => '请求失败时的错误消息', 'description' => '请求失败时的错误消息', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidTid'], + 'HttpStatusCode' => ['description' => '错误码描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求是否成功，返回值如下：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - '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' => '获取主账号下的子账号信息', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '异步任务状态查看', + 'description' => '传入key，获取异步任务的状态。'."\n" + .'key可以在部署等动作接口的返回中获得', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Status\\": \\"{\'phase\': \'Created\', \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}\\",\\n \\"StartTime\\": \\"2026-01-13T14:30:20.582182728+08:00\\",\\n \\"EndTime\\": \\"2026-01-13T14:30:20.582182728+08:00\\",\\n \\"Data\\": \\"action failed\\"\\n },\\n \\"Message\\": \\"This record is being collected, please wait for a moment.\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetDataAgentWorkspaceInfo' => [ - 'summary' => '获取协作空间详细信息', + 'WorkspaceCodePublish' => [ + 'summary' => '工作空间代码部署接口。这是个异步接口，请求返回一个key，请根据key查询 WorkspaceActionStatus接口获取状态', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', + 'operationType' => 'update', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdmsKIHNZQ', - ], + 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DMSUnit', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '当前DMS单元', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '发布的工作空间ID（数字ID）', 'description' => '部署操作的工作空间ID（数字ID）', 'type' => 'string', 'required' => true, 'example' => '12345678'], ], [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '协作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '20923*****7291', - ], + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['title' => '发布的配置，json string。 repos列表为工作空间内的git repo，主要是设置发布的branch； exclude指定哪些目录跳过', 'description' => '部署的配置，json string。 repos列表为工作空间内的git repo，主要是设置发布的branch； exclude指定哪些目录跳过', 'type' => 'string', 'required' => true, 'example' => '{"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}'], ], ], 'responses' => [ @@ -11238,109 +11940,1349 @@ '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' => '返回结构体', + 'title' => 'job', + 'description' => 'job', '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', - ], + 'Key' => ['description' => '会话回放历史的Key', 'type' => 'string', 'example' => 'ws-xxxx-xxxxxx'], ], ], + 'Message' => ['title' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'description' => '错误信息，在接口失败时，返回具体错误信息，成功时则为空', 'type' => 'string', 'example' => 'Failed to deploy，repo branch empty'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UnknownError'], + 'Success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '工作空间代码部署', + 'description' => '发布工作空间的代码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], ], - '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' => '获取协作空间详细信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Key\\": \\"ws-xxxx-xxxxxx\\"\\n },\\n \\"Message\\": \\"Failed to deploy，repo branch empty\\",\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], ], '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', + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dms.cn-shenzhen.aliyuncs.com', 'vpc' => 'dms-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.cn-beijing.aliyuncs.com', 'endpoint' => 'dms.cn-beijing.aliyuncs.com', 'vpc' => 'dms-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.cn-shanghai.aliyuncs.com', 'endpoint' => 'dms.cn-shanghai.aliyuncs.com', 'vpc' => 'dms-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.cn-hongkong.aliyuncs.com', 'endpoint' => 'dms.cn-hongkong.aliyuncs.com', 'vpc' => 'dms-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dms.ap-southeast-1.aliyuncs.com', 'vpc' => 'dms-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dms.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dms.cn-hangzhou.aliyuncs.com', 'vpc' => 'dms-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dms.us-west-1.aliyuncs.com', 'endpoint' => 'dms.us-west-1.aliyuncs.com', 'vpc' => 'dms-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dms.us-east-1.aliyuncs.com', 'endpoint' => 'dms.us-east-1.aliyuncs.com', 'vpc' => 'dms-vpc.us-east-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'DMS-DA-40301', 'message' => 'Not enough Agent seats.', 'http_code' => 403, 'description' => 'Agent席位不足。'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dms', 'title' => '数据管理'], + ], + 'ram' => [ + 'productCode' => 'Dms', + 'productName' => '数据管理', + 'ramCodes' => ['dms'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetDataAgentSubAccountInfo', + 'description' => '获取主账号下的子账号信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataAgentSubAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeTable', + 'description' => '获取数据湖表列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataCenterTable', + 'description' => '获取数据中心用户上传的表列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataCenterTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchCreateDataLakePartitions', + 'description' => '批量新建湖仓表分区', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:BatchCreateDataLakePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataLakeFunction', + 'description' => '新建数据湖自定义函数', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeCustomAgent', + 'description' => '获取自定义Agent详细描述', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataAgentWorkspace', + 'description' => '删除协作空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:DeleteDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentAccuracyTestTasks', + 'description' => '列出准确率测试任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentAccuracyTestTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFileUpload', + 'description' => '删除上传文件', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteFileUpload', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataLakeFunction', + 'description' => '更新湖仓自定义函数', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveUserToDataAgentWorkspace', + 'description' => '从空间中移除用户', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:RemoveUserToDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataLakeCatalog', + 'description' => '获取数据湖的数据目录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeDatabase', + 'description' => '获取数据湖的数据库列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataLakeFunction', + 'description' => '获取湖仓自定义函数的详细信息', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataCenterDatabase', + 'description' => '获取数据中心用户上传的文件列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataCenterDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAirflow', + 'description' => '删除Airflow实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataLakePartition', + 'description' => '创建湖仓表分区', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataAgentKnowledgeBase', + 'description' => '创建DataAgent知识库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeKnowledgeBaseUploadSignature', + 'description' => '获取知识库上传文档的签名', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeKnowledgeBaseUploadSignature', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchUpdateDataLakePartitions', + 'description' => '批量更新湖仓表分区', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:BatchUpdateDataLakePartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkspaceCode', + 'description' => '列出工作空间里的代码文件', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFileUpload', + 'description' => '获取文件上传的列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListFileUpload', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeTablebaseInfo', + 'description' => '获取数据湖中表的基本信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTablebaseInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataLakeTable', + 'description' => '获取数据湖的表信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataAgentSession', + 'description' => '创建DataAgent会话', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAirflowLoginToken', + 'description' => '获取Airflow登录凭证', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:CreateAirflowLoginToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeFileUploadSignature', + 'description' => '获取文件上传签名信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeFileUploadSignature', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RedeployAirflow', + 'description' => '重新部署Airflow实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:RedeployAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDocumentChunks', + 'description' => '查询知识块列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDocumentChunks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopDataAgentAccuracyTestTask', + 'description' => '停止准确率测试任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:StopDataAgentAccuracyTestTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataLakeTable', + 'description' => '删除湖仓表', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataLakeDatabase', + 'description' => '更新湖仓数据库信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAirflows', + 'description' => '获取工作空间的Airflow实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListAirflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpsertDocumentChunks', + 'description' => '更新知识块', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpsertDocumentChunks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendChatMessage', + 'description' => '发送聊天消息', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:SendChatMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataLakeTable', + 'description' => '更新湖仓表信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDocument', + 'description' => '删除文档', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDocuments', + 'description' => '查询文档列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDocuments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDataAgentSession', + 'description' => '获取DataAgent会话描述', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:DescribeDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataLakePartition', + 'description' => '更新湖仓表分区信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataAgentSpaceInfo', + 'description' => '更新空间的信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataAgentSpaceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataAgentWorkspaceMemberRole', + 'description' => '调整空间成员的角色', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataAgentWorkspaceMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSqlConsoleOperationLog', + 'description' => '查询SQL窗口操作日志', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetSqlConsoleOperationLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataAgentAccuracyTest', + 'description' => '删除准确率测试项', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataAgentAccuracyTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FileUploadCallback', + 'description' => '文件上传后回调', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:FileUploadCallback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNotebookTaskStatus', + 'description' => '获取Notebook调度任务执行状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetNotebookTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataLakeDatabase', + 'description' => '创建湖仓数据库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataLakePartition', + 'description' => '获取湖仓表分区详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentSession', + 'description' => '获取DataAgent会话列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeCatalog', + 'description' => '获取数据湖的数据目录列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'WorkspaceActionStatus', + 'description' => '异步任务状态查看', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:WorkspaceActionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataLakeDatabase', + 'description' => '删除湖仓数据库', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteWorkspaceCode', + 'description' => '删除工作空间的代码及目录', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDocumentChunks', + 'description' => '删除知识块', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDocumentChunks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakePartitionName', + 'description' => '获取数据湖表分区名列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakePartitionName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentAccuracyTestInstances', + 'description' => '列出准确率自测配置项', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentAccuracyTestInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListKnowledgeBases', + 'description' => '获取知识库的列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListKnowledgeBases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetWorkspaceCodePublishSetting', + 'description' => '设置工作空间的代码发布配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:SetWorkspaceCodePublishSetting', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'WorkspaceActionLog', + 'description' => '异步任务日志查看', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:WorkspaceActionLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetWorkspaceQuota', + 'description' => '获取工作空间配额', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetWorkspaceQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetWorkspaceQuota', + 'description' => '设置工作空间配额', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:SetWorkspaceQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddUserToDataAgentWorkspace', + 'description' => '为协作空间添加成员', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:AddUserToDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeFunction', + 'description' => '获取数据湖函数列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakePartition', + 'description' => '获取数据湖表分区列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakePartition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetWorkspaceCode', + 'description' => '读取工作空间文件内容', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDocument', + 'description' => '查看文档详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartDataAgentAccuracyTestTask', + 'description' => '启动自测任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:StartDataAgentAccuracyTestTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UploadDocument', + 'description' => '上传文档', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:UploadDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RetrieveKnowledgeBase', + 'description' => '检索知识库', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:RetrieveKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAirflow', + 'description' => '更新Airflow实例信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataAgentKnowledgeBase', + 'description' => '删除DataAgent知识库', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteDataAgentKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataAgentAccuracyTest', + 'description' => '更新准确率测试项', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDataAgentAccuracyTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentAccuracyTestResults', + 'description' => '获取自测任务的执行结果', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentAccuracyTestResults', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'WorkspaceCodePublish', + 'description' => '工作空间代码部署', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:WorkspaceCodePublish', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataAgentWorkspace', + 'description' => '创建协作空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeFunctionName', + 'description' => '获取数据湖函数名称列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeFunctionName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataLakeTable', + 'description' => '新建湖仓表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataLakeTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetChatContent', + 'description' => '获取聊天内容', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetChatContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentWorkspace', + 'description' => '获取主账号下的协作空间', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OperateCustomAgent', + 'description' => '操作自定义Agent', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:OperateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataAgentWorkspaceMember', + 'description' => '获取工作空间的成员信息', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListDataAgentWorkspaceMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyCustomAgent', + 'description' => '修改自定义Agent', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:ModifyCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SaveWorkspaceCode', + 'description' => '保存工作空间代码（新建、编辑）', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:SaveWorkspaceCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAirflow', + 'description' => '创建Airflow实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataAgentAccuracyTest', + 'description' => '创建准确率测试实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateDataAgentAccuracyTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomAgent', + 'description' => '删除自定义Agent', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dms:DeleteCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetWorkspaceCodePublishSetting', + 'description' => '获取工作空间部署配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetWorkspaceCodePublishSetting', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakeTableName', + 'description' => '获取数据湖表名列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakeTableName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataLakePartitionByFilter', + 'description' => '根据筛选条件获取数据湖表分区列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListDataLakePartitionByFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCustomAgent', + 'description' => '创建自定义Agent', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dms:CreateCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ConfigAirflow', + 'description' => '更新Airflow实例的自定义配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:ConfigAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeKnowledgeBaseStats', + 'description' => '获取知识库的统计信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:DescribeKnowledgeBaseStats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCustomAgent', + 'description' => '获取自定义Agent列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dms:ListCustomAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataAgentWorkspaceInfo', + 'description' => '获取协作空间详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataAgentWorkspaceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAirflowVersions', + 'description' => '获取可用的Airflow版本列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:ListAirflowVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDocument', + 'description' => '更新文档', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateKnowledgeBase', + 'description' => '更新知识库', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dms:UpdateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataLakeDatabase', + 'description' => ' 获取数据湖的数据库信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetDataLakeDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAirflow', + 'description' => '获取Airflow实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dms:GetAirflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |