summaryrefslogtreecommitdiff
path: root/data/en_us/dms/2025-04-14
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dms/2025-04-14
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/dms/2025-04-14')
-rw-r--r--data/en_us/dms/2025-04-14/api-docs.php19074
1 files changed, 11152 insertions, 7922 deletions
diff --git a/data/en_us/dms/2025-04-14/api-docs.php b/data/en_us/dms/2025-04-14/api-docs.php
index 458a9e9..4cd91e9 100644
--- a/data/en_us/dms/2025-04-14/api-docs.php
+++ b/data/en_us/dms/2025-04-14/api-docs.php
@@ -1,1365 +1,822 @@
<?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' => null,
+ 'children' => ['CreateAirflowLoginToken', 'CreateAirflow', 'UpdateAirflow', 'GetAirflow', 'ListAirflows', 'DeleteAirflow'],
'type' => 'directory',
- 'children' => [
- 'CreateAirflowLoginToken',
- 'CreateAirflow',
- 'UpdateAirflow',
- 'UpdateAirflow',
- 'GetAirflow',
- 'ListAirflows',
- 'DeleteAirflow',
- ],
+ 'title' => 'Airflow',
],
[
- 'id' => 320239,
- 'title' => null,
- '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' => null,
'type' => 'directory',
- 'children' => [
- 'GetNotebookAndSubmitTask',
- 'GetNotebookTaskStatus',
- ],
+ 'title' => 'Data lake databases and tables',
],
[
- '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' => 'Others',
],
],
'components' => [
'schemas' => [
- 'DLCatalog' => [
- 'title' => 'Catalog',
+ 'AgenticCatalog' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CatalogType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DataSourceUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'StorageLocation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'State' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Properties' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''],
+ 'CatalogBizAttrs' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'visibility' => 'Public',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticDatabase' => [
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => 'Description',
+ 'CatalogUuid' => ['description' => 'The unique identifier of the catalog.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogName' => ['description' => 'The name of the catalog.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogType' => ['description' => 'The type of the catalog.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DatabaseUuid' => ['description' => 'The unique identifier of the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Name' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'QualifiedName' => ['description' => 'The fully qualified name of the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'SearchName' => ['description' => 'The name used to search the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Description' => ['description' => 'The database description.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'EngineMeta' => ['description' => 'The metadata for the database engine.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AgenticDatabaseEngineMeta'],
+ 'StorageLocation' => ['description' => 'The database storage location.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'RegionId' => ['description' => 'The region ID of the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'State' => ['description' => 'The database state.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'Properties' => ['description' => 'The database\'s extended properties.', 'type' => 'object', 'title' => '', 'example' => ''],
+ 'DatabaseBizAttrs' => ['description' => 'The database\'s business attributes.', 'type' => 'object', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Represents the metadata and properties of an agentic database.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticDatabaseEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemaName' => ['description' => 'The name of the database schema.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogName' => ['description' => 'The name of the database catalog.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Encoding' => ['description' => 'The character encoding for the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'StorageCapacity' => ['description' => 'The storage capacity of the database, in GB.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ ],
+ 'description' => 'The metadata for the database engine.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticDatabaseObject' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseUuid' => ['description' => 'The unique identifier (UUID) of the database that contains the object.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DatabaseQualifiedName' => ['description' => 'The fully qualified name of the database. This name uniquely identifies the database within the system.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ObjectName' => ['description' => 'The name of the database object, such as a table, view, or index.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ObjectType' => ['description' => 'The type of the database object. For example, `TABLE`, `VIEW`, or `INDEX`.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ObjectQualifiedName' => ['description' => 'The fully qualified name that uniquely identifies the object, typically formatted as <database>.<schema>.<object>.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DdlSql' => ['description' => 'The Data Definition Language (DDL) SQL statement that defines the object\'s structure.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Contains the details of a specific database object.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticDmsInstanceSyncTask' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SyncUserDataPermission' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'SuccessCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'FailedCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'SkippedCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorSummary' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ActorId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ActorType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ActorName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticDmsInstanceSyncTaskInstance' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DmsInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Phase' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DatasourceUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CatalogUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DmsRegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DmsInstanceSummary' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Host' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Port' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'Alias' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceResourceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceSource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'init default catalog',
- 'backendName' => 'description',
+ 'title' => '',
+ 'example' => '',
],
- 'Name' => [
- 'title' => 'Name',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'hive',
- 'backendName' => 'name',
+ 'CrawlerTaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorSummary' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticTableBaseInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DatabaseUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'QualifiedName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TableType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EngineMeta' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AgenticTableEngineMeta'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticTableColumn' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ColumnType' => ['description' => 'The data type of the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Description' => ['description' => 'The description of the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Position' => ['description' => 'The 1-based ordinal position of the column within the table.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'EngineMeta' => ['description' => 'Engine-specific metadata for the column.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AgenticTableColumnEngineMeta'],
+ ],
+ 'description' => 'Contains metadata for a column in a table.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticTableColumnEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Nullable' => ['description' => 'Indicates whether the column is nullable.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'AutoIncrement' => ['description' => 'Indicates whether the column uses auto-increment.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'DefaultValue' => ['description' => 'The default value of the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DataLength' => ['description' => 'The data length of the column. This parameter typically applies to string and binary data types.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'DataPrecision' => ['description' => 'The data precision of the column, which is the total number of digits in a numeric type.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'DataScale' => ['description' => 'The data scale of the column, which is the number of digits to the right of the decimal point in a numeric type.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Extra' => ['description' => 'Engine-specific attributes or flags for the column.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'GenerationColumn' => ['description' => 'Indicates whether the column is a generated column.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'GenerationExpression' => ['description' => 'The expression used to generate the column\'s value. Applies only if `GenerationColumn` is `true`.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Contains the engine-specific metadata for a table column.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticTableEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableSchemaName' => ['description' => 'The name of the table schema.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Encoding' => ['description' => 'The character encoding of the table.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CreateTime' => ['description' => 'The time the table was created, in UTC format (`YYYY-MM-DDThh:mm:ssZ`).', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'LastDdlTime' => ['description' => 'The timestamp of the last DDL (Data Definition Language) operation, in UTC format (`YYYY-MM-DDThh:mm:ssZ`).', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Engine' => ['description' => 'The table\'s storage engine, such as `InnoDB`.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'StorageCapacity' => ['description' => 'The table\'s total storage capacity, in bytes.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'DataBytes' => ['description' => 'The total size of the table\'s data, in bytes.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'IndexBytes' => ['description' => 'The total size of the table\'s indexes, in bytes.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'NumRows' => ['description' => 'The number of rows in the table.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'Checksum' => ['description' => 'A checksum to verify the table\'s data integrity.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'FullChecksum' => ['description' => 'A checksum of the table\'s data and indexes.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'RefInfo' => ['description' => 'The table\'s reference information.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Metadata for a table managed by the agentic engine.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgenticTableIndex' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexName' => ['description' => 'The unique name of the index within the table.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'IndexType' => ['description' => 'The type of the index, such as PRIMARY, UNIQUE, or NORMAL.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Description' => ['description' => 'An optional, user-defined description for the index.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ColumnNames' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of a column to include in the index.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'description' => 'An array of column names included in the index.',
+ 'title' => '',
+ 'example' => '',
],
- 'Location' => [
- 'title' => 'Location',
+ 'Primary' => ['description' => 'Specifies if the index is the primary key. A table can have only one primary key.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'Unique' => ['description' => 'Specifies if the index enforces a unique constraint, requiring all its values to be unique across rows.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'RealColumnNames' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The physical name of a column in the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'description' => 'An array of physical column names from the database. Use this parameter when the names in ColumnNames are aliases or logical names.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Defines a table index.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgentServiceOrderSummaryVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentService' => ['description' => 'The name of the agent service.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'OrderCount' => ['description' => 'The order count for the agent service.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'ServiceNumTotal' => ['description' => 'The total number of services.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'ModelCallQuota' => ['description' => 'The model call quota for the service.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'SkillPlanCallQuota' => ['description' => 'The skill plan call quota for the service.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'DeepResearchQuota' => ['description' => 'The deep research quota for the service.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ ],
+ 'description' => 'A summary of orders for an agent service.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AgentServiceOrderVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderInstanceId' => ['description' => 'The order instance ID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'AgentService' => ['description' => 'The agent service.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ServiceNum' => ['description' => 'The number of services.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'Status' => ['description' => 'The order status.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ExpireTime' => ['description' => 'The service expiration time, specified in UTC.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['description' => 'The order creation time, specified in UTC.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['description' => 'The order modification time, specified in UTC.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ModelCallUsed' => ['description' => 'The number of model calls used.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'ModelCallQuota' => ['description' => 'The model call quota.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'SkillPlanCallUsed' => ['description' => 'The number of skill plan calls used.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'SkillPlanCallQuota' => ['description' => 'The skill plan call quota.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'DeepResearchUsed' => ['description' => 'The quantity of deep research used.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'DeepResearchQuota' => ['description' => 'The deep research quota.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ ],
+ 'description' => 'Details of the agent service order view object.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DataAgentBillingInstance' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BillingInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PayLevel' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AgentSeats' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'FreeAgentSeats' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'SessionSeats' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'SessionAvailableDurationQuota' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'LLM' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'FreeLLM' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'TokenLimit' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ExpireTime' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'IsDefault' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreated' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'GmtModified' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'BoundWorkspaceIds' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'oss://xxxx',
- 'backendName' => 'location',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DataMountInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OssBucket' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'test-bucket'],
+ 'Prefix' => ['description' => 'The prefix. If this parameter is not specified, the root directory is used.', 'type' => 'string', 'title' => '', 'example' => '/prod'],
+ 'MountFolderName' => ['description' => 'The name of the mount directory. The actual mount path is prefixed with /Workspace/data/.', 'type' => 'string', 'title' => '', 'example' => 'image'],
+ 'ReadOnly' => ['description' => 'Whether to mount the data volume as read-only.'."\n"
+ ."\n"
+ .'Default value: false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ ],
+ 'required' => false,
+ 'description' => 'Specifies the data mount configuration for Airflow.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DLCatalog' => [
+ 'title' => 'Catalog',
+ 'description' => 'The details of the data catalog.',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['title' => 'Description', 'description' => 'The description of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'init default catalog'],
+ 'Name' => ['title' => 'Name', 'description' => 'The name of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'hive'],
+ 'Location' => ['title' => 'Location', 'description' => 'The storage path of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'example' => 'oss://xxxx'],
+ ],
],
'DLColumn' => [
'title' => 'Column',
- 'description' => '',
+ 'description' => 'The properties of a column.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'Comment' => [
- 'title' => 'comment',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'from deserializer',
- 'backendName' => 'comment',
- ],
- 'Type' => [
- 'title' => 'type',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'string',
- 'backendName' => 'type',
- ],
- 'Name' => [
- 'title' => 'name',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'col',
- 'backendName' => 'name',
- ],
+ 'Comment' => ['title' => 'comment', 'description' => 'The comment of the column.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'comment', 'example' => 'from deserializer'],
+ 'Type' => ['title' => 'type', 'description' => 'The data type of the column. Valid values include array, bigint, binary, boolean, char, date, decimal, double, float, int, interval, map, set, smallint, string, struct, timestamp, tinyint, union, and varchar.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'example' => 'string'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the column.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'col'],
],
],
'DLDatabase' => [
'title' => 'Database',
- 'description' => '',
+ 'description' => 'Data lakehouse database details.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- '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' => '',
- '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',
- ],
+ 'Description' => ['title' => 'description', 'description' => 'The description of the database.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'Default database for catalog hive'."\n"],
+ 'Parameters' => ['description' => 'The parameters of the database.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'parameters', 'title' => '', 'example' => 'key/value'],
+ 'DbId' => ['title' => 'dbId', 'description' => 'The ID of the database.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'dbId', 'example' => '19'],
+ 'CatalogName' => ['title' => 'catalogName', 'description' => 'The name of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'catalogName', 'example' => 'hive'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the database.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'default'],
+ 'Location' => ['title' => 'location', 'description' => 'The storage path of the database.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'example' => 'oss://xxx'],
],
],
'DLFunction' => [
- 'description' => '',
+ 'description' => 'The function information.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'FunctionName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my_funciton',
- 'backendName' => 'functionName',
- ],
- 'OwnerName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'zhangsan',
- 'backendName' => 'ownerName',
- ],
- 'OwnerType' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'USER',
- 'backendName' => 'ownerType',
- ],
- 'CreatorId' => [
- 'description' => '',
- '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',
- ],
+ 'FunctionName' => ['description' => 'The name of the function.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'functionName', 'title' => '', 'example' => 'my_funciton'],
+ 'OwnerName' => ['description' => 'The owner of the function.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerName', 'title' => '', 'example' => 'zhangsan'],
+ 'OwnerType' => ['description' => 'The type of the owner. Valid values:'."\n"
+ ."\n"
+ .'- ROLE'."\n"
+ ."\n"
+ .'- GROUP'."\n"
+ ."\n"
+ .'- USER', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerType', 'title' => '', 'example' => 'USER'],
+ 'CreatorId' => ['description' => 'The ID of the user who created the function.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'creatorId', 'title' => '', 'example' => '12****'],
+ 'FunctionType' => ['description' => 'The type of the function.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'functionType', 'title' => '', 'example' => 'JAVA'],
+ 'CreateTime' => ['description' => 'The time when the function was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'title' => '', 'example' => '1731586286'],
'ResourceUris' => [
- 'description' => '',
+ 'description' => 'The resource URIs of the function. This parameter cannot be modified after the function is created.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLResourceUri',
- ],
+ 'items' => ['description' => 'The URI used to access the resource.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLResourceUri', 'title' => '', 'example' => ''],
'backendName' => 'resourceUris',
+ 'title' => '',
+ 'example' => '',
],
- 'ClassName' => [
- 'description' => '',
- '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' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '26****',
- 'backendName' => 'modifierId',
- ],
+ 'ClassName' => ['description' => 'The Java class that contains the function code.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'className', 'title' => '', 'example' => 'com.example.hive.MyCustomUDF'],
+ 'CatalogName' => ['description' => 'The name of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'catalogName', 'title' => '', 'example' => 'hive'],
+ 'DbName' => ['description' => 'The name of the database.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dbName', 'title' => '', 'example' => 'default'],
+ 'ModifierId' => ['description' => 'The ID of the user who modified the function.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'modifierId', 'title' => '', 'example' => '26****'],
],
+ 'title' => '',
+ 'example' => '',
],
'DLFunctionInput' => [
- 'description' => '',
+ 'description' => 'Function information.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'FunctionName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my_funciton',
- 'backendName' => 'functionName',
- ],
- 'OwnerName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'zhangsan',
- 'backendName' => 'ownerName',
- ],
- 'OwnerType' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'USER',
- 'backendName' => 'ownerType',
- ],
- 'CreatorId' => [
- 'description' => '',
- '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',
- ],
+ 'FunctionName' => ['description' => 'The function name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'functionName', 'title' => '', 'example' => 'my_funciton'],
+ 'OwnerName' => ['description' => 'The owner of the function.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerName', 'title' => '', 'example' => 'zhangsan'],
+ 'OwnerType' => ['description' => 'The type of the owner. Valid values:'."\n"
+ ."\n"
+ .'- ROLE'."\n"
+ ."\n"
+ .'- GROUP'."\n"
+ ."\n"
+ .'- USER', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerType', 'title' => '', 'example' => 'USER'],
+ 'CreatorId' => ['description' => 'The ID of the user who created the function.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'creatorId', 'title' => '', 'example' => '12****'],
+ 'FunctionType' => ['description' => 'The function type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'functionType', 'title' => '', 'example' => 'JAVA'],
+ 'CreateTime' => ['description' => 'The time when the function was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'title' => '', 'example' => '1731586286'],
'ResourceUris' => [
- 'description' => '',
+ 'description' => 'The resource URIs of the function. This parameter cannot be modified after the function is created.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLResourceUri',
- ],
+ 'items' => ['description' => 'The URI used to access the resource.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLResourceUri', 'title' => '', 'example' => ''],
'backendName' => 'resourceUris',
+ 'title' => '',
+ 'example' => '',
],
- 'ClassName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'com.example.hive.MyCustomUDF',
- 'backendName' => 'className',
- ],
- 'ModifierId' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '26****',
- 'backendName' => 'modifierId',
- ],
+ 'ClassName' => ['description' => 'The Java class that contains the function code.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'className', 'title' => '', 'example' => 'com.example.hive.MyCustomUDF'],
+ 'ModifierId' => ['description' => 'The ID of the user who modified the function.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'modifierId', 'title' => '', 'example' => '26****'],
],
+ 'title' => '',
+ 'example' => '',
],
'DLOrder' => [
'title' => 'Order',
- 'description' => '',
+ 'description' => 'Information about column sorting.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- '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',
- ],
+ 'Order' => ['title' => 'order', 'description' => 'The position of the column in the sort order.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'order', 'example' => '1'],
+ 'Col' => ['title' => 'col', 'description' => 'The name of the column.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'col', 'example' => 'col1'],
],
],
'DLPartition' => [
- 'description' => '',
+ 'description' => 'The partition information.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'TableName' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'table_name',
- 'backendName' => 'tableName',
- ],
- 'Sd' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'sd',
- '$ref' => '#/components/schemas/DLStorageDescriptor',
- ],
+ 'TableName' => ['description' => 'The table name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'tableName', 'title' => '', 'example' => 'table_name'],
+ 'Sd' => ['description' => 'The data storage description.', 'visibility' => 'Public', 'backendName' => 'sd', '$ref' => '#/components/schemas/DLStorageDescriptor', 'title' => '', 'example' => ''],
'Parameters' => [
- 'description' => '',
+ 'description' => 'The key-value pairs for the partition.',
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{"key":"value"}',
- ],
+ 'additionalProperties' => ['description' => 'A key-value pair.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => '{"key":"value"}'],
'backendName' => 'parameters',
+ 'title' => '',
+ 'example' => '',
],
- 'CreateTime' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1735109884',
- 'backendName' => 'createTime',
- ],
+ 'CreateTime' => ['description' => 'The time when the partition was created. The time is a UNIX timestamp in seconds.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'title' => '', 'example' => '1735109884'],
'Values' => [
- 'description' => '',
+ 'description' => 'The partition values.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'part_val1',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'The value of the partition key column.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'part_val1'],
'backendName' => 'values',
+ 'title' => '',
+ 'example' => '',
],
- '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',
- ],
+ 'CatalogName' => ['description' => 'The name of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'catalogName', 'title' => '', 'example' => 'hive'],
+ 'DbName' => ['description' => 'The name of the database.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dbName', 'title' => '', 'example' => 'default'],
+ 'LastAccessTime' => ['description' => 'The time when the partition was last accessed.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lastAccessTime', 'title' => '', 'example' => '1608707407'],
],
+ 'title' => '',
+ 'example' => '',
],
'DLPartitionInput' => [
- 'description' => '',
+ 'description' => 'The partition information of a data lakehouse table.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Parameters' => [
- 'description' => '',
+ 'description' => 'The key-value pair parameters for the partition.',
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{"key":"value"}',
- ],
+ 'additionalProperties' => ['description' => 'A key-value pair.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => '{"key":"value"}'],
'backendName' => 'parameters',
+ 'title' => '',
+ 'example' => '',
],
- 'CreateTime' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1735109884',
- 'backendName' => 'createTime',
- ],
+ 'CreateTime' => ['description' => 'The time when the partition was created. This is a UNIX timestamp in seconds.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'title' => '', 'example' => '1735109884'],
'Values' => [
- 'description' => '',
+ 'description' => 'The partition values.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'part_val1',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'The value of a partition key column.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'part_val1'],
'backendName' => 'values',
+ 'title' => '',
+ 'example' => '',
],
- 'StorageDescriptor' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'sd',
- '$ref' => '#/components/schemas/DLStorageDescriptor',
- ],
- 'LastAccessTime' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1735109884',
- 'backendName' => 'lastAccessTime',
- ],
+ 'StorageDescriptor' => ['description' => 'The data storage information of the data lakehouse table.', 'visibility' => 'Public', 'backendName' => 'sd', '$ref' => '#/components/schemas/DLStorageDescriptor', 'title' => '', 'example' => ''],
+ 'LastAccessTime' => ['description' => 'The time when the partition was last accessed. This is a UNIX timestamp in seconds.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lastAccessTime', 'title' => '', 'example' => '1735109884'],
],
+ 'title' => '',
+ 'example' => '',
],
'DLResourceUri' => [
- 'description' => '',
+ 'description' => 'The resource information.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'ResourceType' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'JAR',
- 'backendName' => 'resourceType',
- ],
- 'Uri' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar',
- 'backendName' => 'uri',
- ],
+ 'ResourceType' => ['description' => 'The resource type. Valid values:'."\n"
+ ."\n"
+ .'- ARCHIVE'."\n"
+ ."\n"
+ .'- JAR'."\n"
+ ."\n"
+ .'- FILE', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'resourceType', 'example' => 'JAR', 'title' => ''],
+ 'Uri' => ['description' => 'The URL used to access the resource.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'uri', 'example' => 'hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar', 'title' => ''],
],
+ 'title' => '',
],
'DLSerdeInfo' => [
'title' => 'SerdeInfo',
- 'description' => '',
+ 'description' => 'Information about serialization and deserialization.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- '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',
- ],
- ],
+ 'SerializationLib' => ['title' => 'serializationLib', 'description' => 'The class name of the serialization library.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'serializationLib', 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe'],
+ 'DeserializerClass' => ['title' => 'deserializerClass', 'description' => 'The name of the class used for deserialization.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'deserializerClass', 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde'],
+ 'Parameters' => ['title' => 'parameters', 'description' => 'The key-value pairs of parameters related to serialization.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'parameters', 'example' => '{'."\n"
+ .' "serialization.format": "1"'."\n"
+ .'}'],
+ 'Description' => ['title' => 'description', 'description' => 'The description of the serialization.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => '"serialize"'],
+ 'SerdeType' => ['description' => 'The type of serialization.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'serdeType', 'title' => '', 'example' => '0'],
+ 'SerializerClass' => ['title' => 'serializerClass', 'description' => 'The name of the class used for serialization.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'serializerClass', 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the serialization.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'name'],
+ ],
+ 'example' => '',
],
'DLSkewedInfo' => [
'title' => 'SkewedInfo',
- 'description' => '',
+ 'description' => 'A data structure that stores information about skewed columns.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'SkewedColValues' => [
'title' => 'skewedColValues',
- 'description' => '',
+ 'description' => 'A list of skewed column values. Each list provides a set of associated values.',
'visibility' => 'Public',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A list of skewed values.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '"123"',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'A skewed value.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => '"123"', 'title' => ''],
'itemName' => 'SkewedColValue',
'extendType' => 'true',
+ 'title' => '',
+ 'example' => '',
],
'backendName' => 'skewedColValues',
'itemName' => 'SkewedColValue',
+ 'example' => '',
],
- 'SkewedColValueLocationMaps' => [
- 'title' => 'skewedColValueLocationMaps',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'object',
- 'example' => '{“col1”:"val1"}',
- 'backendName' => 'skewedColValueLocationMaps',
- ],
+ 'SkewedColValueLocationMaps' => ['title' => 'skewedColValueLocationMaps', 'description' => 'A mapping of skewed column values to their locations.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'skewedColValueLocationMaps', 'example' => '{“col1”:"val1"}'],
'SkewedColNames' => [
'title' => 'skewedColNames',
- 'description' => '',
+ 'description' => 'A list of skewed column names.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'col1',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'A skewed column name.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => 'col1', 'title' => ''],
'backendName' => 'skewedColNames',
'itemName' => 'SkewedColName',
+ 'example' => '',
],
],
+ 'example' => '',
],
'DLStorageDescriptor' => [
'title' => 'StorageDescriptor',
- 'description' => '',
+ 'description' => 'The data storage information for the data lakehouse table.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'OriginalColumns' => [
'title' => 'originalColumns',
- 'description' => '',
+ 'description' => 'The description of the original columns.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLColumn',
- ],
+ 'items' => ['description' => 'The column properties.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn', 'title' => '', 'example' => ''],
'backendName' => 'originalColumns',
'itemName' => 'OriginalColumn',
+ 'example' => '',
],
'SortCols' => [
'title' => 'sortCols',
- 'description' => '',
+ 'description' => 'The description of the sorted columns.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLOrder',
- ],
+ 'items' => ['description' => 'The column sorting information.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLOrder', 'title' => '', 'example' => ''],
'backendName' => 'sortCols',
'itemName' => 'SortCol',
+ 'example' => '',
],
- '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',
- ],
+ 'Parameters' => ['title' => 'parameters', 'description' => 'Other parameter mappings for data storage.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'parameters', 'example' => 'key/value'."\n"],
+ 'SkewedInfo' => ['title' => 'skewedInfo', 'description' => 'The data structure that stores information about skewed columns.', 'visibility' => 'Public', 'backendName' => 'skewedInfo', '$ref' => '#/components/schemas/DLSkewedInfo', 'example' => ''],
+ 'InputFormat' => ['title' => 'inputFormat', 'description' => 'The name of the input format class used to read data.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'inputFormat', 'example' => 'org.apache.hadoop.mapred.SequenceFileInputFormat'],
+ 'OutputFormat' => ['title' => 'outputFormat', 'description' => 'The name of the output format class used to write data.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'outputFormat', 'example' => 'org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat'],
'Columns' => [
'title' => 'columns',
- 'description' => '',
+ 'description' => 'The description of the data columns in the table.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLColumn',
- ],
+ 'items' => ['description' => 'The column properties.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn', 'title' => '', 'example' => ''],
'backendName' => 'columns',
'itemName' => 'Column',
+ 'example' => '',
],
- 'IsCompressed' => [
- 'title' => 'isCompressed',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'boolean',
- 'example' => 'false',
- 'backendName' => 'compressed',
- ],
- 'SerdeInfo' => [
- 'title' => 'serdeInfo',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'serdeInfo',
- '$ref' => '#/components/schemas/DLSerdeInfo',
- ],
+ 'IsCompressed' => ['title' => 'isCompressed', 'description' => 'Specifies whether the data is compressed.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'compressed', 'example' => 'false'],
+ 'SerdeInfo' => ['title' => 'serdeInfo', 'description' => 'The serialization and deserialization information.', 'visibility' => 'Public', 'backendName' => 'serdeInfo', '$ref' => '#/components/schemas/DLSerdeInfo', 'example' => ''],
'BucketCols' => [
'title' => 'bucketCols',
- 'description' => '',
+ 'description' => 'A list of bucket column names that determine the hash distribution of the data.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2010',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => '2010'],
'backendName' => 'bucketCols',
'itemName' => 'BucketCol',
+ 'example' => '',
],
- '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',
- ],
+ 'NumBuckets' => ['title' => 'numBuckets', 'description' => 'The number of buckets.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'numBuckets', 'example' => '-1'],
+ 'Location' => ['title' => 'location', 'description' => 'The specific location of the data storage.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'example' => 'oss://xxx'],
],
+ 'example' => '',
],
'DLTable' => [
'title' => 'Table',
- 'description' => '',
+ 'description' => 'The details of the table.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- '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' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'EXTERNAL_TABLE',
- 'backendName' => 'tableType',
- ],
- 'Parameters' => [
- 'title' => 'parameters',
- 'description' => '',
- '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' => '',
- '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' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'USER',
- 'backendName' => 'ownerType',
- ],
- 'ViewExpandedText' => [
- 'title' => 'viewExpandedText',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '""',
- 'backendName' => 'viewExpandedText',
- ],
- 'DbId' => [
- 'title' => 'dbId',
- 'description' => '',
- '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',
- ],
+ 'ViewOriginalText' => ['title' => 'viewOriginalText', 'description' => 'The original text of the view if the table is a view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewOriginalText', 'example' => '""'],
+ 'Owner' => ['title' => 'owner', 'description' => 'The name of the table owner.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'owner', 'example' => 'zhangsan'],
+ 'TableType' => ['title' => 'tableType', 'description' => 'The type of the metadata table, such as MANAGED\\_TABLE, EXTERNAL\\_TABLE, VIRTUAL\\_VIEW, INDEX\\_TABLE, or MATERIALIZED\\_VIEW.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'tableType', 'example' => 'EXTERNAL_TABLE'],
+ 'Parameters' => ['title' => 'parameters', 'description' => 'The key-value pairs of the parameters.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'parameters', 'example' => '{'."\n"
+ .' "EXTERNAL": "TRUE",'."\n"
+ .' "delta.minReaderVersion": "1"}'],
+ 'Description' => ['title' => 'description', 'description' => 'The description of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'test'],
+ 'CreatorId' => ['title' => 'creatorId', 'description' => 'The ID of the table creator.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'creatorId', 'example' => '8****'],
+ 'CreateTime' => ['title' => 'createTime', 'description' => 'The time when the table was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'example' => '1731586286'],
+ 'StorageDescriptor' => ['title' => 'StorageDescriptor', 'description' => 'The storage description, including the storage features and format details of the table.', 'visibility' => 'Public', 'backendName' => 'storageDescriptor', '$ref' => '#/components/schemas/DLStorageDescriptor', 'example' => ''],
+ 'LastAccessTime' => ['title' => 'lastAccessTime', 'description' => 'The time when the table was last accessed.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lastAccessTime', 'example' => '1608707407'],
+ 'Retention' => ['title' => 'retention', 'description' => 'The retention period of the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'retention', 'example' => '300'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => '100g_customer'],
+ 'OwnerType' => ['title' => 'ownerType', 'description' => 'The type of the owner. Valid values: USER, ROLE, and GROUP.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerType', 'example' => 'USER'],
+ 'ViewExpandedText' => ['title' => 'viewExpandedText', 'description' => 'The expanded text of the view if the table is a view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewExpandedText', 'example' => '""'],
+ 'DbId' => ['title' => 'dbId', 'description' => 'The ID of the database to which the table belongs.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'dbId', 'example' => '19'],
+ 'DbName' => ['title' => 'dbName', 'description' => 'The name of the database to which the table belongs.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dbName', 'example' => 'default'],
+ 'CatalogName' => ['title' => 'catalogName', 'description' => 'The name of the data catalog.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'catalogName', 'example' => 'hive'],
'PartitionKeys' => [
'title' => 'partitionKeys',
- 'description' => '',
+ 'description' => 'The list of partition keys.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLColumn',
- ],
+ 'items' => ['description' => 'The column information.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn', 'title' => '', 'example' => ''],
'backendName' => 'partitionKeys',
'itemName' => 'PartitionKey',
+ 'example' => '',
],
- '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',
- ],
+ 'ModifierId' => ['title' => 'modifierId', 'description' => 'The user who last modified the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'modifierId', 'example' => '1410769'],
+ 'Location' => ['title' => 'location', 'description' => 'The storage path of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'example' => 'oss://xxx'],
],
+ 'example' => '',
],
'DLTablebaseInfo' => [
'title' => 'TablebaseInfo',
- 'description' => '',
+ 'description' => 'The basic information of the table.',
'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' => '',
- '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' => '',
- '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',
- ],
+ 'Owner' => ['title' => 'owner', 'description' => 'The owner of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'owner', 'example' => 'test'],
+ 'ViewOriginalText' => ['title' => 'viewOriginalText', 'description' => 'The original text of the view if the table is a view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewOriginalText', 'example' => '""'."\n"],
+ 'TableType' => ['title' => 'tableType', 'description' => 'The type of the table. Examples include MANAGED\\_TABLE, EXTERNAL\\_TABLE, VIRTUAL\\_VIEW, INDEX\\_TABLE, and MATERIALIZED\\_VIEW.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'tableType', 'example' => 'EXTERNAL_TABLE'."\n"],
+ 'Parameters' => ['title' => 'parameters', 'description' => 'The additional parameters of the table.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'parameters', 'example' => ' "EXTERNAL": "TRUE"'."\n"],
+ 'Description' => ['title' => 'description', 'description' => 'The description of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => '"table"'."\n"],
+ 'CreatorId' => ['title' => 'creatorId', 'description' => 'The ID of the user who created the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'creatorId', 'example' => '141****'."\n"],
+ 'CreateTime' => ['title' => 'createTime', 'description' => 'The time when the table was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'example' => '1608707407'],
+ 'LastAccessTime' => ['title' => 'lastAccessTime', 'description' => 'The time when the table was last accessed.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lastAccessTime', 'example' => '1731586286'],
+ 'Retention' => ['title' => 'retention', 'description' => 'The retention period of the table, in days.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'retention', 'example' => '30000'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => '100g_customer'."\n"],
'OwnerType' => [
'title' => 'ownerType',
- 'description' => '',
+ 'description' => 'The type of the owner. Valid values: USER, ROLE, or GROUP.',
'visibility' => 'Public',
'type' => 'string',
- 'enumValueTitles' => [
- 'ROLE' => 'ROLE',
- 'GROUP' => 'GROUP',
- 'USER' => 'USER',
- ],
+ 'enumValueTitles' => ['ROLE' => 'ROLE', 'GROUP' => 'GROUP', 'USER' => 'USER'],
'backendName' => 'ownerType',
+ 'example' => 'USER',
],
- 'ViewExpandedText' => [
- 'title' => 'viewExpandedText',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '""'."\n",
- 'backendName' => 'viewExpandedText',
- ],
- 'DbId' => [
- 'title' => 'dbId',
- 'description' => '',
- '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',
- ],
+ 'ViewExpandedText' => ['title' => 'viewExpandedText', 'description' => 'The expanded text of the view if the table is a view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewExpandedText', 'example' => '""'."\n"],
+ 'DbId' => ['title' => 'dbId', 'description' => 'The ID of the database to which the table belongs.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'dbId', 'example' => '19'],
+ 'DbName' => ['title' => 'dbName', 'description' => 'The name of the database to which the table belongs.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dbName', 'example' => 'default'],
+ 'CatalogName' => ['title' => 'catalogName', 'description' => 'The data catalog to which the table belongs.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'catalogName', 'example' => 'hive'],
'PartitionKeys' => [
'title' => 'partitionKeys',
- 'description' => '',
+ 'description' => 'The list of column attributes.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLColumn',
- ],
+ 'items' => ['description' => 'The column attribute.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn', 'title' => '', 'example' => ''],
'backendName' => 'partitionKeys',
'itemName' => 'Column',
+ 'example' => '',
],
- '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',
- ],
+ 'ModifierId' => ['title' => 'modifierId', 'description' => 'The time when the table was modified.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'modifierId', 'example' => '1731585286'],
+ 'Location' => ['title' => 'location', 'description' => 'The storage path of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'example' => 'oss://xxx'],
],
+ 'example' => '',
],
'DLTableInput' => [
- 'description' => '',
+ 'description' => 'The details of the table.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'Owner' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'zhangsan'."\n",
- 'backendName' => 'owner',
- ],
- 'ViewOriginalText' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '""',
- 'backendName' => 'viewOriginalText',
- ],
- 'TableType' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'EXTERNAL_TABLE'."\n",
- 'backendName' => 'tableType',
- ],
+ 'Owner' => ['description' => 'The owner of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'owner', 'title' => '', 'example' => 'zhangsan'."\n"],
+ 'ViewOriginalText' => ['description' => 'If the table is a view, this parameter indicates the original text of the view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewOriginalText', 'title' => '', 'example' => '""'],
+ 'TableType' => ['description' => 'The type of the metadata table. Examples: MANAGED\\_TABLE, EXTERNAL\\_TABLE, VIRTUAL\\_VIEW, INDEX\\_TABLE, and MATERIALIZED\\_VIEW.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'tableType', 'title' => '', 'example' => 'EXTERNAL_TABLE'."\n"],
'Parameters' => [
- 'description' => '',
+ 'description' => 'The key-value pair parameters.',
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "EXTERNAL": "TRUE",'."\n"
- .' "delta.minReaderVersion": "1"}',
- ],
+ 'additionalProperties' => ['description' => 'The key and value of the parameter.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
+ .' "EXTERNAL": "TRUE",'."\n"
+ .' "delta.minReaderVersion": "1"}'],
'backendName' => 'parameters',
+ 'title' => '',
+ 'example' => '',
],
- 'Description' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test',
- 'backendName' => 'description',
- ],
- 'CreatorId' => [
- 'description' => '',
- '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' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'USER',
- 'backendName' => 'ownerType',
- ],
- 'ViewExpandedText' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '""',
- 'backendName' => 'viewExpandedText',
- ],
+ 'Description' => ['description' => 'The description of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => 'test'],
+ 'CreatorId' => ['description' => 'The ID of the user who created the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'creatorId', 'title' => '', 'example' => '8****'],
+ 'CreateTime' => ['description' => 'The time when the table was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'createTime', 'title' => '', 'example' => '1731586286'],
+ 'StorageDescriptor' => ['title' => 'storageDescriptor', 'description' => 'The storage description. This includes the storage features and format details of the table.', 'visibility' => 'Public', 'backendName' => 'storageDescriptor', '$ref' => '#/components/schemas/DLStorageDescriptor', 'example' => ''],
+ 'LastAccessTime' => ['description' => 'The time when the table was last accessed.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lastAccessTime', 'title' => '', 'example' => '1608707407'],
+ 'Retention' => ['description' => 'The retention period of the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'retention', 'title' => '', 'example' => '300'],
+ 'Name' => ['title' => 'name', 'description' => 'The name of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => '100g_customer'],
+ 'OwnerType' => ['description' => 'The type of the owner. Valid values: USER, ROLE, and GROUP.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ownerType', 'title' => '', 'example' => 'USER'],
+ 'ViewExpandedText' => ['description' => 'If the table is a view, this parameter indicates the expanded text of the view.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'viewExpandedText', 'title' => '', 'example' => '""'],
'PartitionKeys' => [
- 'description' => '',
+ 'description' => 'The list of attribute columns for the table.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/DLColumn',
- ],
+ 'items' => ['description' => 'The column information.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/DLColumn', 'title' => '', 'example' => ''],
'backendName' => 'partitionKeys',
+ 'title' => '',
+ 'example' => '',
],
- 'ModifierId' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1410769',
- 'backendName' => 'modifierId',
- ],
- 'Location' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'oss://xxx',
- 'backendName' => 'location',
- ],
+ 'ModifierId' => ['description' => 'The user who last modified the table.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'modifierId', 'title' => '', 'example' => '1410769'],
+ 'Location' => ['description' => 'The storage path of the table.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'location', 'title' => '', 'example' => 'oss://xxx'],
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DmsGatewayOrder' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BizType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'OrderId' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Region' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ExpireTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'State' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PayNum' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DmsKnowledgeSearchOrderInfoDO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The unique ID of the entry.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'OrderId' => ['description' => 'The unique ID of the order.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'AliyunAccountUid' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ApiKey' => ['description' => 'The API key used for authentication.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'WebSearchApiUrl' => ['description' => 'The endpoint URL for the web search API.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['description' => 'The time when the entry was created.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['description' => 'The time when the entry was last modified.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Contains the details of the knowledge search order.',
+ 'title' => '',
+ 'example' => '',
],
'ForeignInstance' => [
'description' => 'The information about the external data source.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'InstanceSource' => [
- 'description' => 'The source of the database instance. Valid values:'."\n"
- ."\n"
- .'* **PUBLIC_OWN:** a self-managed database instance that is deployed on the Internet.'."\n"
- .'* **RDS**: an ApsaraDB RDS instance.'."\n"
- .'* **ECS_OWN**: a self-managed database that is hosted on an Elastic Compute Service (ECS) instance.'."\n"
- .'* **VPC_IDC**: a self-managed database instance that is deployed in the data center over a virtual private cloud (VPC).'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'RDS',
- 'backendName' => 'instanceSource',
- ],
- 'Port' => [
- 'description' => 'The port number that is used to connect to the database instance.'."\n",
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7890',
- 'backendName' => 'port',
- ],
- 'Host' => [
- 'description' => 'The endpoint that is used to connect to the database instance.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '127.0.0.1',
- 'backendName' => 'host',
- ],
- 'RegionId' => [
- 'description' => 'The region ID.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- 'backendName' => 'regionId',
- ],
- 'InstanceType' => [
- 'description' => 'The type of the instance.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'mysql',
- 'backendName' => 'instanceType',
- ],
+ 'InstanceSource' => ['description' => 'The source of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **PUBLIC_OWN:** a self-managed database instance that is deployed on the Internet.'."\n"
+ .'* **RDS**: an ApsaraDB RDS instance.'."\n"
+ .'* **ECS_OWN**: a self-managed database that is hosted on an Elastic Compute Service (ECS) instance.'."\n"
+ .'* **VPC_IDC**: a self-managed database instance that is deployed in the data center over a virtual private cloud (VPC).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RDS', 'backendName' => 'instanceSource'],
+ 'Port' => ['description' => 'The port number that is used to connect to the database instance.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '7890', 'backendName' => 'port'],
+ 'Host' => ['description' => 'The endpoint that is used to connect to the database instance.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '127.0.0.1', 'backendName' => 'host'],
+ 'RegionId' => ['description' => 'The region ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai', 'backendName' => 'regionId'],
+ 'InstanceType' => ['description' => 'The type of the instance.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'mysql', 'backendName' => 'instanceType'],
'Properties' => [
'description' => 'The information of the properties.'."\n",
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => 'The information of the properties.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{\\"PackageUsedUpStrategyKey\\":\\"Postpaid\\"}',
- ],
+ 'additionalProperties' => ['description' => '属性信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{\\"PackageUsedUpStrategyKey\\":\\"Postpaid\\"}'],
'backendName' => 'properties',
],
- 'DataLinkName' => [
- 'description' => 'The name of the data link.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'dbl_mysql_2337',
- 'backendName' => 'dataLinkName',
- ],
- 'Sid' => [
- 'description' => 'The system identifier (SID) of the database.'."\n"
- ."\n"
- .'> The SID uniquely identifies an Oracle database. After a database is created, a SID is generated for the database.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'HXE',
- 'backendName' => 'sid',
- ],
+ 'DataLinkName' => ['description' => 'The name of the data link.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dbl_mysql_2337', 'backendName' => 'dataLinkName'],
+ 'Sid' => ['description' => 'The system identifier (SID) of the database.'."\n"
+ ."\n"
+ .'> The SID uniquely identifies an Oracle database. After a database is created, a SID is generated for the database.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'HXE', 'backendName' => 'sid'],
],
],
'ForeignInstanceCredInfo' => [
@@ -1371,700 +828,1048 @@
'description' => 'The information about the credential.'."\n",
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => 'The information about the credential.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{"username": "xxx", "password": "yyy"}',
- ],
+ 'additionalProperties' => ['description' => '凭证信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"username": "xxx", "password": "yyy"}'],
'backendName' => 'credInfo',
],
- 'CredType' => [
- 'description' => 'The type of the credential. Set the value to DEFAULT.'."\n",
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'DEFAULT',
- 'backendName' => 'credType',
+ 'CredType' => ['description' => 'The type of the credential. Set the value to DEFAULT.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'DEFAULT', 'backendName' => 'credType'],
+ ],
+ ],
+ 'ManagedDaOrderSummaryVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'totalQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'usedQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'availableQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'trialUsed' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'trialExpireTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'validOrderCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ManagedDaOrderVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'orderId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'subscriptionPlan' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'payNum' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'state' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'expireTime' => ['type' => 'string', 'format' => 'iso8601_normal', 'description' => '', 'title' => '', 'example' => ''],
+ 'region' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'instanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'gmtCreate' => ['type' => 'string', 'format' => 'iso8601_normal', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'MdbAgentInstanceVo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EngineType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EngineInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EngineRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PublicDomain' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'StatusDesc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'StatusMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LastActiveTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LockTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AccessUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaDatabase' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogUuid' => ['description' => 'The catalog UUID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogName' => ['description' => 'The catalog name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogType' => ['description' => 'The catalog type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DataSourceType' => ['description' => 'The data source type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DatabaseUuid' => ['description' => 'The database UUID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Name' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'QualifiedName' => ['description' => 'The qualified name of the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'SearchName' => ['description' => 'The name used to search the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Description' => ['description' => 'The database description.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'EngineMeta' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/OneMetaDatabaseEngineMeta'],
+ 'StorageLocation' => ['description' => 'The database storage location.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'State' => ['description' => 'The database state.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'Properties' => ['description' => 'The extended properties of the database.', 'type' => 'object', 'title' => '', 'example' => ''],
+ 'DatabaseBizAttrs' => ['description' => 'The business attributes of the database.', 'type' => 'object', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Contains metadata for a database.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaDatabaseEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemaName' => ['description' => 'The schema name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CatalogName' => ['description' => 'The catalog name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Encoding' => ['description' => 'The character encoding for the database.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'StorageCapacity' => ['description' => 'The database storage capacity, in GB.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'],
+ ],
+ 'description' => 'Metadata for the OneMeta database engine.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaDatabaseObject' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ObjectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ObjectQualifiedName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaKnowledgeBase' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['title' => '知识库uuid标识', 'description' => 'The UUID of the knowledge base.', 'type' => 'string', 'example' => 'kb-***'],
+ 'Name' => ['title' => '知识库名字', 'description' => 'The name of the knowledge base.', 'type' => 'string', 'example' => 'order_kb'],
+ 'Description' => ['title' => '知识库描述', 'description' => 'The description of the knowledge base.', 'type' => 'string', 'example' => 'order knowledgebase'],
+ 'State' => ['title' => '知识库状态：'."\n"
+ .'0：无数据'."\n"
+ .'1：可用', 'description' => 'The state of the knowledge base. Valid values include 0 (No data) and 1 (Available).', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Tag' => ['title' => '知识库标签', 'description' => 'The tag of the knowledge base.', 'type' => 'string', 'example' => '4phsj52f81ymlm***'],
+ 'Creator' => ['title' => '创建者', 'description' => 'The creator of the knowledge base.', 'type' => 'string', 'example' => '20464374909***'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => 'The time when the knowledge base was created.', 'type' => 'string', 'example' => '2026-05-14 11:30:00'],
+ 'GmtModified' => ['title' => '修改时间', 'description' => 'The time when the knowledge base was last modified.', 'type' => 'string', 'example' => '2026-05-14 11:30:39'],
+ 'Domain' => ['description' => 'The domain of the knowledge base.', 'type' => 'string', 'title' => '', 'example' => 'vehicle'],
+ 'ExtraInfo' => ['description' => 'Additional information about the knowledge base.', 'type' => 'string', 'title' => '', 'example' => '{"keywords":"sales,vehicle brand"}'],
+ ],
+ 'description' => 'Represents a knowledge base.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaKnowledgeBaseChunk' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The unique identifier for the chunk.', 'type' => 'string', 'title' => '', 'example' => '2e12aeb5-52cd-4834-bcd8-****'],
+ 'DocName' => ['description' => 'The name of the document.', 'type' => 'string', 'title' => '', 'example' => 'test.md'],
+ 'Content' => ['description' => 'The content of the chunk.', 'type' => 'string', 'title' => '', 'example' => 'abc'],
+ 'ChunkTitle' => ['description' => 'The title of the chunk.', 'type' => 'string', 'title' => '', 'example' => 'titile1'],
+ 'ChunkMtime' => ['description' => 'The time when the chunk was last modified.', 'type' => 'string', 'title' => '', 'example' => '2026-04-20 15:51:27'],
+ ],
+ 'description' => 'Contains information about a knowledge base chunk.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaKnowledgeBaseDocument' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['title' => '知识库Uuid', 'description' => 'The knowledge base ID.', 'type' => 'string', 'example' => 'kb-***'],
+ 'Name' => ['title' => '文档名称', 'description' => 'The document name.', 'type' => 'string', 'example' => 'test.md'],
+ 'Description' => ['title' => '文档描述', 'description' => 'The document description.', 'type' => 'string', 'example' => 'abc'],
+ 'FileExt' => ['title' => '文档扩展类型', 'description' => 'The file extension.', 'type' => 'string', 'example' => 'md'],
+ 'DocumentLoaderName' => ['title' => '文档加载器名称', 'description' => 'The name of the document loader.', 'type' => 'string', 'example' => 'ADBPGLoader'],
+ 'TextSplitterName' => ['title' => '文档分词器名称', 'description' => 'The name of the text splitter.', 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => 'When the document was created.', 'type' => 'string', 'example' => '2026-04-22 22:59:35'],
+ 'GmtModified' => ['title' => '修改时间', 'description' => 'When the document was last modified.', 'type' => 'string', 'example' => '2026-04-24 21:22:53'],
+ 'FileSize' => ['title' => '文件大小', 'description' => 'The file size, in bytes.', 'type' => 'integer', 'example' => '20307', 'format' => 'int64'],
+ 'DocsCount' => ['title' => 'chunk 数量', 'description' => 'The number of chunks.', 'type' => 'integer', 'example' => '123', 'format' => 'int32'],
+ 'State' => ['title' => '文档状态：'."\n"
+ .'0：正常'."\n"
+ .'-1：未解析'."\n"
+ .'-2：解析中'."\n"
+ .'-3：解析失败'."\n"
+ .'-4：解析取消', 'description' => 'The document status. Valid values are:'."\n"
+ ."\n"
+ .'- **0**: Complete.'."\n"
+ ."\n"
+ .'- **-1**: Unprocessed.'."\n"
+ ."\n"
+ .'- **-2**: Parsing.'."\n"
+ ."\n"
+ .'- **-3**: Failed.'."\n"
+ ."\n"
+ .'- **-4**: Canceled.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'],
+ 'Summary' => ['description' => 'The summary of the document.', 'type' => 'string', 'title' => '', 'example' => 'This is a test document.'],
+ 'Keywords' => ['description' => 'Keywords extracted from the document.', 'type' => 'string', 'title' => '', 'example' => '["test","abc"]'],
+ ],
+ 'description' => 'Information about a document in the knowledge base.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaTableBaseInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CatalogType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DatabaseUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'QualifiedName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TableType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TableUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EngineMeta' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/OneMetaTableEngineMeta'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaTableColumn' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ColumnType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Position' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'EngineMeta' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/OneMetaTableColumnEngineMeta'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaTableColumnEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Nullable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'AutoIncrement' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'DefaultValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DataLength' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'DataPrecision' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'DataScale' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'Encoding' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Extra' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GenerationColumn' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'GenerationExpression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaTableEngineMeta' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableSchemaName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Encoding' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LastDdlTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Engine' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'StorageCapacity' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'DataBytes' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'IndexBytes' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'NumRows' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'RefInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OneMetaTableIndex' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'IndexType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ColumnNames' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Primary' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Unique' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'RealColumnNames' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'PartitionError' => [
+ 'OpenClawInstanceQuotaVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ModelCallUsed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ModelCallQuota' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SkillPlanCallUsed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SkillPlanCallQuota' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DeepResearchCallUsed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DeepResearchCallQuota' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AliyunAccountUid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RefreshDay' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LastMeteringTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceGmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceDesc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ ],
'description' => '',
- 'visibility' => 'Public',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OpenClawInstanceVO' => [
'type' => 'object',
'properties' => [
- 'ErrorDetail' => [
+ 'AliyunAccountUid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceDesc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Cpu' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'double'],
+ 'MemorySize' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'PublicDomain' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'OpenclawToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'StatusDesc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LastActiveTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'OwnerUid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AuthType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'BasicAuthUsername' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'BasicAuthPassword' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Variables' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'StatusMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstanceRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ImageInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageId' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'Namespace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Tag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'VersionDesc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'auth failed',
- 'backendName' => 'errorDetail',
+ 'title' => '',
+ 'example' => '',
],
+ 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TrialExpireTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LockTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ModelCallQuota' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'ModelCallUsed' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'],
+ 'AgentType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PartitionError' => [
+ 'description' => 'The error message.',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorDetail' => ['description' => 'The details of the error.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'errorDetail', 'example' => 'auth failed', 'title' => ''],
'Values' => [
- 'description' => '',
+ 'description' => 'The partition values.',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'part_val1',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'The value of the partition key column.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => 'part_val1', 'title' => ''],
'backendName' => 'values',
+ 'title' => '',
],
],
+ 'title' => '',
+ ],
+ 'TrialOrderEligibilityVO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Valid' => ['description' => 'Indicates whether the user is eligible for the trial.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'Message' => ['description' => 'Contains details about the eligibility status, such as the reason for ineligibility.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Contains the result of a trial order eligibility check.',
+ 'title' => '',
+ 'example' => '',
],
],
],
'apis' => [
- 'CreateAirflowLoginToken' => [
- 'summary' => 'Queries the Airflow logon credential. You can use this credential to log on to the DMS-managed Airflow instance.',
+ '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' => 'The ID of the Airflow instance. You can view the instance ID on the [Airflow Instances](~~2881043~~) page.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af-b3a7f110a6vmvn7xxxxxx',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
+ ],
+ [
+ 'name' => 'MemberId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Alibaba Cloud UID of the user.', 'type' => 'string', 'required' => false, 'example' => '20282*****7591', 'title' => ''],
+ ],
+ [
+ 'name' => 'RoleName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the user\'s role in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
- 'type' => 'string',
- 'example' => '4284D079-30F4-5B23-ADC4-28F291622C9A',
- ],
- 'HttpStatusCode' => [
- 'description' => 'The description of the error code.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* True'."\n"
- .'* False'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Message' => [
- 'description' => 'The error message returned.'."\n",
- 'type' => 'string',
- 'example' => 'Successful',
- ],
- 'ErrorCode' => [
- 'description' => 'The error code returned if the call failed. Variable description:'."\n"
- ."\n"
- .'* If the request was successful, this parameter is not returned.'."\n"
- .'* This parameter is returned only if the request failed.'."\n"
- ."\n"
- .'For more information, see the "Error codes" section in this topic.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-***-695C'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
'Data' => [
- 'description' => 'The result of the site monitoring task.'."\n",
'type' => 'object',
'properties' => [
- 'Token' => [
- 'description' => 'The generated token.'."\n",
- 'type' => 'string',
- 'example' => 'f432d77de03b6b95fc24f91414e29c',
- ],
- 'Host' => [
- 'description' => 'The endpoint that is used to access the Airflow instance.'."\n",
- 'type' => 'string',
- 'example' => 'https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszbxxxxxxx',
- ],
+ 'MemberId' => ['description' => 'The Alibaba Cloud UID of the user.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'UserName' => ['description' => 'The RAM username.', 'type' => 'string', 'example' => 'agentTest', 'title' => ''],
+ 'RoleName' => ['description' => 'The name of the user\'s role in the workspace.', 'type' => 'string', 'example' => 'admin', 'title' => ''],
+ 'JoinTime' => ['description' => 'The time when the user joined the workspace. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765960516', 'title' => ''],
+ 'RunningTaskNumber' => ['description' => 'The number of tasks that the user is running in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'TotalTaskNumber' => ['description' => 'The total number of tasks that the user initiated in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
],
- ],
- 'Code' => [
- 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n",
- 'type' => 'string',
- 'example' => '200',
+ 'description' => 'The returned struct.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AddUserToDataAgentWorkspace',
+ 'summary' => 'Adds a user to a specified workspace.',
+ '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' => 'CreateAirflowLoginToken',
- ],
- 'CreateAirflow' => [
- 'summary' => '创建Airflow',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:AddUserToDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 \\"MemberId\\": \\"20282*****7591\\",\\n \\"UserName\\": \\"agentTest\\",\\n \\"RoleName\\": \\"admin\\",\\n \\"JoinTime\\": 1765960516,\\n \\"RunningTaskNumber\\": 2,\\n \\"TotalTaskNumber\\": 5\\n }\\n}","type":"json"}]',
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '8630242382****',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'AirflowName',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'title' => 'airflow实例的名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testairflow',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'Description',
+ 'name' => 'TableName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
+ ],
+ [
+ 'name' => 'PartitionInputs',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'airflow实例的描述',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The information about the new partitions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the data lake partition.', 'required' => false, '$ref' => '#/components/schemas/DLPartitionInput', 'title' => '', 'example' => ''],
'required' => true,
- 'example' => 'order scheduler',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'AppSpec',
+ 'name' => 'IfNotExists',
'in' => 'query',
- 'schema' => [
- 'title' => 'airflow实例的规格-SMALL、MEDIUM、LARGE、XLARGE、X2LARGE',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SMALL',
- ],
+ 'schema' => ['description' => 'Specifies whether to ignore an error if a partition with the same name already exists. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Ignore the error.'."\n"
+ ."\n"
+ .'- **false**: Do not ignore the error.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
- 'name' => 'WorkerServerlessReplicas',
+ 'name' => 'NeedResult',
'in' => 'query',
- 'schema' => [
- 'title' => 'Worker节点扩展',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'Specifies whether to return partition information. If you set this parameter to **true**, the response includes the Partitions parameter.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
- 'name' => 'VpcId',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'title' => 'vpc id',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-uf63r6coyiw9o5****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'VSwitchId',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '交换机ID',
- 'description' => '',
- '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'true'],
+ 'Partitions' => [
+ 'description' => 'The list of created partitions. This parameter is returned when the **NeedResult** parameter is set to **true**.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The details of the partitions.', '$ref' => '#/components/schemas/DLPartition', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'BatchCreateDataLakePartitions',
+ 'summary' => 'Creates partitions for a data lake table in a batch.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SecurityGroupId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '安全组ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sg-bp108t8ldzeyk1****',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:BatchCreateDataLakePartitions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'ZoneId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'table_name'],
+ ],
+ [
+ 'name' => 'PartitionValuesList',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'title' => 'region中可用区ID',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of partition values.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The value of the partition key column.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'part_val1'],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => 'cn-hangzhou-h',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OssBucketName',
+ 'name' => 'IfExists',
'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to ignore the exception if the partition to be deleted does not exist.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'OSS bucket名称',
- 'description' => '',
- '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' => 'The ID of the request.', 'type' => 'string', 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'true'],
+ 'PartitionErrors' => [
+ 'description' => 'A list of errors.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The error information.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'BatchDeleteDataLakePartitions',
+ 'summary' => 'Batch deletes partitions from a data lake table.',
+ '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' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
+ ],
+ [
+ 'name' => 'PartitionInputs',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'OSS路径',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The information about the partitions to update.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the data lake partition.', 'required' => false, '$ref' => '#/components/schemas/DLPartitionInput', 'title' => '', 'example' => ''],
'required' => true,
- 'example' => '/airflow',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'StartupFile',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'title' => 'airflow容器的启动脚本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/startup.sh',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'RequirementFile',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', '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' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'PartitionErrors' => [
+ 'description' => 'The list of errors.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The error information.', '$ref' => '#/components/schemas/PartitionError', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'BatchUpdateDataLakePartitions',
+ 'summary' => 'Update partitions in a data lake table in batch.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'DagsDir',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'dag扫描路径',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/dags',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:BatchUpdateDataLakePartitions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Update an Airflow instance\'s custom configuration',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PluginsDir',
+ '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' => 'airflow实例扫描的插件路径',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/plugins',
- ],
+ 'schema' => ['description' => 'The unique ID of the Airflow instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'af-b3a7f110a6vmvn7xxxxxx'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CustomAirflowCfg',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'token-****',
+ 'type' => 'array',
+ 'items' => ['description' => 'A custom Airflow configuration setting.', 'type' => 'string', 'required' => false, 'example' => 'celery.worker_concurrency=10', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'description' => 'The list of custom Airflow configurations.',
+ 'example' => '',
],
],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DMS workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8630242382****'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****',
- ],
- 'AccessDeniedDetail' => [
- 'title' => '拒绝访问的详情',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NOT_FOUND',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
'Root' => [
- 'title' => '数据字典',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'AirflowName' => [
- 'title' => 'airflow实例名',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testairflow',
- ],
- 'AppSpec' => [
- 'title' => 'airflow规格',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SMALL',
- ],
- 'AppType' => [
- 'title' => '类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'airflow',
- ],
- 'DagsDir' => [
- 'title' => 'airflow扫描dag的路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/dags',
- ],
- 'DeployErrorMsg' => [
- 'title' => '错误日志信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc not found',
- ],
- 'Description' => [
- 'title' => 'airflow的描述信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'order scheduler',
- ],
- 'GmtCreated' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-08-12T05:46:01.000+0000',
- ],
- 'OssBucketName' => [
- 'title' => 'OSS bucktet名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss-test',
- ],
- 'OssPath' => [
- 'title' => 'OSS路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => '/airflow',
- ],
- 'PluginsDir' => [
- 'title' => 'airflow扫描的插件路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/plugins',
- ],
- 'RequirementFile' => [
- 'title' => '可安装包的路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/requirements.txt',
- ],
- 'SecurityGroupId' => [
- 'title' => '安全组ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sg-2ze1nak7h0alg1xxx',
- ],
- 'StartupFile' => [
- 'title' => 'airflow实例的启动时加载的文件，可设置环境变量等',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/startup.sh',
- ],
- 'Status' => [
- 'title' => 'airflow实例状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEPLOYING',
- ],
- 'AirflowId' => [
- 'title' => 'airflow id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'af-****',
- ],
- 'VSwitchId' => [
- 'title' => '交换机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-8vbaf073jawozfpbg****',
- ],
- 'VpcId' => [
- 'title' => 'VPC ID',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-uf63r6coyiw9o5gf****',
- ],
- 'WorkerServerlessReplicas' => [
- 'title' => 'Worker扩展节点数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'WorkspaceId' => [
- 'title' => '工作空间ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '86302423828****',
- ],
- 'ZoneId' => [
- 'title' => '可用区ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
+ 'AirflowName' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'testairflow'],
+ 'AppSpec' => ['description' => 'The Airflow instance specifications.', 'type' => 'string', 'title' => '', 'example' => 'SMALL'],
+ 'AppType' => ['description' => 'The application type.', 'type' => 'string', 'title' => '', 'example' => 'AIRFLOW'],
+ 'CustomAirflowCfg' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'Configuration details.', 'type' => 'string', 'example' => 'smtp.username=test', 'title' => ''],
+ 'title' => '',
+ 'description' => 'The custom configuration.',
+ 'example' => '',
],
+ 'DagsDir' => ['description' => 'The DAG directory that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/dags'],
+ 'DeployErrorMsg' => ['description' => 'The deployment error message.', 'type' => 'string', 'title' => '', 'example' => 'vpc not found'],
+ 'Description' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'test airflow'],
+ 'GmtCreated' => ['description' => 'The timestamp when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '2025-08-12T05:46:01.000+0000'],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'oss-test'],
+ 'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'title' => '', 'example' => '/airflow'],
+ 'PluginsDir' => ['description' => 'The plugin directory that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/plugins'],
+ 'RequirementFile' => ['description' => 'The configuration file for dependencies.', 'type' => 'string', 'title' => '', 'example' => 'default/requirements.txt'],
+ 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'title' => '', 'example' => 'sg-2ze1nak7h0alg1xxx'],
+ 'StartupFile' => ['description' => 'The script that runs before Airflow starts.', 'type' => 'string', 'title' => '', 'example' => 'default/startup.sh'],
+ 'Status' => ['description' => 'The status of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'DEPLOYING'],
+ 'AirflowId' => ['description' => 'The ID of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'af-7a6ygsh80dx1jn****'],
+ 'VSwitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'title' => '', 'example' => 'vsw-bp1931trfxkvf74v****'],
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'title' => '', 'example' => 'vpc-uf63r6coyiw9o5gf****'],
+ 'WorkerServerlessReplicas' => ['description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'WorkspaceId' => ['description' => 'The DMS workspace ID.', 'type' => 'string', 'title' => '', 'example' => '86302423828****'],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'],
],
- ],
- 'Message' => [
- 'title' => '日志信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Successful',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'description' => 'Information about the Airflow instance.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance not found.', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'ConfigAirflow',
+ 'description' => 'Configure the airflow\\.cfg file for DMS Airflow.',
+ '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"}]',
+ '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' => '更新UpdateAirflow',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateAirflow' => [
+ 'summary' => 'Creates an Airflow instance in a workspace.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'token-****',
- ],
+ 'schema' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '8630242382****'],
],
[
- 'name' => 'AirflowId',
+ 'name' => 'AirflowName',
'in' => 'query',
- 'schema' => [
- 'title' => 'Airflow的唯一键ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af-test****',
- ],
+ 'schema' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testairflow'],
],
[
- 'name' => 'AirflowName',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => 'Airflow实例的名字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testairflow',
- ],
+ 'schema' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'order scheduler'],
],
[
- 'name' => 'StartupFile',
+ 'name' => 'AppSpec',
'in' => 'query',
- 'schema' => [
- 'title' => 'Airflow实例的启动时加载的脚本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/startup.sh',
- ],
+ 'schema' => ['description' => 'The compute specifications for the Airflow instance. Valid values: **SMALL**, **MEDIUM**, **LARGE**, **XLARGE**, or **X2LARGE**.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SMALL'],
],
[
'name' => 'WorkerServerlessReplicas',
'in' => 'query',
- 'schema' => [
- 'title' => 'Worker节点个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The number of elastic worker nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'title' => 'Airflow的描述信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test airflow',
- ],
+ 'schema' => ['title' => 'vpc id', 'description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf63r6coyiw9o5****'],
],
[
- 'name' => 'PluginsDir',
+ 'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'title' => 'Airflow扫描的插件目录',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/plugins',
- ],
+ 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-8vbaf073jawozfp****', 'title' => ''],
],
[
- 'name' => 'AppSpec',
+ 'name' => 'SecurityGroupId',
'in' => 'query',
- 'schema' => [
- 'title' => 'AIrflow的规格描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SMALL',
- ],
+ 'schema' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => true, 'example' => 'sg-bp108t8ldzeyk1****', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'oss-test', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssPath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The OSS path for log storage.', 'type' => 'string', 'required' => true, 'example' => '/airflow', 'title' => ''],
+ ],
+ [
+ 'name' => 'StartupFile',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path to the startup script in the Airflow container.', 'type' => 'string', 'required' => false, 'example' => 'default/startup.sh', 'title' => ''],
],
[
'name' => 'RequirementFile',
'in' => 'query',
- 'schema' => [
- 'title' => '包依赖的安装文件',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default/requirements.txt',
- ],
+ 'schema' => ['description' => 'The path to the Python requirements file.', 'type' => 'string', 'required' => false, 'example' => 'default/requirements.txt', 'title' => ''],
],
[
'name' => 'DagsDir',
'in' => 'query',
+ 'schema' => ['description' => 'The path to the DAG directory for Airflow to scan.', 'type' => 'string', 'required' => false, 'example' => 'default/dags', 'title' => ''],
+ ],
+ [
+ 'name' => 'PluginsDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path to the plugin directory for the Airflow instance to scan.', 'type' => 'string', 'required' => false, 'example' => 'default/plugins', 'title' => ''],
+ ],
+ [
+ 'name' => 'GracefulShutdownTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The graceful shutdown timeout for workers, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'EnableServerless',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable worker elasticity.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'DataMountInfoList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Airflow扫描dag的目录',
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'The data mount configuration.', '$ref' => '#/components/schemas/DataMountInfo', 'title' => '', 'required' => false, 'example' => ''],
+ 'title' => '',
+ 'description' => 'A list of data mount configurations.',
'required' => false,
- 'example' => 'default/dags',
+ 'example' => '',
],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AirflowVersion',
'in' => 'query',
- 'schema' => [
- 'title' => 'DMS工作空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '863024238280****',
- ],
+ 'schema' => ['description' => 'The Airflow version. Supported versions: 2.10 and 3.1.', 'type' => 'string', 'example' => '3.1', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A client token to ensure request idempotence.', 'type' => 'string', 'required' => false, 'example' => 'token-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the zone where the instance will be created.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''],
],
],
'responses' => [
@@ -2072,1251 +1877,1241 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E0D21075-CD3E-4D98-8264-F****',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NOT_FOUND',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
'Root' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The Airflow data dictionary.',
'type' => 'object',
'properties' => [
- 'AirflowName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test airflow',
- ],
- 'AppSpec' => [
- 'description' => 'SMALL。',
- 'type' => 'string',
- 'example' => 'SMALL',
- ],
- 'AppType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AIRFLOW',
- ],
+ 'AirflowName' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'testairflow'],
+ 'AppSpec' => ['description' => 'The specifications of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'SMALL'],
+ 'AppType' => ['description' => 'The application type. This value is always airflow.', 'type' => 'string', 'title' => '', 'example' => 'airflow'],
+ 'DagsDir' => ['description' => 'The directory that Airflow scans for DAGs.', 'type' => 'string', 'title' => '', 'example' => 'default/dags'],
+ 'DeployErrorMsg' => ['description' => 'The deployment error message.', 'type' => 'string', 'title' => '', 'example' => 'vpc not found'],
+ 'Description' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'order scheduler'],
+ 'GmtCreated' => ['description' => 'The time the instance was created.', 'type' => 'string', 'title' => '', 'example' => '2025-08-12T05:46:01.000+0000'],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'oss-test'],
+ 'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'title' => '', 'example' => '/airflow'],
+ 'PluginsDir' => ['description' => 'The plugin directory that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/plugins'],
+ 'RequirementFile' => ['description' => 'The path to the requirements file.', 'type' => 'string', 'title' => '', 'example' => 'default/requirements.txt'],
+ 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'title' => '', 'example' => 'sg-2ze1nak7h0alg1xxx'],
+ 'StartupFile' => ['description' => 'The file that is loaded when the Airflow instance starts. You can use this file to set environment variables.', 'type' => 'string', 'title' => '', 'example' => 'default/startup.sh'],
+ 'Status' => ['description' => 'The status of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'DEPLOYING'],
+ 'AirflowId' => ['title' => 'airflow id', 'description' => 'The ID of the Airflow instance.', 'type' => 'string', 'example' => 'af-****'],
+ 'VSwitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'title' => '', 'example' => 'vsw-8vbaf073jawozfpbg****'],
+ 'VpcId' => ['title' => 'VPC ID', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf63r6coyiw9o5gf****'],
+ 'WorkerServerlessReplicas' => ['description' => 'The number of scaled-out worker nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '86302423828****'],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'],
+ 'AirflowVersion' => ['description' => 'The Airflow version.', 'type' => 'string', 'example' => '3.1', 'title' => ''],
'CustomAirflowCfg' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'smtp.username=test',
- ],
- ],
- 'DagsDir' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/dags',
- ],
- 'DeployErrorMsg' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'quota exists',
- ],
- 'Description' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'osstest',
- ],
- 'OssPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/airflow',
- ],
- 'PluginsDir' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/plugins',
- ],
- 'RequirementFile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/requirements.txt',
- ],
- 'Requirements' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'jieba==0.42',
- ],
- 'SecurityGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sg-2ze1nak7h0alg1w5****',
- ],
- 'StartupFile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/startup.sh',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEPLOYED',
- ],
- 'Uuid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'af-xxx',
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-hp3hyga33aur8tj36****',
- ],
- 'VpcId' => [
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp16ko44pgciwv0****',
- ],
- 'WorkerServerlessReplicas' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '86302423828****',
+ 'items' => ['description' => 'A custom configuration in the section.key=value format.', 'type' => 'string', 'example' => 'celery.worker_concurrency=10', 'title' => ''],
+ 'description' => 'Custom Airflow configurations.',
+ 'title' => '',
+ 'example' => '',
],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-j',
+ 'DataMountInfoList' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'A data mount configuration.', '$ref' => '#/components/schemas/DataMountInfo', 'title' => '', 'example' => ''],
+ 'description' => 'A list of data mount configurations.',
+ 'title' => '',
+ 'example' => '',
],
+ 'EnableServerless' => ['description' => 'Indicates whether to enable serverless workers.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'GracefulShutdownTimeout' => ['description' => 'The timeout period for a graceful shutdown, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Unknown error',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'Successful'],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetAirflow' => [
- 'summary' => '查询 Airflow',
- 'methods' => [
- 'post',
+ '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\\": \\"test-bucket\\",\\n \\"Prefix\\": \\"/prod\\",\\n \\"MountFolderName\\": \\"image\\",\\n \\"ReadOnly\\": false\\n }\\n ],\\n \\"EnableServerless\\": false,\\n \\"GracefulShutdownTimeout\\": 60\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateAirflow',
+ 'description' => 'Creates an Airflow instance in a workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af-b3a7f110a6vmvn7****',
- ],
- ],
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8630242382****',
- ],
+ 'schema' => ['description' => 'The ID of the Airflow instance. For more information, see [Airflow instances]().', 'type' => 'string', 'required' => true, 'example' => 'af-b3a7f110a6vmvn7xxxxxx', 'title' => ''],
],
],
'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' => 'The request ID.', 'type' => 'string', 'example' => '4284D079-30F4-5B23-ADC4-28F291622C9A'],
+ 'HttpStatusCode' => ['description' => 'The error code description.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- True: The request was successful.'."\n"
+ ."\n"
+ .'- False: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.'."\n"
+ ."\n"
+ .'- If the request is successful, this parameter is not returned.'."\n"
+ ."\n"
+ .'- If the request fails, this parameter is returned.'."\n"
+ ."\n"
+ .'For more information, see the error codes in this topic.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'AirflowName' => [
- 'title' => 'Airflow名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testairflow',
- ],
- 'AppSpec' => [
- 'title' => 'Airflow规格',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'default/dags',
- ],
- 'DeployErrorMsg' => [
- 'title' => '发布错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Deployed',
- ],
- 'Description' => [
- 'title' => 'Airflow的描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test airflow',
- ],
- 'GmtCreated' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-08-12T05:46:01.000+0000',
- ],
- 'OssBucketName' => [
- 'title' => 'oss bucket名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'osstest',
- ],
- 'OssPath' => [
- 'title' => 'oss路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => '/airflow',
- ],
- 'PluginsDir' => [
- 'title' => 'Airflow扫描的插件目录',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/plugins',
- ],
- 'RequirementFile' => [
- 'title' => '依赖包的配置文件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/requirements.txt',
- ],
- 'SecurityGroupId' => [
- 'title' => '安全组id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sg-2ze9gj646bkv****',
- ],
- 'StartupFile' => [
- 'title' => 'Airflow启动前加载的脚本',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/startup.sh',
- ],
- 'Status' => [
- 'title' => 'Airflow实例状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEPLOYED',
- ],
- 'AirflowId' => [
- 'title' => 'Airflow的ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'af-7a6ygsh80dx1jn****',
- ],
- 'VSwitchId' => [
- 'title' => '交换机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp1931trfxkvf74v****',
- ],
- 'VpcId' => [
- 'title' => 'VPC ID',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-2zevqv4obraqd5p****',
- ],
- 'WorkerServerlessReplicas' => [
- 'title' => 'worker节点数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'WorkspaceId' => [
- 'title' => 'DMS工作空间ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8630242382****',
- ],
- 'ZoneId' => [
- 'title' => 'Region里的可用区ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'RegionId' => [
- 'title' => 'region',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
+ 'Token' => ['description' => 'The generated token.', 'type' => 'string', 'example' => 'f432d77de03b6b95fc24f9****', 'title' => ''],
+ 'Host' => ['description' => 'The endpoint of the Airflow instance.', 'type' => 'string', 'example' => 'https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszb****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'InvalidAirflow.NotFound',
- 'errorMessage' => 'The specified Airflow does not exist.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateAirflowLoginToken',
+ 'summary' => 'Obtains logon credentials for an Airflow instance hosted by Data Management Service (DMS). Use the returned token and host endpoint to construct a logon URL for the Airflow web UI.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:CreateAirflowLoginToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '86302423828****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'Name',
'in' => 'query',
- 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'Agent测试名称', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'Agent测试描述', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataJson',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data range, specified as a **JSON string**.'."\n"
+ ."\n"
+ .'- General parameters'."\n"
+ ."\n"
+ .' - `tableFlag`: Set to `true` to specify a data range.'."\n"
+ ."\n"
+ .' - `scope`: The value must be `personal`.'."\n"
+ ."\n"
+ .' - `personal`: Contains the parameters for a file or database.'."\n"
+ ."\n"
+ .'**File type**: Use the following parameters.'."\n"
+ ."\n"
+ .'- `DataSourceType`: The value must be `remote_data_center`.'."\n"
+ ."\n"
+ .'- `FileId`: The ID of the file.'."\n"
+ ."\n"
+ .'- `Database`: The name of the database returned by the `ListDataCenterTable` operation. This is typically the file name.'."\n"
+ ."\n"
+ .'- `Tables`: The names of the tables returned by the `ListDataCenterTable` operation.'."\n"
+ ."\n"
+ .'- `TableIds`: The table IDs returned by the `ListDataCenterTable` operation.'."\n"
+ ."\n"
+ .'- `RegionId`: The current region.'."\n"
+ ."\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"
+ .'**Database type**: Use the following parameters.'."\n"
+ ."\n"
+ .'- `DataSourceType`: The value must be `database`.'."\n"
+ ."\n"
+ .'- `DmsInstanceId`: The ID of the DMS instance returned by the data center API.'."\n"
+ ."\n"
+ .'- `DmsDatabaseId`: The ID of the DMS database returned by the data center API.'."\n"
+ ."\n"
+ .'- `FileId`: The instance name. This parameter is deprecated.'."\n"
+ ."\n"
+ .'- `DbName`: The name of the database returned by the data center API.'."\n"
+ ."\n"
+ .'- `Database`: The name of the database returned by the data center API.'."\n"
+ ."\n"
+ .'- `Tables`: The names of the tables returned by the data center API.'."\n"
+ ."\n"
+ .'- `TableIds`: The table IDs returned by the data center API.'."\n"
+ ."\n"
+ .'- `Engine`: The database engine. Valid values: `mysql` and `postgresql`.'."\n"
+ ."\n"
+ .'- `RegionId`: The current region.'."\n"
+ ."\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"
+ .'}', 'title' => ''],
+ ],
+ [
+ 'name' => 'Instruction',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instruction for the custom agent.'."\n"
+ ."\n"
+ .'- Maximum length: 10,000 characters.', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ ],
+ [
+ 'name' => 'Knowledge',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The knowledge for the custom agent.'."\n"
+ ."\n"
+ .'- Maximum length: 10,000 characters.', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ ],
+ [
+ 'name' => 'KnowledgeConfigList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessType' => [
+ 'description' => 'The access type.'."\n"
+ ."\n"
+ .'- `mcp`: Access via an MCP server.',
+ 'enumValueTitles' => ['mcp' => 'Access via an MCP server.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mcp',
+ 'title' => '',
+ ],
+ 'McpServerId' => ['description' => 'The ID of the MCP server.', 'type' => 'string', 'required' => false, 'example' => 'nhdpt9adf6ac**********ca', 'title' => ''],
+ 'KbUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The structure of an external knowledge base.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of external knowledge bases.',
'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '20',
- 'default' => '10',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ExecutionConfig',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipPlan' => ['description' => 'Specifies whether to skip the plan confirmation step.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Specifies whether to skip all SQL confirmation steps.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Specifies whether to skip the web report confirmation step.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Specifies whether to skip asking the user for input during execution.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => 'The execution configuration.',
'required' => false,
- 'example' => 'f056501ada12****',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageIndex',
+ 'name' => 'ScheduleTaskConfig',
'in' => 'query',
- 'allowEmptyValue' => true,
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedSessionId' => ['description' => 'The ID of a previous session to use for reference.', 'type' => 'string', 'required' => false, 'example' => '4m24*****mg7j2v', 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'required' => false, 'example' => '0 0 0 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The query for the scheduled task.', 'type' => 'string', 'required' => false, 'example' => '分析一下这份数据，给出简报', 'title' => ''],
+ ],
+ 'description' => 'The configuration for the scheduled task.',
'required' => false,
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Skip',
+ 'name' => 'TextReportConfig',
'in' => 'query',
+ 'schema' => ['description' => 'The formatting requirements for the text report.', 'type' => 'string', 'required' => false, 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ ],
+ [
+ 'name' => 'WebReportConfig',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The formatting requirements for the web report.', 'type' => 'string', 'required' => false, 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ ],
+ [
+ 'name' => 'DMSUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'CallbackConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ToolId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'RelatedSessionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'title' => '拒接访问的信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NOT_FOUND',
- ],
- 'Root' => [
- 'title' => '数据详情',
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- `true`: The request was successful.'."\n"
+ ."\n"
+ .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
'type' => 'object',
'properties' => [
- 'List' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => 'Agent测试名称', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom agent.', 'type' => 'string', 'example' => 'Agent测试描述', 'title' => ''],
+ 'DataJson' => ['description' => 'The specified data scope, in a JSON string format.', '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"
+ .'}', 'title' => ''],
+ 'Instruction' => ['description' => 'The instruction for the agent.', 'type' => 'string', 'example' => '分析框架：'."\n"
+ .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n"
+ .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n"
+ .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', 'title' => ''],
+ 'Knowledge' => ['description' => 'The knowledge for the agent.', 'type' => 'string', 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the custom agent.',
+ 'enumValueTitles' => ['NEW' => 'The agent is created but not yet published.', 'RELEASED' => 'The agent is published.', 'DRAFT' => 'The agent is an unpublished draft.', 'OFFLINE' => 'The agent is offline.'],
+ 'type' => 'string',
+ 'example' => 'NEW',
+ 'title' => '',
+ ],
+ 'ReleaseTime' => ['description' => 'The release time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'OfflineTime' => ['description' => 'The offline time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'Modifier' => ['description' => 'The ID of the user who last modified the agent.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '20923*****7291', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'AliyunParentUid' => ['description' => 'The primary Alibaba Cloud account ID.', 'type' => 'string', 'example' => '16738266********', 'title' => ''],
+ 'DmsUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'KnowledgeConfigList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'AirflowName' => [
- 'title' => 'Airflow实例名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-airflow',
- ],
- 'AppSpec' => [
- 'title' => 'Airflow规格',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'default/dags',
- ],
- 'DeployErrorMsg' => [
- 'title' => '发布错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'quota exists',
- ],
- 'Description' => [
- 'title' => 'Airflow描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'GmtCreated' => [
- 'title' => 'Airflow实例创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-08-12T05:46:01.000+0000',
- ],
- 'OssBucketName' => [
- 'title' => 'OSS bucket名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'osstest',
- ],
- 'OssPath' => [
- 'title' => 'OSS路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => '/airflow',
- ],
- 'PluginsDir' => [
- 'title' => 'Airflow扫描的插件目录',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/plugins',
- ],
- 'RequirementFile' => [
- 'title' => '依赖包的文件路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default/requirements.txt',
- ],
- 'SecurityGroupId' => [
- 'title' => '安全组ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sg-2ze1nak7h0alg1w****',
- ],
- 'Status' => [
- 'title' => 'Airflow实例状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEPLOYED',
- ],
- 'AirflowId' => [
- 'title' => 'Airflow实例ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'af-7a6ygsh80d****',
- ],
- 'VSwitchId' => [
- 'title' => '交换机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-uf6sxdc22x7sbdb****',
- ],
- 'VpcId' => [
- 'title' => 'VPC ID',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-8vbbfm33dy0y1pek****',
- ],
- 'WorkerServerlessReplicas' => [
- 'title' => 'Worker节点数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'WorkspaceId' => [
- 'title' => 'DMS工作空间ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8630242382****',
- ],
- 'ZoneId' => [
- 'title' => 'Region下的可用区ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'StartupFile' => [
- 'title' => 'Airflow启动时加载的脚本目录',
- 'description' => '',
+ 'AccessType' => [
+ 'description' => 'The access method.'."\n"
+ ."\n"
+ .'- `mcp`: Connects using MCP.',
+ 'enumValueTitles' => ['mcp' => 'Connect by using MCP.'],
'type' => 'string',
- 'example' => 'default/startup.sh',
+ 'example' => 'mcp',
+ 'title' => '',
],
+ 'McpServerId' => ['description' => 'The ID of the MCP server.', 'type' => 'string', 'example' => 'nhdpt9adf6ac**********ca', 'title' => ''],
+ 'KbUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => 'The structure of the external knowledge base.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'A list of external knowledge bases.',
+ 'title' => '',
+ 'example' => '',
],
- 'TotalCount' => [
+ 'ExecutionConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipPlan' => ['description' => 'Indicates whether to skip the plan confirmation step.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Indicates whether to skip all SQL confirmations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Indicates whether to skip the web report generation confirmation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Indicates whether to prevent the agent from asking the user for clarification during execution.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => 'The execution configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TextReportConfig' => ['description' => 'The format of the text report.', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'WebReportConfig' => ['description' => 'The format of the web report.', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'CreatorUserName' => ['description' => 'The username of the creator.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'ModifierUserName' => ['description' => 'The username of the user who last modified the agent.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'DMSUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'IsScheduleTask' => ['description' => 'Indicates whether a scheduled task is configured for the agent.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NextRuntime' => ['description' => 'The next run time of the scheduled task, formatted as a UNIX timestamp.'."\n"
+ ."\n"
+ .'- Timestamp format', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200', 'title' => ''],
+ 'ScheduleTaskConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedSessionId' => ['description' => 'The ID of a previous session to be used as a template for the scheduled task.', 'type' => 'string', 'example' => '4m24*****mg7j2v', 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'example' => '0 0 0 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The query for the scheduled task.', 'type' => 'string', 'example' => '分析一下这份数据，给出简报', 'title' => ''],
+ ],
+ 'description' => 'The configuration of the scheduled task.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CallbackConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ToolId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'title' => '',
+ 'example' => '',
],
+ 'RelatedSessionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Successful',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'NextToken' => [
- 'description' => '',
- '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',
+ 'description' => 'The response data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteAirflow' => [
- 'summary' => '删除Airflow',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateCustomAgent',
+ 'summary' => 'Create a custom agent in your personal space or a workspace.',
+ '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' => 'All Resource', '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' => 'Creates an accuracy test instance.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'token-****',
- ],
+ 'schema' => ['description' => 'The file ID in the data center.', 'type' => 'string', 'required' => false, 'example' => 'f-xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'AirflowId',
+ 'name' => 'CustomAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af-test****',
- ],
+ 'schema' => ['description' => 'The ID of the custom agent for which you want to run the accuracy test.', 'type' => 'string', 'required' => false, 'example' => 'ca-xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'Dataset',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data source. We recommend that you configure this in the custom agent.', 'type' => 'string', 'required' => false, 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxx49\\",\\"DmsDatabaseId\\":\\"75xxx6\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]', 'title' => ''],
+ ],
+ [
+ 'name' => 'EvaluationPrompt',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The accuracy evaluation criteria. An empty value indicates the default criteria.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
+ ],
+ [
+ 'name' => 'Mode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The analysis mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '86302423828****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'DmsUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DMS unit used to create the resource.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language used for the analysis task.', 'type' => 'string', 'required' => false, 'example' => 'ENGLISH', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxConcurrent',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of concurrent sessions during the test.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'NeedDelete',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether sessions are displayed after the analysis. This parameter is not supported.', 'type' => 'boolean', 'required' => false, 'example' => 'null', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the test item.', 'type' => 'string', 'required' => false, 'example' => 'Test01', 'title' => ''],
+ ],
+ [
+ 'name' => 'Desc',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E0D21075-CD3E-4D98-8264-****',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NOT_FOUND',
- ],
- 'Root' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A61C2009-xxx-BE7E95CEDF2F'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful. '."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'Responses' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Uuid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'af-test****'."\n",
- ],
- ],
- ],
- ],
+ 'AccuracyTestInsId' => ['description' => 'The instance ID of the accuracy test.', 'type' => 'string', 'example' => 'at-xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Instance not found.',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'ListDataLakeDatabase' => [
- 'summary' => '获取数据库列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create an accuracy test instance',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SearchKey',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '8i5tw7omgaax*********n909jid', 'title' => ''],
],
[
- 'name' => 'Tid',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The name of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'KnowledgeBaseTest', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Description',
'in' => 'query',
+ 'schema' => ['description' => 'The description of the knowledge base.', 'type' => 'string', 'required' => false, 'example' => 'KnowledgeBaseTest', 'title' => ''],
+ ],
+ [
+ 'name' => 'FromKbUuid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the source industry knowledge base.', 'type' => 'string', 'required' => false, 'example' => 'kb-HZ-ra99********ss0xp1bku', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'example' => 'kb-HZ-ra99akg0t*********1bku', 'title' => ''],
+ ],
+ 'description' => 'The data returned by the request.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataAgentKnowledgeBase',
+ 'summary' => 'Creates a DataAgent knowledge base. The knowledge base creator has read and write permissions. Other workspace members have permission to use it.',
+ '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' => 'Create a DataAgent session',
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The session title. Supports Chinese and English. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '帮我分析一下这份数据，给出报告。', 'title' => ''],
+ ],
+ [
+ 'name' => 'File',
'in' => 'query',
+ 'schema' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => 'f-8*******01m', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'object',
+ 'properties' => [
+ 'Language' => ['description' => 'The language. Valid values:'."\n"
+ ."\n"
+ .'- **CHINESE**: Chinese'."\n"
+ ."\n"
+ .'- **ENGLISH**: English', 'type' => 'string', 'required' => false, 'example' => 'CHINESE', 'title' => ''],
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'required' => false, 'example' => 'ca-e*******ckd', 'title' => ''],
+ 'CustomAgentStage' => ['description' => 'The custom agent stage. Valid values:'."\n"
+ ."\n"
+ .'- **debug**: Test stage.'."\n"
+ ."\n"
+ .'- **prod**: Production stage.', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''],
+ 'Mode' => ['description' => 'The mode. Valid values:'."\n"
+ ."\n"
+ .'- **ASK\\_DATA**: Quick inquiry mode.'."\n"
+ ."\n"
+ .'- **ANALYSIS**: Analysis mode.'."\n"
+ ."\n"
+ .'- **INSIGHT**: Insight mode.', 'type' => 'string', 'required' => false, 'example' => 'ANALYSIS', 'title' => ''],
+ 'EnableSearch' => ['description' => 'Specifies whether to enable web search.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'McpServerIds' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The MCP server ID.', 'type' => 'string', 'example' => '2q1tu90**********6uttu2nw', 'title' => '', 'required' => false],
+ 'description' => 'A list of MCP server IDs.',
+ 'title' => '',
+ 'example' => '',
+ 'required' => false,
+ ],
+ 'KbUuidList' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'UserOssBucket' => ['description' => 'The OSS bucket name.'."\n"
+ ."\n"
+ .'- This bucket stores intermediate files and report artifacts from the analysis.', 'type' => 'string', 'required' => false, 'example' => 'user-oss-bucket', 'title' => ''],
+ 'EncryptType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EncryptKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReportWaterMark' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReportPageWidth' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The session configuration.',
'required' => false,
- 'minimum' => '0',
- 'example' => '20',
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1CB***********3F1A'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['description' => 'The agent session ID.', 'type' => 'string', 'example' => '976*********p', 'title' => ''],
+ 'SessionStatus' => ['description' => 'The session status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'cu0cs*******mf', 'title' => ''],
+ 'AgentStatus' => ['description' => 'The agent status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'Title' => ['description' => 'The session title.', 'type' => 'string', 'example' => '帮我分析一下这份数据，给出报告。', 'title' => ''],
+ 'File' => ['description' => 'The ID of the associated file.', 'type' => 'string', 'example' => 'f-8*******01m', 'title' => ''],
+ 'SessionConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Language' => ['description' => 'The language. Valid values:'."\n"
+ ."\n"
+ .'- **CHINESE**: Chinese'."\n"
+ ."\n"
+ .'- **ENGLISH**: English', 'type' => 'string', 'example' => 'CHINESE', 'title' => ''],
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-e*******ckd', 'title' => ''],
+ 'CustomAgentStage' => ['description' => 'The stage of the custom agent. Valid values:'."\n"
+ ."\n"
+ .'- **debug**: Debug stage'."\n"
+ ."\n"
+ .'- **prod**: Production stage', 'type' => 'string', 'example' => 'debug', 'title' => ''],
+ 'Mode' => ['description' => 'The mode. Valid values:'."\n"
+ ."\n"
+ .'- **ASK\\_DATA**: Quick Inquiry Mode'."\n"
+ ."\n"
+ .'- **ANALYSIS**: Analysis Mode'."\n"
+ ."\n"
+ .'- **INSIGHT**: Insight Mode', 'type' => 'string', 'example' => 'ANALYSIS', 'title' => ''],
+ 'EnableSearch' => ['description' => 'Indicates whether web search is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'McpServerIds' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'An MCP server ID.', 'type' => 'string', 'example' => '2q1tu90**********6uttu2nw', 'title' => ''],
+ 'description' => 'A list of MCP server IDs.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'KbUuidList' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'UserOssBucket' => ['description' => 'The name of the user\'s OSS bucket.'."\n"
+ ."\n"
+ .'- Analysis files and report artifacts can be uploaded to this OSS bucket.', 'type' => 'string', 'example' => 'user-oss-bucket', 'title' => ''],
+ 'EncryptType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EncryptKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReportWaterMark' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReportPageWidth' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The session configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The time when the session was created, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765262307992', 'title' => ''],
+ 'Saved' => ['description' => 'Indicates whether the current user has favorited the session.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2g****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'description' => 'The response structure.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"DatabaseList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2g****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- ],
- 'GetDataLakeDatabase' => [
- 'summary' => '获取UC的数据库',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataAgentSession',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'CreateDataAgentWorkspace' => [
+ 'summary' => 'Creates a DataAgent workspace.',
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'WorkspaceName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspaceTest', 'title' => ''],
],
[
- 'name' => 'Tid',
+ 'name' => 'WorkspaceDesc',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The description of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'Space for test', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'IsSessionShareEnabled',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'Specifies whether session sharing is enabled within the workspace.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D2-*****-A63B6'],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '20923*****7291', 'title' => ''],
+ 'WorkspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'workspaceTest', 'title' => ''],
+ 'WorkspaceStatus' => ['description' => 'The status of the workspace.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'TotalMember' => ['description' => 'The total number of members in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''],
+ 'Creator' => ['description' => 'The UID of the workspace creator.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time of the workspace. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765960516', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The most recent modification time of the workspace. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765961516', 'title' => ''],
+ 'WorkspaceDesc' => ['description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'space for test', 'title' => ''],
+ 'RoleName' => ['description' => 'The role name of the user in the workspace.', 'type' => 'string', 'example' => 'owner', 'title' => ''],
+ 'IsSessionShareEnabled' => ['description' => 'Indicates whether session sharing is enabled within the workspace.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Type' => ['description' => 'The workspace type. Valid values:'."\n"
+ ."\n"
+ .'- personal: personal workspace.'."\n"
+ .'- common/null: multi-user collaborative workspace.', 'type' => 'string', 'example' => 'personal/common', 'title' => ''],
+ ],
'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE****',
- ],
- 'Success' => [
- 'description' => '',
- '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',
+ 'example' => '',
],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a workspace',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'ListDataLakeCatalog' => [
- 'summary' => '获取uc的数据库目录列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ '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' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The storage path of the database. The path supports the oss, s3, and s3a protocols.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss://path/to/database'],
+ ],
+ [
+ 'name' => 'Parameters',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The key-value pairs of the database properties.',
+ 'type' => 'object',
'required' => false,
- 'docRequired' => true,
- 'example' => 'hive',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The key and value of the parameter.', 'title' => '', 'example' => '{"key":"value"}'],
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****'],
+ 'ErrorCode' => ['description' => 'The error code returned when an error occurs with the request.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CataLogList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'GetDataLakeCatalog' => [
- 'summary' => '获取uc的数据库目录',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataLakeDatabase',
+ 'summary' => 'Creates a data lake database.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F1****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'CreateDataLakeFunction' => [
+ 'summary' => 'Creates a user-defined function (UDF) for a data lake.',
+ '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',
],
@@ -3324,262 +3119,204 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'FunctionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The details of the function.', 'required' => true, '$ref' => '#/components/schemas/DLFunctionInput', 'title' => '', 'example' => ''],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'EE214ECD-4330-503A-82F0-FFB03975****'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Function' => ['description' => 'The details of the function.', '$ref' => '#/components/schemas/DLFunction', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataLakeFunction',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'ListDataLakeTablebaseInfo' => [
- 'summary' => '获取表信息',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ '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' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'Page',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'SearchKey',
+ 'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
],
[
- 'name' => 'DbName',
+ 'name' => 'PartitionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The information about the new partition.', 'required' => true, '$ref' => '#/components/schemas/DLPartitionInput', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'IfNotExists',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'Specifies whether to ignore an exception if a partition with the same name already exists.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
- 'name' => 'CatalogName',
+ 'name' => 'NeedResult',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'Specifies whether to return information about the new partition. If you set this parameter to **true**, the Partition parameter is returned. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Returns information about the new partition.'."\n"
+ ."\n"
+ .'- **false**: Does not return information about the new partition.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Partition' => ['description' => 'The partition information.', '$ref' => '#/components/schemas/DLPartition', 'title' => '', 'example' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataLakePartition',
+ 'summary' => 'Creates a partition for a data lake table.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'GetDataLakeTable' => [
- 'summary' => '获取表信息',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'CreateDataLakeTable' => [
+ 'summary' => 'Creates a data lake table in Data Management (DMS).',
+ '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',
],
@@ -3587,273 +3324,485 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', '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' => 'The information about the table.', 'required' => true, '$ref' => '#/components/schemas/DLTableInput', 'title' => '', 'example' => ''],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****'],
+ 'ErrorCode' => ['description' => 'The error code that is returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message that is returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Table' => ['description' => 'The details of the table.', '$ref' => '#/components/schemas/DLTable', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'CreateDataLakeTable',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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\\": \\"\\",\\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"}]',
- ],
- 'BatchCreateDataLakePartitions' => [
- 'summary' => '批量新建湖仓表分区',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'DeleteAirflow' => [
+ 'summary' => 'Deletes an Airflow instance.',
+ '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' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'token-****', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'AirflowId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The ID of the Airflow instance.', 'type' => 'string', 'required' => true, 'example' => 'af-test****', 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '86302423828****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-****', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The details of the access denied error.', 'type' => 'string', 'example' => 'NOT_FOUND', 'title' => ''],
+ 'Root' => [
+ 'description' => 'The details of the deleted instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Responses' => [
+ 'description' => 'The details of the return value.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => 'Indicates whether the request was successful. The following values are returned:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Uuid' => ['description' => 'The UUID of the asset instance.'."\n"
+ ."\n"
+ .'> This result is not returned if no process exists under the asset.', 'type' => 'string', 'example' => 'af-test****'."\n", 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance not found.', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The following values are returned:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'DeleteAirflow',
+ '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:DeleteAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => 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"}]',
+ ],
+ 'DeleteCustomAgent' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'IfNotExists',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'NeedResult',
+ 'name' => 'CustomAgentId',
'in' => 'query',
+ 'schema' => ['description' => 'Custom Agent ID', 'type' => 'string', 'required' => true, 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Return value description.'."\n"
+ ."\n"
+ .'- **true**: Deletion successful.'."\n"
+ ."\n"
+ .'- **false**: Deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Returns an error message if the call fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomAgentId' => ['description' => 'Custom Agent ID', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Success' => ['description' => 'Is deletion successful?', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'Deletion operation message', 'type' => 'string', 'example' => 'Custom agent successfully deleted', 'title' => ''],
+ ],
+ 'description' => 'Return struct',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteCustomAgent',
+ 'summary' => 'Delete a custom agent in your personal workspace or a shared workspace. Note: Only custom agents that are newly created or offline can be deleted.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Tid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 deleted\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteDataAgentAccuracyTest' => [
+ 'summary' => 'Deletes an accuracy test configuration item.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AccuracyTestInsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
+ ],
[
'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'DmsUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ ],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete an accuracy test item',
+ 'description' => 'Deletes an accuracy test item.',
+ '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' => 'Deletes a DataAgent knowledge base.',
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '2dl4opo5vbh*******frxfsmw', 'title' => ''],
+ ],
+ [
+ 'name' => 'KbUuid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-HZ-rtl5lwx********q32d3ux', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Partitions' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLPartition',
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['description' => 'The ID of the deleted knowledge base.', 'type' => 'string', 'example' => 'kb-HZ-rtl5lwx********q32d3ux', 'title' => ''],
],
+ 'description' => 'The data returned by the operation.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The data structure of the response.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataAgentKnowledgeBase',
+ '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"}]',
+ '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' => '更新湖仓表信息',
+ 'DeleteDataAgentWorkspace' => [
+ 'summary' => 'Deletes a DataAgent workspace.',
'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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D2-*****-A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataAgentWorkspace',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'DeleteDataLakeDatabase' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3862,12 +3811,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -3875,116 +3822,151 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'C51420E3-144A-4A94-B473-8662FCF4****'],
+ 'ErrorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataLakeDatabase',
+ 'summary' => 'Deletes a data lake database.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TableInput',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => true,
- '$ref' => '#/components/schemas/DLTableInput',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Tid',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'TableName',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '100g_customer',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_funciton'],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of the response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Table' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLTable',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataLakeFunction',
+ 'summary' => 'Deletes a user-defined function in a data lake.',
+ '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"}]',
+ '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' => '更新湖仓表分区',
+ 'DeleteDataLakePartition' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3993,12 +3975,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -4006,113 +3986,84 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'table_name'],
],
[
- 'name' => 'PartitionInput',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'PartitionValues',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of partition values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The value of the partition key column.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'part_val1'],
'required' => true,
- '$ref' => '#/components/schemas/DLPartitionInput',
+ 'title' => '',
+ 'example' => '',
],
],
[
+ 'name' => 'IfExists',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to ignore the error if the partition to delete does not exist.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****'],
+ 'ErrorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the deletion succeeded.'."\n"
+ ."\n"
+ .'- **true**: The deletion succeeded.'."\n"
+ ."\n"
+ .'- **false**: The deletion failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataLakePartition',
+ 'summary' => 'Deletes a partition from a data lake table.',
+ '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"}]',
+ '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' => '更新湖仓数据库',
+ 'DeleteDataLakeTable' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4121,12 +4072,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -4134,476 +4083,784 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'Description',
+ 'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
],
[
- 'name' => 'Location',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://path/to/database',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'Parameters',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of the response.',
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"key":"value"}'."\n",
- 'description' => '',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '8E88933E-E3D4-5BA8-8CBF-0A1CAE66****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDataLakeTable',
+ 'summary' => 'Deletes a data lake table.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Tid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The document name.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Database' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLDatabase',
- ],
+ 'RequestId' => ['description' => 'The unique request ID. Use this ID to troubleshoot errors.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => ['description' => 'Indicates whether the document was deleted. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The deletion was successful.'."\n"
+ ."\n"
+ .'- **false**: The deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***'."\n", 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response body.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDocument',
+ 'summary' => 'Deletes a document from a specified knowledge base.',
+ '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"}]',
+ '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"}]',
],
- 'ListDataLakeTableName' => [
- 'summary' => '获取数据湖表名列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteDocumentChunks' => [
+ 'summary' => 'Deletes chunks from a document in a knowledge base.',
+ 'path' => '',
+ 'methods' => ['post'],
+ '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',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
],
'parameters' => [
[
- 'name' => 'Tid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
],
[
- 'name' => 'CatalogName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
],
[
- 'name' => 'DbName',
- 'in' => 'query',
+ 'name' => 'ChunkIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'A chunk ID.', 'type' => 'string', 'required' => false, 'example' => '52b00647-7065-4ad8-ac51-9cf7e762415****', 'title' => ''],
'required' => true,
- 'example' => 'default',
+ 'description' => 'A list of chunk IDs.',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'TableNamePattern',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.*',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique request ID for the call. If an error occurs, provide this request ID to support.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => ['description' => 'The number of deleted chunks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the call fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteDocumentChunks',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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"}]',
+ ],
+ 'DeleteFileUpload' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
[
- 'name' => 'MaxResults',
+ 'name' => 'DmsUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'Current DMS unit', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
- 'name' => 'TableType',
+ 'name' => 'FileId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MANAGED_TABLE',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'File ID', 'required' => true, 'example' => 'f-8*******01m'."\n", 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'CallFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'Used by frontend only', 'required' => false, 'example' => 'TrailCenter', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => ['type' => 'string', 'description' => 'Id of the request', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded. '."\n"
+ .'- **false**: The request failed.', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['type' => 'string', 'description' => 'Error code.', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['type' => 'string', 'description' => 'Error message returned when the invocation fails.', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => ['type' => 'string', 'description' => 'File ID', 'example' => 'f-8*******01m'."\n", 'title' => ''],
],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
+ 'description' => 'Return struct',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteFileUpload',
+ 'summary' => 'DeleteFileUpload',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteFileUpload',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ '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"}]',
+ 'translator' => 'machine',
],
- 'ListDataLakeTable' => [
- 'summary' => '获取数据湖表列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteWorkspaceCode' => [
+ 'summary' => 'Deletes a code file or directory from a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '249778',
- 'abilityTreeNodes' => [
- 'FEATUREdms90TD19',
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'Tid',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '12****', 'title' => ''],
],
[
- 'name' => 'CatalogName',
+ 'name' => 'Path',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The full path of the code file or directory. The path must be prefixed with `/Workspace/code/`.', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'Repo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The repository information.', 'type' => 'string', 'required' => false, 'example' => 'database/adb', 'title' => ''],
],
[
- 'name' => 'TableNamePattern',
+ 'name' => 'Symlink',
'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the item to delete is a symbolic link.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.*',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- `true`: The request was successful.'."\n"
+ ."\n"
+ .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ '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' => 'DeleteWorkspaceCode',
+ 'description' => 'This operation permanently removes a specified code file or directory.',
+ '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' => [
[
- 'name' => 'TableType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MANAGED_TABLE',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'CustomAgentId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomAgentId' => ['description' => 'The ID of the custom agent.', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => 'Agent测试名称', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom agent.', 'type' => 'string', 'example' => 'Agent测试描述', 'title' => ''],
+ 'DataJson' => ['description' => 'The data scope, formatted as a JSON string.', '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"
+ .'}', 'title' => ''],
+ 'Instruction' => ['description' => 'The instruction for the agent\'s analysis.', 'type' => 'string', 'example' => '分析框架：'."\n"
+ .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n"
+ .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n"
+ .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', 'title' => ''],
+ 'Knowledge' => ['description' => 'The domain knowledge for the agent.', 'type' => 'string', 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the custom agent. Valid values:',
+ 'enumValueTitles' => ['NEW' => 'A new agent that is not yet published.', 'RELEASED' => 'Published.', 'DRAFT' => 'A draft that is not yet published.', 'OFFLINE' => 'Taken offline.'],
+ 'type' => 'string',
+ 'example' => 'RELEASED',
+ 'title' => '',
+ ],
+ 'ReleaseTime' => ['description' => 'The release time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'OfflineTime' => ['description' => 'The time when the agent was taken offline.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'Modifier' => ['description' => 'The ID of the user who last modified the agent.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'AliyunParentUid' => ['description' => 'The ID of the parent Alibaba Cloud account.', 'type' => 'string', 'example' => '16738266********', 'title' => ''],
+ 'DmsUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the agent was created.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the agent was last modified.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'KnowledgeConfigList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessType' => ['description' => 'The access type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'McpServerId' => ['description' => 'The ID of the MCP server.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'KbUuid' => ['description' => 'The UUID of the knowledge base.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The knowledge configurations.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExecutionConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipPlan' => ['description' => 'Specifies whether to skip the plan confirmation step.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Specifies whether to skip all SQL confirmations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Specifies whether to skip confirmation before a web report is generated.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Specifies whether to disable prompts that require human intervention.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'description' => 'The execution configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TextReportConfig' => ['description' => 'The formatting requirements for the text report.', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'WebReportConfig' => ['description' => 'The formatting requirements for the web report.', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'DefaultAgent' => ['description' => 'Indicates whether this is the default agent.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ 'CreatorUserName' => ['description' => 'The username of the creator.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'ModifierUserName' => ['description' => 'The username of the modifier.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'DMSUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'IsScheduleTask' => ['description' => 'Indicates whether a scheduled task is configured.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'NextRuntime' => ['description' => 'The next scheduled execution time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200', 'title' => ''],
+ 'ScheduleTaskConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedSessionId' => ['description' => 'The ID of the related historical session.', 'type' => 'string', 'example' => '4m24*****mg7j2v', 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'example' => '0 0 0 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The task query.', 'type' => 'string', 'example' => '分析一下这份数据，给出简报', 'title' => ''],
+ ],
+ 'description' => 'The configuration of the scheduled task.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CallbackConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The callback type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ToolId' => ['description' => 'The tool ID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['description' => 'The callback prompt.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['description' => 'The callback arguments.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['description' => 'The callback time.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The callback configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RelatedSessionId' => ['description' => 'The ID of the related historical session.', 'type' => 'string', 'example' => '5xyz...', 'title' => ''],
+ ],
+ 'description' => 'The details of the custom agent.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'The schema of the response.',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeCustomAgent',
+ 'summary' => '`DescribeCustomAgent` retrieves the details of a custom agent by its 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' => 'All Resource', '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 \\"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"}]',
+ ],
+ 'DescribeDataAgentSession' => [
+ 'summary' => 'Retrieves the description of a DataAgent session.',
+ 'methods' => ['get', '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' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The current Data Management unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DataAgent session ID. You can obtain this ID by calling CreateDataAgentSession.', 'type' => 'string', 'required' => false, 'example' => 'c61n7gm******rj', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3D3FB827-E667-50DB-AD59-C83F8237****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '18****-*****-*******7A3122F'],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['description' => 'The agent session ID.', 'type' => 'string', 'example' => '976*********p', 'title' => ''],
+ 'SessionStatus' => ['description' => 'The session status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'AgentId' => ['description' => 'The current agent ID.', 'type' => 'string', 'example' => 'cu0cs*******mf', 'title' => ''],
+ 'AgentStatus' => ['description' => 'The current agent status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => '分析一下这份文件，给出报告。', 'title' => ''],
+ 'ChatHistoryLocations' => [
+ 'description' => 'The chat replay history.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The element of the chat replay history.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the chat replay history.', 'type' => 'string', 'example' => 'testKey1', 'title' => ''],
+ 'Url' => ['description' => 'The OSS download URL of the chat replay history.', 'type' => 'string', 'example' => '****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'File' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'f-8*******01m', 'title' => ''],
+ 'SessionConfig' => [
+ 'description' => 'The session configuration item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Language' => ['description' => 'The language. Valid values:'."\n"
+ .'- **CHINESE**: Chinese.'."\n"
+ .'- **ENGLISH**: English.', 'type' => 'string', 'example' => 'CHINESE', 'title' => ''],
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-e*******ckd', 'title' => ''],
+ 'CustomAgentStage' => ['description' => 'The stage of the custom agent. Valid values:'."\n"
+ .'- **debug**: test stage.'."\n"
+ .'- **prod**: production stage.', 'type' => 'string', 'example' => 'debug', 'title' => ''],
+ 'Mode' => ['description' => 'The mode. Valid values:'."\n"
+ .' - **ASK_DATA**: ask data mode.'."\n"
+ .' - **ANALYSIS**: analysis mode.'."\n"
+ .' - **INSIGHT**: insight mode.', 'type' => 'string', 'example' => 'ANALYSIS', 'title' => ''],
+ 'EnableSearch' => ['description' => 'Specifies whether to enable web search.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'McpServerIds' => [
+ 'title' => '',
+ 'description' => 'The list of MCP server IDs in the session configuration.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The MCP server ID in the session configuration.', 'type' => 'string', 'example' => '2q1tu90**********6uttu2nw'],
+ 'example' => '',
+ ],
+ 'KbUuidList' => [
+ 'description' => 'The list of knowledge base IDs for the current session.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a single knowledge base.', 'type' => 'string', 'example' => 'asdf****zsdv', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'UserOssBucket' => ['description' => 'The name of the user OSS bucket.'."\n"
+ .'- Analysis process files and report artifacts can be uploaded to the user-specified OSS bucket.', 'type' => 'string', 'example' => 'user-oss-bucket', 'title' => ''],
+ 'EncryptType' => ['title' => '', 'description' => 'The encryption type for storing artifacts in OSS (both built-in and user-specified).', 'type' => 'string', 'example' => 'null'],
+ 'EncryptKey' => ['title' => '', 'description' => 'The encryption key for storing artifacts in OSS (both built-in and user-specified). This is typically specified in CreateDataAgentSession.', 'type' => 'string', 'example' => 'ay***1Te'],
+ 'ReportWaterMark' => ['title' => '', 'description' => 'The report watermark.', 'type' => 'string', 'example' => '""'],
+ 'ReportPageWidth' => ['title' => '', 'description' => 'The report page width.', 'type' => 'integer', 'format' => 'int64', 'example' => '300mm'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The time when the session was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731645908000', 'title' => ''],
+ 'Saved' => ['description' => 'Indicates whether the session is saved as a favorite by the current logged-in user.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'FavoriteInWorkspace' => ['description' => 'Indicates whether the session is saved as a favorite in the workspace by the current logged-in user.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'UserId' => ['description' => 'The ID of the session owner.', 'type' => 'string', 'example' => '2096******', 'title' => ''],
+ 'Artifacts' => [
+ 'description' => 'The list of artifacts produced by the session. Currently, only reports are included.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The globally unique artifact ID. If the report is produced by calling SendChatMessage with MessageType set to REPORT, the artifact ID is the same as the MessageId in the response of the SendChatMessage operation.', 'type' => 'string', 'example' => 'bab******33e1', 'title' => ''],
+ 'Type' => ['description' => 'The artifact type. Valid values: TextReport, WebReport.', 'type' => 'string', 'example' => 'WebReport', 'title' => ''],
+ 'Status' => ['description' => 'The artifact status. Valid values:'."\n"
+ ."\n"
+ .'- PENDING: The backend has received the task but has not started it.'."\n"
+ ."\n"
+ .'- RUNNING: The backend has started the task but has not completed it.'."\n"
+ ."\n"
+ .'- SUCCESS: The task succeeded. You can query the file information by calling the ListFileUpload operation.'."\n"
+ ."\n"
+ .'- FAILED: The task failed.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
+ 'Name' => ['description' => 'The artifact name. This is typically a string concatenated by the system and is aligned with the name field in the ListFileUpload operation. You can use this field to query the download URL of the artifact file.', 'type' => 'string', 'example' => 'report_****_2026****', 'title' => ''],
+ 'Description' => ['description' => 'The brief description of the artifact. This value may be empty.', 'type' => 'string', 'example' => 'a simple report', 'title' => ''],
+ 'ReceiveTime' => ['description' => 'The time when the backend received the artifact request. This is a UNIX timestamp accurate to the second.', 'type' => 'string', 'example' => '1778743587', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the backend actually started running the artifact task. This is a UNIX timestamp accurate to the second.', 'type' => 'string', 'example' => '1778743587', 'title' => ''],
+ 'FinishTime' => ['description' => 'The time when the backend completed the artifact task. This is a UNIX timestamp accurate to the second.', 'type' => 'string', 'example' => '1778743587', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DataSources' => [
+ 'description' => 'The list of data sources used in the current session.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['description' => 'The data source category. Valid values:'."\n"
+ ."\n"
+ .'- **CHAT**: specified through the CreateDataAgentSession or SendChatMessage operation during a conversation.'."\n"
+ ."\n"
+ .'- **CUSTOM_AGENT**: from the preset analysis data scope in a custom agent.', 'type' => 'string', 'example' => 'CHAT', 'title' => ''],
+ 'Detail' => ['description' => 'The data source details.'."\n"
+ ."\n"
+ .'When Category is CHAT or CUSTOM_AGENT, the structure of Detail is aligned with the structure of a single element in the DataSources parameter of the SendChatMessage operation.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RecallResults' => [
+ 'description' => 'The recall results from the knowledge base and memory for the current session.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of the recalled knowledge.', 'type' => 'string', 'example' => 'memory', 'title' => ''],
+ 'Content' => ['description' => 'The content of the recalled knowledge chunk.', 'type' => 'string', 'example' => 'sky is blue', 'title' => ''],
+ 'Score' => ['description' => 'The similarity score of this data entry. The scoring algorithm is related to the algorithm (l2/ip/cosine) specified when the index was created.', 'type' => 'number', 'format' => 'double', 'example' => '0.65', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'The return value. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Succeeded.'."\n"
+ .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Get dataAgent session description',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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\\": \\"\\",\\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"}]',
- ],
- 'ListDataLakePartitionName' => [
- 'summary' => '获取数据湖表分区名列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Retrieves the details of a specific document.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4615,330 +4872,545 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '249778',
- 'abilityTreeNodes' => [
- 'FEATUREdms90TD19',
- 'FEATUREdmsKIHNZQ',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
],
'parameters' => [
[
- 'name' => 'Tid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
],
[
- 'name' => 'CatalogName',
- 'in' => 'query',
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique request ID. Provide this ID for troubleshooting if an error occurs.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'example' => 'kb-***', 'title' => ''],
+ 'Name' => ['description' => 'The name of the document.', 'type' => 'string', 'example' => 'test.md', 'title' => ''],
+ 'Description' => ['description' => 'The description of the document.', 'type' => 'string', 'example' => 'abc', 'title' => ''],
+ 'FileExt' => ['description' => 'The file extension of the document.', 'type' => 'string', 'example' => 'md', 'title' => ''],
+ 'DocumentLoaderName' => ['description' => 'The name of the document loader.', 'type' => 'string', 'example' => 'ADBPGLoader', 'title' => ''],
+ 'TextSplitterName' => ['description' => 'The name of the text splitter.', 'type' => 'string', 'example' => 'ChineseRecursiveTextSplitter', 'title' => ''],
+ 'FileSize' => ['description' => 'The size of the document in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '20307', 'title' => ''],
+ 'DocsCount' => ['description' => 'The number of chunks.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'State' => ['description' => 'The document state. Possible values are:'."\n"
+ ."\n"
+ .'- **0**: Parsing complete.'."\n"
+ ."\n"
+ .'- **-1**: Not parsed.'."\n"
+ ."\n"
+ .'- **-2**: Parsing in progress.'."\n"
+ ."\n"
+ .'- **-3**: Parsing failed.'."\n"
+ ."\n"
+ .'- **-4**: Parsing canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time of the document, in UTC.', 'type' => 'string', 'example' => '2026-04-22 22:59:35', 'title' => ''],
+ 'GmtModified' => ['description' => 'The last modification time of the document, in UTC.', 'type' => 'string', 'example' => '2026-04-24 21:22:53', 'title' => ''],
+ 'Summary' => ['description' => 'The summary of the document.', 'type' => 'string', 'example' => 'This is a test document.', 'title' => ''],
+ 'Keywords' => ['description' => 'The keywords of the document.', 'type' => 'string', 'example' => '["test","abc"]', 'title' => ''],
+ ],
+ 'description' => 'The details of the document.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeDocument',
+ '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' => 'Retrieves the signature information for file uploads.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'DbName',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DmsUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'CallFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- ],
+ 'schema' => ['description' => 'The parameter used only by the frontend.', 'type' => 'string', 'required' => false, 'example' => '仅前端使用', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0FEE5834-C55A-5995-A6A3-B443304965BD'],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OssCredential' => ['description' => 'The parameter set that specifies the derived key.', 'type' => 'string', 'example' => 'STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request', 'title' => ''],
+ 'OssDate' => ['description' => 'The time of the request. The format follows the ISO 8601 date and time standard.', 'type' => 'string', 'example' => '20260101T135341Z', 'title' => ''],
+ 'OssSignatureVersion' => ['description' => 'The version and algorithm of the signature.', 'type' => 'string', 'example' => 'OSS4-HMAC-SHA256', 'title' => ''],
+ 'OssSignature' => ['description' => 'The description information used for signature authentication.', 'type' => 'string', 'example' => '9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********', 'title' => ''],
+ 'OssSecurityToken' => ['description' => 'The STS token used to upload files to OSS. The token is valid for 1 hour.', '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**********', 'title' => ''],
+ 'Policy' => ['description' => 'The permission restrictions and constraints for file uploads.', 'type' => 'string', 'example' => 'eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********'."\n", 'title' => ''],
+ 'UploadHost' => ['description' => 'The destination address for file uploads.', 'type' => 'string', 'example' => 'https://**********.oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'UploadDir' => ['description' => 'The path for file uploads.', 'type' => 'string', 'example' => 'data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ .'- **false**: The request fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve file upload signature information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeFileUploadSignature',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'DescribeKnowledgeBaseStats' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'WorkspaceId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'KbUuid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'kb-***'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot errors.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'KbUuid' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'title' => '', 'example' => 'kb-***'],
+ 'TotalFileSize' => ['description' => 'The total size of all files in the knowledge base, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '4194588751', 'title' => ''],
+ 'DocumentCount' => ['description' => 'The number of documents in the knowledge base.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
+ 'TotalChunkCount' => ['description' => 'The total number of knowledge chunks in the knowledge base.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
+ 'KbHits' => ['description' => 'The number of hits for the knowledge base.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '18'],
],
+ 'description' => 'The object that contains the knowledge base statistics.',
+ 'title' => '',
+ 'example' => '',
],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of `true` indicates success, and a value of `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'Permission denied.', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Knowledge base limit exceeded. Current: xxx', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionNameList\\": [\\n \\"part_1\\"\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- ],
- 'ListDataLakePartitionByFilter' => [
- 'summary' => '根据筛选条件获取数据湖表分区列表',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeKnowledgeBaseStats',
+ 'summary' => 'Retrieves the statistics of a knowledge base.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeKnowledgeBaseStats',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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' => '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' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique ID of the request. If an error occurs, use this ID to troubleshoot the issue.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OssCredential' => ['description' => 'The credential scope string for the signature.', 'type' => 'string', 'example' => 'STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request', 'title' => ''],
+ 'OssDate' => ['description' => 'The request time in ISO 8601 format.', 'type' => 'string', 'example' => '20260101T135341Z', 'title' => ''],
+ 'OssSignatureVersion' => ['description' => 'The signature version and algorithm.', 'type' => 'string', 'example' => 'OSS4-HMAC-SHA256', 'title' => ''],
+ 'OssSignature' => ['description' => 'The authentication signature.', 'type' => 'string', 'example' => '9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********', 'title' => ''],
+ 'OssSecurityToken' => ['description' => 'The STS token used for uploading to OSS. It is valid for one hour.', '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**********', 'title' => ''],
+ 'Policy' => ['description' => 'The Base64-encoded POST policy that specifies the conditions for the file upload.', 'type' => 'string', 'example' => 'eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aRmR2RDJRWlFSeWlwZmpkS295NEYxb2ovMjAyNjA1MTQvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjA1MTRUMDMzMjI3WiJ9LHsieC1vc3Mtc2VjdXJpdHktdG9rZW4iOiJDQUlTMmdKMXE2RnQ1QjJ5ZlNqSXI1bnpMOHp3MzQ1NzVwQ1NhMWJYam1RZVkvWVlxZlRFaUR6MklIaE1**', 'title' => ''],
+ 'UploadHost' => ['description' => 'The destination URL for the file upload.', 'type' => 'string', 'example' => 'https://onemeta-kb-staging.oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'UploadDir' => ['description' => 'The path prefix for the file upload.', 'type' => 'string', 'example' => 'knowledge_base/1666698***/kb-***', 'title' => ''],
+ ],
+ 'description' => 'The upload signature details.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code if the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message if the request fails.', 'type' => 'string', 'example' => 'Resource not found xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response data.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeKnowledgeBaseUploadSignature',
+ 'summary' => 'Generates a signature to upload a document to a knowledge base.',
+ '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' => 'CatalogName',
+ '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' => 'hive',
- ],
+ 'schema' => ['description' => 'The current Data Management unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'Filename',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'conversion_metrics.csv', 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'UploadLocation',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
- ],
+ 'schema' => ['description' => 'The full path of the uploaded file.'."\n"
+ .'- Format: The UploadDir field returned by the DescribeFileUploadSignature operation concatenated with the file name.'."\n"
+ .'- Example: ${UploadDir}/${Filename}', 'type' => 'string', 'required' => true, 'example' => 'data_agent/file_upload/174483******/20251219T******Z/n87bgtx6dk******/conversion_metrics.csv', 'title' => ''],
],
[
- 'name' => 'Filter',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ds>20241201',
- ],
+ 'name' => 'FileSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8110', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'CallFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
- ],
+ 'schema' => ['description' => 'Used only by the frontend.', 'type' => 'string', 'required' => false, 'example' => 'TrailCenter', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'OssBucket',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '841BC14F-8E21-56B0-A7D6-593C5841AC84'],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'f-8*******01m'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful. '."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Callback after file upload',
+ 'summary' => 'Calls back after a file is uploaded.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:FileUploadCallback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ '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' => ['description' => 'The ID of the Airflow instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'af-b3a7f110a6vmvn7****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '8630242382****', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['title' => 'request id', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-****'],
+ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
+ 'Root' => [
'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****',
- ],
- 'Success' => [
- 'description' => '',
- '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',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AirflowName' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'testairflow'],
+ 'AppSpec' => ['description' => 'The specifications of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'SMALL'],
+ 'AppType' => ['description' => 'The application type.', 'type' => 'string', 'title' => '', 'example' => 'AIRFLOW'],
+ 'CustomAirflowCfg' => [
+ 'title' => '',
+ 'description' => 'The custom configurations.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A custom configuration entry.', 'type' => 'string', 'title' => '', 'example' => 'smtp.username=test'],
+ 'example' => '',
+ ],
+ 'DagsDir' => ['description' => 'The DAG directory that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/dags'],
+ 'DeployErrorMsg' => ['description' => 'The deployment error message.', 'type' => 'string', 'title' => '', 'example' => 'Deployed'],
+ 'Description' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'test airflow'],
+ 'GmtCreated' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '2025-08-12T05:46:01.000+0000'],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'osstest'],
+ 'OssPath' => ['description' => 'The OSS path.', 'type' => 'string', 'title' => '', 'example' => '/airflow'],
+ 'PluginsDir' => ['description' => 'The plugin directory that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/plugins'],
+ 'RequirementFile' => ['description' => 'The path to the Python dependencies file (requirements.txt).', 'type' => 'string', 'title' => '', 'example' => 'default/requirements.txt'],
+ 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'title' => '', 'example' => 'sg-2ze9gj646bkv****'],
+ 'StartupFile' => ['description' => 'The startup script that runs before Airflow starts.', 'type' => 'string', 'title' => '', 'example' => 'default/startup.sh'],
+ 'Status' => ['description' => 'The status of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'DEPLOYED'],
+ 'AirflowId' => ['description' => 'The ID of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'af-7a6ygsh80dx1jn****'],
+ 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'title' => '', 'example' => 'vsw-bp1931trfxkvf74v****'],
+ 'VpcId' => ['title' => 'VPC ID', 'description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-2zevqv4obraqd5p****'],
+ 'WorkerServerlessReplicas' => ['description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'WorkspaceId' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'title' => '', 'example' => '8630242382****'],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'],
+ 'RegionId' => ['title' => 'region', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Unknown error'],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The following values are returned:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'InvalidAirflow.NotFound', 'errorMessage' => 'The specified Airflow does not exist.', 'description' => ''],
+ ],
],
- '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"}]',
- ],
- 'ListDataLakePartition' => [
- 'summary' => '获取数据湖表分区列表',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'GetAirflow',
+ 'summary' => 'Queries the configuration and status of an Airflow instance.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'GetChatContent' => [
+ 'summary' => 'Retrieves chat content from a specific checkpoint by specifying the session ID and AgentId.',
+ 'path' => '/api/v1/chat/stream',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -4950,173 +5422,248 @@
'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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The current DMS unit. Chinese mainland users of Alibaba Cloud should use cn-hangzhou by default.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'CatalogName',
+ 'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The session ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'sess_12345', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'AgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The agent ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxxx-xxxx', 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'Checkpoint',
'in' => 'query',
+ 'schema' => ['description' => 'The backend will return output starting from this checkpoint.', 'type' => 'string', 'default' => '0', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
+ 'description' => 'Each data entry in the SSE response stream conforms to this JSON structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'Data understanding completed.', 'title' => ''],
+ 'event_type' => ['description' => 'The type of the message, used to distinguish control signals from actual messages. For example, `CHAT_START` indicates the beginning of an Agent reply, `CHAT_FINISH` indicates the end of an Agent reply, `DATA` indicates a message carrying content, and `DELTA` indicates a part of an incrementally output message.', 'type' => 'string', 'example' => 'DATA', 'title' => ''],
+ 'content_type' => ['description' => 'The type of the content field. Valid values: `[str, json]`. When the value is json, the content field can be further parsed as a JSON structure.', 'type' => 'string', 'example' => 'str', 'title' => ''],
+ 'checkpoint' => ['description' => 'The checkpoint value.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'level' => ['description' => 'The output level of the message. A higher level indicates higher importance.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'category' => ['description' => 'The category of the message, used to assist in parsing the content of the json type. For example, `PLAN` indicates that the message is a display of an execution plan and conforms to the execution plan schema.', 'type' => 'string', 'example' => 'PLAN', 'title' => ''],
+ 'timestamp' => ['description' => 'The UNIX timestamp in seconds when this message was generated by the Agent.', 'type' => 'string', 'example' => '1774578047', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetChatContent',
+ 'description' => '## Request Description'."\n"
+ .'- The response is returned as an SSE stream, where each event follows the `SSEEvent` schema and contains meta-information such as the message level.'."\n"
+ .'- The `content` field in each SSE event may carry actual message text or a JSON object, depending on the value of `content_type`.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PartNames',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'part_1',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetChatContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ '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' => 'Retrieves information about a RAM user that belongs to an Alibaba Cloud account.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'SubAccountId',
'in' => 'query',
+ 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => false, 'example' => '20282*****7591', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-***-695C'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserName' => ['description' => 'The name of the queried RAM user.', 'type' => 'string', 'example' => 'yunqitest', 'title' => ''],
+ 'UserId' => ['description' => 'The UID of the queried RAM user.', 'type' => 'string', 'example' => '20282*****7591'."\n", 'title' => ''],
+ 'CreateDate' => ['description' => 'The time when the user was created in RAM. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765960516', 'title' => ''],
+ 'UpdateDate' => ['description' => 'The time when the user information was last updated. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765962516', 'title' => ''],
+ 'MainAccountId' => ['description' => 'The ID of the Alibaba Cloud account to which the user belongs.', 'type' => 'string', 'example' => '167*****166', 'title' => ''],
+ ],
+ 'description' => 'The returned data structure.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataAgentSubAccountInfo',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataAgentSubAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ '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' => 'Retrieves the details of a collaborative workspace.',
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the collaborative workspace.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****',
- ],
- 'Success' => [
- 'description' => '',
- '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' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D2-*****-A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => ['description' => 'The ID of the collaborative workspace.', 'type' => 'string', 'example' => '20923*****7291', 'title' => ''],
+ 'WorkspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'workspaceTest', 'title' => ''],
+ 'WorkspaceStatus' => ['description' => 'The status of the workspace.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'Creator' => ['description' => 'The UID of the workspace creator.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'RoleName' => ['description' => 'The role name of the user in the workspace.', 'type' => 'string', 'example' => 'admin', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time of the session. Unit: seconds. The value is a UNIX timestamp.', 'type' => 'string', 'example' => '1765960516', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The most recent modification time of the workspace. Unit: seconds. The value is a UNIX timestamp.', 'type' => 'string', 'example' => '1765961516', 'title' => ''],
+ 'WorkspaceDesc' => ['description' => 'The description of the collaborative workspace.', 'type' => 'string', 'example' => 'space for test', 'title' => ''],
+ 'TotalMember' => ['description' => 'The number of members in the workspace.', 'type' => 'string', 'example' => '11', 'title' => ''],
+ 'IsSessionShareEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- ],
- 'GetDataLakePartition' => [
- 'summary' => '获取湖仓表分区详情',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve collaborative workspace details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataAgentWorkspaceInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 \\"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\\": false,\\n \\"Type\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetDataLakeCatalog' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5128,9 +5675,8 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeCode' => '249777',
+ 'abilityTreeNodes' => ['FEATUREdms90TD19'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -5138,123 +5684,153 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'DbName',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The tenant ID. You can call the GetUserActiveTenant or ListUserTenants operation to obtain this value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'TableName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '400'],
+ 'ErrorMessage' => ['description' => 'Error message returned when the request fails.', 'type' => 'string', 'title' => '', 'example' => 'code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B****'],
+ 'Catalog' => ['description' => 'The details of the data catalog.', '$ref' => '#/components/schemas/DLCatalog', 'title' => '', 'example' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataLakeCatalog',
+ 'summary' => 'Retrieves the data catalog of a data lake.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PartitionValues',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'part_val1',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeCatalog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => true,
],
],
+ ],
+ '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' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'],
+ ],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Partition' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLPartition',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '404'],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF54111****'],
+ 'Database' => ['description' => 'The information about the database.', '$ref' => '#/components/schemas/DLDatabase', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataLakeDatabase',
+ 'summary' => 'Retrieves information about a database in a data lake.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'DeleteDataLakeTable' => [
- 'summary' => '删除湖仓表',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => [
[
'AK' => [],
@@ -5263,12 +5839,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -5276,116 +5850,80 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'TableName',
+ 'name' => 'FunctionName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
- ],
+ 'schema' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_funciton'],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8E88933E-E3D4-5BA8-8CBF-0A1CAE66****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ ."\n"
+ .'- **false**: The request fails.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Function' => ['description' => 'The details of the function.', '$ref' => '#/components/schemas/DLFunction', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataLakeFunction',
+ 'summary' => 'Retrieves the details of a user-defined function in a data lake.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAE66****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ '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"}]',
],
- 'DeleteDataLakePartition' => [
- 'summary' => '删除湖仓表分区',
+ 'GetDataLakePartition' => [
+ 'summary' => 'Retrieves the details of a data lakehouse table partition.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- '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' => ['FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -5393,143 +5931,91 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
],
[
'name' => 'PartitionValues',
'in' => 'query',
'style' => 'simple',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of partition values.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'part_val1',
- ],
+ 'items' => ['description' => 'The value of a partition key column.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'part_val1'],
'required' => true,
- ],
- ],
- [
- 'name' => 'IfExists',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The call was successful.'."\n"
+ ."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Partition' => ['description' => 'The information about the data lakehouse table partition.', '$ref' => '#/components/schemas/DLPartition', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataLakePartition',
+ '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"}]',
+ '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"}]',
],
- 'DeleteDataLakeDatabase' => [
- 'summary' => '删除湖仓数据库',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ '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',
],
@@ -5537,366 +6023,351 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database to which the table belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '100g_customer'],
],
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID. Call the GetUserActiveTenant or ListUserTenants operation to get this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C51420E3-144A-4A94-B473-8662FCF4****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '400'],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Unknown server error'],
+ 'Table' => ['description' => 'The information about the table.', '$ref' => '#/components/schemas/DLTable', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetDataLakeTable',
+ 'summary' => 'Retrieves information about a table in a data lake.',
+ '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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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\\": \\"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"}]',
],
- 'CreateDataLakeTable' => [
- 'summary' => '新建湖仓表',
+ 'GetNotebookAndSubmitTask' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'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' => ['type' => 'string', 'required' => true, 'description' => 'The path of the Notebook file.', 'title' => '', 'example' => '/Workspace/code/default/test.ipynb'],
],
[
- 'name' => 'DbName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'name' => 'Params',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The input parameters for the Notebook file. Pass the parameters in a dictionary format.', 'title' => '', 'example' => '{\'dt\': \'2022-10-14\'}'],
],
[
- 'name' => 'TableInput',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => true,
- '$ref' => '#/components/schemas/DLTableInput',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The session ID.', 'title' => '', 'example' => '8vkixxxxx***'],
],
[
- 'name' => 'Tid',
+ 'name' => 'Retry',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The number of retries if scheduling fails.', 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => '8630242382****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request succedded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succedded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'title' => '', 'example' => 'true'],
+ 'ErrMsg' => ['type' => 'string', 'description' => 'The returned message.', 'title' => '', 'example' => 'Request Invalid'],
+ 'TaskId' => ['type' => 'string', 'description' => 'The ID of the scheduled task.', 'title' => '', 'example' => 'IcICC2nbMpYp9KygS43n010100'],
+ 'SessionId' => ['type' => 'string', 'description' => 'The session ID.', 'title' => '', 'example' => '5zrs5szpiezlb9m3qxi6zp32h'],
+ 'Code' => ['type' => 'string', 'description' => 'The status code. `Success` indicates that the request was successful.', 'title' => '', 'example' => 'Success'],
+ 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => 'HTTP status code.', 'title' => '', 'example' => '200'],
+ ],
+ 'title' => '',
+ 'description' => 'The response.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetNotebookAndSubmitTask',
+ 'summary' => 'Submits a task to schedule and run a Notebook file.',
+ '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' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The scheduling task ID.', 'type' => 'string', 'required' => false, 'example' => 'c2b4cb5a-7420-49a8-aa7c-528becd6e1bf', 'title' => ''],
+ ],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8630242382****', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Notebook session ID.', 'type' => 'string', 'required' => false, 'example' => '8141456676986429894916354', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Table' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLTable',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'],
+ 'HttpStatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance not found.', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of Success indicates that the request was successful.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NotebookSchedulePreviewUrl' => ['description' => 'The URL to preview the scheduling result.', 'type' => 'string', 'example' => 'https://dms.aliyun.com/web-ide?***', 'title' => ''],
+ 'Status' => ['description' => 'The status of the scheduling result.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Progress' => ['description' => 'The progress of the scheduling task.', 'type' => 'string', 'example' => '5/6', 'title' => ''],
+ 'Result' => ['description' => 'The output of the scheduling task.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ ],
+ 'description' => 'The scheduling result.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetNotebookTaskStatus',
+ 'summary' => 'Retrieves the execution status of a Notebook task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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\\": \\"\\",\\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"}]',
+ '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"}]',
],
- 'CreateDataLakePartition' => [
- 'summary' => '新建湖仓表分区',
+ 'GetSqlConsoleOperationLog' => [
+ 'summary' => 'Queries the operation logs of the SQL window.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ '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' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'Schema',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
- ],
+ 'schema' => ['description' => 'The database schema.', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''],
],
[
- 'name' => 'PartitionInput',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => true,
- '$ref' => '#/components/schemas/DLPartitionInput',
- ],
+ 'name' => 'SqlType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'SELECT', 'title' => ''],
],
[
- 'name' => 'IfNotExists',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'NeedResult',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''],
],
[
- 'name' => 'Tid',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The start time of the logs.', 'type' => 'string', 'required' => true, 'example' => '2026-01-01 00:00:00', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The end time of the logs.', 'type' => 'string', 'required' => true, 'example' => '2026-06-01 00:00:00', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'C0A813EB-4623-523A-8598-86390CB4****', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['description' => 'The start time of the logs.', 'type' => 'string', 'example' => '2026-01-01 00:00:00', 'title' => ''],
+ 'Schema' => ['description' => 'The database schema.', 'type' => 'string', 'example' => 'mysql', 'title' => ''],
+ 'Sql' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => 'SELECT * FROM user;', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the statement is executed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'AffectRows' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'Cost' => ['description' => 'The execution duration. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Error' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Access Denied', 'title' => ''],
+ 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'user', 'title' => ''],
+ 'DatabaseSearchName' => ['description' => 'The database search name.', 'type' => 'string', 'example' => 'mysql@xxx.com', 'title' => ''],
+ 'SqlType' => ['description' => 'The SQL type.', 'type' => 'string', 'example' => 'SELECT', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '400', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of logs.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query SQL window operation logs',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
+ '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"}]',
],
- 'CreateDataLakeDatabase' => [
- 'summary' => '新建湖仓数据库',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetWorkspaceCode' => [
+ 'summary' => 'Reads the content of a code file in the workspace and returns the file content along with mtime (in the header).',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5905,820 +6376,1896 @@
'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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12****', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'Path',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => '', 'description' => 'The code file path: /Workspace/code/test.py'."\n"
+ .'Request path.', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb'],
],
[
- 'name' => 'Description',
+ 'name' => 'Iac',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'If the file is a JSON file and Iac is set to true, the returned content is converted from JSON format to YAML format.', 'type' => 'string', 'required' => false, 'example' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '', 'description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.'],
+ 'Data' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'example' => 'log info'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Reads the content of a file in the workspace.',
+ 'description' => 'Obtains the resource configuration limit information and the instance purchase status of the workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Location',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://path/to/database',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => [
[
- 'name' => 'Parameters',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '8630242382****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"key":"value"}',
- 'description' => '',
+ 'properties' => [
+ 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Repos' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Repo' => ['description' => 'The name of the repository.', 'type' => 'string', 'example' => 'analyticscomputing/dide', 'title' => ''],
+ 'Path' => ['description' => 'The path to the notebook file.', 'type' => 'string', 'example' => '/luna-public/', 'title' => ''],
+ 'Branch' => ['description' => 'The name of the branch.', 'type' => 'string', 'example' => 'main', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The Git repositories in the workspace.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Exclude' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'A file or directory pattern to exclude from the deployment.', 'type' => 'string', 'example' => '[\\"/exclude_*.log\\", \\"temp_file.tmp\\"]', 'title' => ''],
+ 'description' => 'The files and directories to exclude from the deployment.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'LockRepoBranch' => ['description' => 'Indicates whether the deployment branch is locked. If `true`, configurations submitted via the `workspaceCodePublish` API are ignored. If `false`, configurations submitted via the `workspaceCodePublish` API update the settings.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Code' => ['description' => 'The status code that indicates the result of the request. A value of `200` indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ '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' => 'GetWorkspaceCodePublishSetting',
+ 'summary' => 'Retrieves the deployment configuration of a workspace.',
+ 'description' => 'This operation retrieves the deployment configuration of a workspace. The configuration includes details such as repository and branch information, and directories to 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' => 'Returns the quota for a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Tid',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '20923*****7291'],
+ 'InstanceId' => ['description' => 'The ID of the billing instance.', 'type' => 'string', 'title' => '', 'example' => 'i-bp16pha0zu99yybi59qr'],
+ 'CuQuota' => ['description' => 'The CU quota.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'CuQuotaUsage' => ['description' => 'The amount of CU quota used.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
+ 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'title' => '', 'example' => 'RELEASED'],
+ 'NotebookFreeQuotaAvailable' => ['description' => 'The available free notebook quota (in CU-H).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ 'NotebookFreeQuotaTotal' => ['description' => 'The total free notebook quota (in CU-H).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'],
+ ],
+ 'title' => '',
+ 'description' => 'The returned data.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'Successful'],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'InvalidTid'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetWorkspaceQuota',
+ 'description' => 'Retrieves the resource quotas and instance status for a workspace.',
+ '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' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
+ ],
+ 'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8630242382****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'The reason for the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
+ 'Root' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The details of an entry in the version list.', 'type' => 'string', 'example' => '{\'Responses\': {\'responses\': [{\'Uuid\': \'af-63ly5o1yuf076ifrpbxpka396\', \'Success\': True}]}}', 'title' => ''],
+ 'title' => '',
+ 'description' => 'The version list.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code for a failed request.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'title' => 'ListAirflowVersions',
+ 'summary' => 'Lists the available Airflow versions.',
+ 'description' => 'Lists the available Airflow versions.',
+ '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' => 'Retrieves a list of Airflow instances in a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsXSH6IQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '86302423828****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'f056501ada12****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Skip',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of records to skip. This is used for paging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
+ 'Root' => [
+ 'title' => '',
+ 'description' => 'The details of the data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'List' => [
+ 'title' => '',
+ 'description' => 'The list of data.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AirflowName' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'test-airflow'],
+ 'AppSpec' => ['description' => 'The specifications of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'SMALL'],
+ 'AppType' => ['description' => 'The type.', 'type' => 'string', 'title' => '', 'example' => 'AIRFLOW'],
+ 'CustomAirflowCfg' => [
+ 'title' => '',
+ 'description' => 'The custom configuration.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The configuration item.', 'type' => 'string', 'title' => '', 'example' => 'k=v'],
+ 'example' => '',
+ ],
+ 'DagsDir' => ['description' => 'The DAGs folder that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/dags'],
+ 'DeployErrorMsg' => ['description' => 'The error message returned when the deployment fails.', 'type' => 'string', 'title' => '', 'example' => 'quota exists'],
+ 'Description' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'GmtCreated' => ['description' => 'The time when the Airflow instance was created.', 'type' => 'string', 'title' => '', 'example' => '2025-08-12T05:46:01.000+0000'],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'osstest'],
+ 'OssPath' => ['description' => 'The path in OSS.', 'type' => 'string', 'title' => '', 'example' => '/airflow'],
+ 'PluginsDir' => ['description' => 'The plugins folder that Airflow scans.', 'type' => 'string', 'title' => '', 'example' => 'default/plugins'],
+ 'RequirementFile' => ['description' => 'The path to the file that contains the dependencies.', 'type' => 'string', 'title' => '', 'example' => 'default/requirements.txt'],
+ 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'title' => '', 'example' => 'sg-2ze1nak7h0alg1w****'],
+ 'Status' => ['description' => 'The status of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'DEPLOYED'],
+ 'AirflowId' => ['description' => 'The ID of the Airflow instance.', 'type' => 'string', 'title' => '', 'example' => 'af-7a6ygsh80d****'],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'title' => '', 'example' => 'vsw-uf6sxdc22x7sbdb****'],
+ 'VpcId' => ['title' => 'VPC ID', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-8vbbfm33dy0y1pek****'],
+ 'WorkerServerlessReplicas' => ['description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'],
+ 'WorkspaceId' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'title' => '', 'example' => '8630242382****'],
+ 'ZoneId' => ['description' => 'The ID of the zone in the region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'],
+ 'StartupFile' => ['description' => 'The path to the script that is loaded when Airflow starts.', 'type' => 'string', 'title' => '', 'example' => 'default/startup.sh'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'TotalCount' => ['description' => 'The total number of matching Airflow instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code. This parameter is returned when an error occurs.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'NesLoKLEdIZrKhDT7I2gS****', 'title' => ''],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '100', 'example' => '20', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'ListAirflows',
+ '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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListAirflows',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
- 'BatchUpdateDataLakePartitions' => [
- 'summary' => '批量更新湖仓表分区',
+ 'ListCustomAgent' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
],
'parameters' => [
[
- 'name' => 'CatalogName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A keyword for a fuzzy search on the names and descriptions of custom agents.', 'type' => 'string', 'required' => false, 'example' => '测试Agent', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The status of the custom agent.',
+ 'enumValueTitles' => ['NEW' => 'Created but not published.', 'RELEASED' => 'The agent is published.', 'DRAFT' => 'An unpublished draft.', 'OFFLINE' => 'The agent is no longer published.'],
'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ 'required' => false,
+ 'example' => 'RELEASED',
+ 'title' => '',
],
],
[
- 'name' => 'TableName',
+ 'name' => 'QueryAllReleased',
'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to query all published custom agents. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page size. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_table',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => 'Agent测试名称', 'title' => ''],
+ 'Description' => ['description' => 'The description of the custom agent.', 'type' => 'string', 'example' => 'Agent测试描述', 'title' => ''],
+ 'DataJson' => ['description' => 'The data scope, specified as a JSON string.', '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"
+ .'}', 'title' => ''],
+ 'Instruction' => ['description' => 'The instructions.', 'type' => 'string', 'example' => '分析框架：'."\n"
+ .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n"
+ .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n"
+ .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', 'title' => ''],
+ 'Knowledge' => ['description' => 'The provided knowledge.', 'type' => 'string', 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the custom agent.',
+ 'enumValueTitles' => ['NEW' => 'Created but not published.', 'RELEASED' => 'Published.', 'DRAFT' => 'Draft, not published.', 'OFFLINE' => 'Taken offline.'],
+ 'type' => 'string',
+ 'example' => 'RELEASED',
+ 'title' => '',
+ ],
+ 'ReleaseTime' => ['description' => 'The time when the agent was published.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'OfflineTime' => ['description' => 'The time when the agent was taken offline.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'Modifier' => ['description' => 'The user who last modified the agent.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'AliyunParentId' => ['description' => 'The parent Alibaba Cloud account ID.', 'type' => 'string', 'example' => '16738266********', 'title' => ''],
+ 'DmsUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the agent was created.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the agent was last modified.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'KnowledgeConfigList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'McpServerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'KbUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExecutionConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipPlan' => ['description' => 'Indicates whether to skip the plan confirmation step.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Indicates whether to skip all SQL confirmations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Indicates whether to skip the confirmation for generating a web report.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Indicates whether to prevent user inquiries during the process.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'description' => 'The execution configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TextReportConfig' => ['description' => 'The formatting instructions for the text report.', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'WebReportConfig' => ['description' => 'The formatting instructions for the web report.', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'DefaultAgent' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'CreatorUserName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'ModifierUserName' => ['description' => 'The name of the user who last modified the agent.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'DMSUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'IsScheduleTask' => ['description' => 'Indicates whether the agent is configured with a recurring task.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'NextRuntime' => ['description' => 'If a recurring task is configured, this indicates its next scheduled runtime.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200', 'title' => ''],
+ 'ScheduleTaskConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedSessionId' => ['description' => 'The ID of the referenced historical session.', 'type' => 'string', 'example' => '4m24*****mg7j2v'."\n", 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the recurring task.', 'type' => 'string', 'example' => '0 0 0 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The query for the recurring task.', 'type' => 'string', 'example' => '分析一下这份数据，给出简报', 'title' => ''],
+ ],
+ 'description' => 'The recurring task configuration.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CallbackConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ToolId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RelatedSessionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'A custom agent object.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of custom agent objects.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'TotalElements' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListCustomAgent',
+ 'summary' => 'ListCustomAgent returns a list of all custom agents from the personal space and workspaces.',
+ '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' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 \\"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"}]',
+ ],
+ 'ListDataAgentAccuracyTestInstances' => [
+ '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'Nes****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'PartitionErrors' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'MaxResults' => ['description' => 'The maximum number of entries returned per page. You can use this parameter together with NextToken to implement paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'zCXS*****', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '3', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'string', 'example' => '1768270172', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
'type' => 'array',
'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/PartitionError',
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccuracyTestInsId' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
+ 'Name' => ['description' => 'The custom agent name.', 'type' => 'string', 'example' => 'Agent测试名称', 'title' => ''],
+ 'Creator' => ['description' => 'The UID of the workspace creator.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'AgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-4x8uzp5wjqu4xxxxxxxxxx', 'title' => ''],
+ 'MaxConcurrent' => ['description' => 'The maximum number of concurrent sessions during testing.', 'type' => 'string', 'example' => '5', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ 'FileId' => ['description' => 'The test set file ID.', 'type' => 'string', 'example' => 'f-8*******01m'."\n", 'title' => ''],
+ 'Language' => ['description' => 'The language used for the analysis task.', 'type' => 'string', 'example' => 'CHINESE', 'title' => ''],
+ 'Mode' => ['description' => 'The analysis mode to be tested.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'NeedDelete' => ['description' => 'Specifies whether sessions are displayed after analysis. This feature is not currently supported.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-06-30T07:31:09.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2026-06-30T07:31:09.000+00:00', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'List accuracy test configuration items',
+ 'summary' => 'Lists accuracy test configuration items that meet the specified conditions.',
+ 'description' => 'Lists accuracy test configuration items that meet the specified conditions.',
+ '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"}]',
+ '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"}]',
],
- 'BatchDeleteDataLakePartitions' => [
- 'summary' => '批量删除湖仓表分区',
+ 'ListDataAgentAccuracyTestResults' => [
+ 'summary' => 'Retrieves the execution results of a self-test task.',
'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,
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'CatalogName',
+ 'name' => 'AccuracyTestInsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The instance ID of the accuracy test to which the task belongs.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'AccuracyTestTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The ID of the accuracy test task.', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'TableName',
+ 'name' => 'AccuracyTestSubtaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- ],
+ 'schema' => ['description' => 'The subtask ID used to filter results.', 'type' => 'string', 'required' => false, 'example' => 'f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'PartitionValuesList',
+ 'name' => 'AccuracyTestResultId',
'in' => 'query',
- 'style' => 'flat',
+ 'schema' => ['description' => 'The result ID used to retrieve a single record.', 'type' => 'string', 'required' => false, 'example' => 'at-emhnbwewfngrxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'nu use', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'NesLoKLEdIZrKhDT7I2gS****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'part_val1',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Content' => [
+ 'description' => 'The data content.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultId' => ['description' => 'The result ID.', 'type' => 'string', 'example' => 'at-emhnbwewfngrxxxxxxxxxx', 'title' => ''],
+ 'SubtaskId' => ['description' => 'The subtask ID.', 'type' => 'string', 'example' => 'f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
+ 'Question' => ['description' => 'The test question.', 'type' => 'string', 'example' => '拥有Senior Engineer头衔的员工有多少人？', 'title' => ''],
+ 'AnswerResult' => ['description' => 'The expected answer.', 'type' => 'string', 'example' => '97750', 'title' => ''],
+ 'AnswerSql' => ['description' => 'The expected SQL statement.', 'type' => 'string', 'example' => 'SELECT COUNT(*) FROM titles WHERE title = \'Senior Engineer\';', 'title' => ''],
+ 'AgentResult' => ['description' => 'The actual answer returned by the agent.', 'type' => 'string', 'example' => '在公司历史职位记录中，共有97,750名员工曾拥有Senior Engineer头衔。', 'title' => ''],
+ 'IsTrue' => ['description' => 'The AI evaluation result.', 'type' => 'boolean', 'example' => ' true', 'title' => ''],
+ 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'SQL 中不应该使用COUNT(DISTINCT)', 'title' => ''],
+ 'Recommendation' => ['description' => 'The improvement suggestion.', 'type' => 'string', 'example' => '在问题中描述清楚是否需去重', 'title' => ''],
+ 'AccuracyTestTaskId' => ['description' => 'The ID of the accuracy test task.', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CorrectCount' => ['description' => 'The number of test cases that passed evaluation.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''],
+ 'AccuracyRate' => ['description' => 'The accuracy rate.', 'type' => 'number', 'format' => 'double', 'example' => '90', 'title' => ''],
+ 'AccuracyTestTaskId' => ['description' => 'The ID of the accuracy test task.', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
+ 'TotalElements' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'MaxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => 'no use', 'title' => ''],
+ 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'no use', 'title' => ''],
],
- 'required' => true,
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve execution results of a self-test task',
+ 'description' => 'Retrieves the execution results of a self-test task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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"}]',
+ ],
+ 'ListDataAgentAccuracyTestTasks' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'IfExists',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'Tid',
+ 'name' => 'AccuracyTestInsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AccuracyTestTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The task ID used for exact filtering.', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'NesLoK****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'PartitionErrors' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
'type' => 'array',
'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/PartitionError',
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccuracyTestTaskId' => ['description' => 'The accuracy test task ID.', 'type' => 'string', 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'title' => ''],
+ 'AccuracyTestInsId' => ['description' => 'The instance ID of the accuracy test to which the task belongs.', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
+ 'TotalTaskNumber' => ['description' => 'The total number of subtasks in the accuracy test task.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'FinishedTaskNumber' => ['description' => 'The number of completed test subtasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''],
+ 'MaxConcurrent' => ['description' => 'The maximum number of concurrent sessions during the test.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'NeedDelete' => ['description' => 'Specifies whether sessions are displayed after analysis. This feature is not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ 'Status' => ['description' => 'The status of the custom agent.', 'type' => 'integer', 'format' => 'int32', 'example' => '0 PENDING,1 RUNNING,2 COMPLETED,3 STOPPED,4 FAILED', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The time when the document was created.', 'type' => 'string', 'example' => '2026-06-30T08:03:30.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the document was last modified.', 'type' => 'string', 'example' => '2026-06-30T08:03:30.000+00:00', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'MaxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'NesLo****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'List accuracy test tasks',
+ 'summary' => 'Queries the running status of self-test tasks by paging.',
+ 'description' => 'Queries the running status of self-test tasks by paging.'."\n"
+ .'If AccuracyTestInsId or AccuracyTestTaskId is empty, all test tasks are queried.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
+ '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"}]',
],
- 'CreateDataLakeFunction' => [
- 'summary' => '新建湖仓自定义函数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListDataAgentSession' => [
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start time of the session creation period.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1770825600000', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateEndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end time of the session creation period.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1770912000000', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsSaved',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to retrieve only favorited sessions.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
+ ],
+ [
+ 'name' => 'QueryType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The session type. This parameter is required if a workspace is specified.',
+ 'enumValueTitles' => ['mySession' => 'sessions created by me.', 'all' => 'all sessions in the workspace.', 'myFavorite' => 'favorited sessions.'],
'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
+ 'required' => false,
+ 'example' => 'myFavorite',
+ 'title' => '',
],
],
[
- 'name' => 'DbName',
+ 'name' => 'Title',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Data Agent title. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => '帮我分析一下这份数据', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomAgentId',
'in' => 'query',
+ 'schema' => ['description' => 'The custom agent ID.', 'type' => 'string', 'required' => false, 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ ],
+ [
+ 'name' => 'Mode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-****'],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The Data Agent session description.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['description' => 'The Data Agent session ID.', 'type' => 'string', 'example' => 'h8r********4fch', 'title' => ''],
+ 'SessionStatus' => ['description' => 'The session status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => '分析一下这份文件，给出报告。', 'title' => ''],
+ 'File' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'f-8*******01m', 'title' => ''],
+ 'SessionConfig' => [
+ 'description' => 'The session configuration item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Language' => ['description' => 'The language. Valid values:'."\n"
+ .'- **CHINESE**: Chinese.'."\n"
+ .'- **ENGLISH**: English.', 'type' => 'string', 'example' => 'CHINESE', 'title' => ''],
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-e*******ckd', 'title' => ''],
+ 'CustomAgentStage' => ['description' => 'The usage stage of the custom agent. Valid values:'."\n"
+ .'- **debug**: Debug stage.'."\n"
+ .'- **prod**: Production stage.', 'type' => 'string', 'example' => 'prod', 'title' => ''],
+ 'Mode' => ['description' => 'The mode. Valid values:'."\n"
+ .' - **ASK_DATA**: Ask data mode.'."\n"
+ .' - **ANALYSIS**: Analysis mode.'."\n"
+ .' - **INSIGHT**: Insight mode.', 'type' => 'string', 'example' => 'ANALYSIS', 'title' => ''],
+ 'EnableSearch' => ['description' => 'Specifies whether to enable web search.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'UserOssBucket' => ['description' => 'The name of the user OSS bucket.'."\n"
+ ."\n"
+ .'- Analysis process files and report artifacts can be uploaded to the user-specified OSS bucket.', 'type' => 'string', 'example' => 'user-oss-bucket', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The session creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731645908000', 'title' => ''],
+ 'Saved' => ['description' => 'Indicates whether the session is favorited by the current logged-in user.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'AgentId' => ['description' => 'The current agent ID.', 'type' => 'string', 'example' => 'cu0cs*******mf', 'title' => ''],
+ 'AgentStatus' => ['description' => 'The current agent status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'FavoriteInWorkspace' => ['description' => 'Indicates whether the session is favorited by the current logged-in user in the workspace.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'UserId' => ['description' => 'The ID of the session owner.', 'type' => 'string', 'example' => '2096******', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request is successful.'."\n"
+ .'- **false**: The request fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The current page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'List data agent sessions',
+ 'summary' => 'Retrieves the list of historical session descriptions for a Data Agent.',
+ '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:ListDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'ListDataAgentWorkspace' => [
+ 'summary' => 'Retrieves the collaborative workspaces under the primary account with pagination.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Tid',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DMSUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'WorkspaceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The type of workspace to query.', 'type' => 'string', 'required' => true, 'example' => 'MY', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'workspaceTest', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to start from.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of records per page.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'no use', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token information.', 'type' => 'string', 'required' => false, 'example' => 'no use', 'title' => ''],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The sort order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the field by which to sort.', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EE214ECD-4330-503A-82F0-FFB03975****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Function' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLFunction',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D2-*****-A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => 'The number of workspaces per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'PageNumber' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'Content' => [
+ 'description' => 'The configuration content.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Creator' => ['description' => 'The UID of the workspace creator.', 'type' => 'string', 'example' => ' '."\n"
+ .'20282*****7591', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The most recent modification time of the workspace. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765961516'."\n", 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time of the workspace. This value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765960516'."\n", 'title' => ''],
+ 'RoleName' => ['description' => 'The role name of the user in the workspace.', 'type' => 'string', 'example' => 'admin', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'space for test', 'title' => ''],
+ 'WorkspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'workspaceTest', 'title' => ''],
+ 'TotalMember' => ['description' => 'The number of members in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''],
+ 'WorkspaceStatus' => ['description' => 'The status of the workspace.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '20923*****7291', 'title' => ''],
+ 'IsSessionShareEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalElements' => ['description' => 'The total number of workspaces.', 'type' => 'integer', 'format' => 'int64', 'example' => '122', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'MaxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => 'nu use', 'title' => ''],
+ 'NextToken' => ['description' => 'The token information.', 'type' => 'string', 'example' => 'no use', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE214ECD-4330-503A-82F0-FFB03975****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]',
- ],
- 'GetDataLakeFunction' => [
- 'summary' => '获取湖仓自定义函数详细信息',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve collaborative workspaces under the primary account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 \\"IsSessionShareEnabled\\": false,\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"TotalElements\\": 122,\\n \\"TotalPages\\": 12\\n },\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"no use\\"\\n}","type":"json"}]',
+ ],
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
],
[
- 'name' => 'FunctionName',
+ 'name' => 'SearchMemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my_funciton',
- ],
+ 'schema' => ['description' => 'The prefix of the member ID to query.', 'type' => 'string', 'required' => false, 'example' => '20273', 'title' => ''],
],
[
- 'name' => 'Tid',
+ 'name' => 'SearchRoleName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The prefix of the member name to query.', 'type' => 'string', 'required' => false, 'example' => 'yunqi', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token.', 'type' => 'string', 'required' => false, 'example' => 'NesLoK****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The sort order.', 'type' => 'string', 'required' => false, 'example' => 'Desc', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The sort field.', 'type' => 'string', 'required' => false, 'example' => 'gmt_create', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D2-*****-A63B6'."\n"],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'PageNumber' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Content' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MemberId' => ['description' => 'The Alibaba Cloud UID of the user.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'UserName' => ['description' => 'The RAM username of the user.', 'type' => 'string', 'example' => 'yunqitest', 'title' => ''],
+ 'JoinTime' => ['description' => 'The time when the user joined the workspace. This is a UNIX timestamp in seconds.', 'type' => 'string', 'example' => '1765961516', 'title' => ''],
+ 'TotalTaskNumber' => ['description' => 'The total number of tasks initiated by the user in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'RoleName' => ['description' => 'The name of the user\'s role in the workspace.', 'type' => 'string', 'example' => 'member', 'title' => ''],
+ 'RunningTaskNumber' => ['description' => 'The number of tasks that are running for the user in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''],
+ ],
+ 'description' => 'The list of workspace member information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The data content.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'no use', 'title' => ''],
+ 'TotalElements' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => 'no use', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => 'no use', 'title' => ''],
+ ],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataAgentWorkspaceMember',
+ 'summary' => 'Lists all members in a workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentWorkspaceMember',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'ListDataCenterDatabase' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DmsUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current Data Management unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
+ ],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'ImportType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The import type.'."\n"
+ .' - FILE', 'type' => 'string', 'required' => false, 'example' => 'FILE', 'title' => ''],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword for fuzzy match of databases.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
+ ],
+ [
+ 'name' => 'CallFrom',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Used only by the frontend.', 'type' => 'string', 'required' => false, 'example' => 'Frontend only', 'title' => ''],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Used only by the frontend.', 'type' => 'string', 'required' => false, 'example' => 'Frontend only', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F1****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Function' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLFunction',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful. '."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response struct.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response struct.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => ['description' => 'The database ID.', 'type' => 'string', 'example' => '6kv159u9vtpvl**********b8', 'title' => ''],
+ 'DbType' => ['description' => '- When ImportType is FILE:'."\n"
+ .' - File type: dbType indicates the file format, such as csv, xlsx, or xls.', 'type' => 'string', 'example' => 'csv', 'title' => ''],
+ 'ImportType' => ['description' => 'The import type.'."\n"
+ .' - FILE'."\n"
+ .' - RDS'."\n"
+ .' - ADB'."\n"
+ .' - PolarDB'."\n"
+ .' - Hologres'."\n"
+ .' - DMS', 'type' => 'string', 'example' => 'FILE', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.'."\n"
+ .'- When ImportType is FILE, this parameter indicates the file ID in the data center.', 'type' => 'string', 'example' => 'f-ean8u5881qk4*********xh5y', 'title' => ''],
+ 'DatabaseName' => ['description' => 'The database name.'."\n"
+ .'- When ImportType is FILE, this parameter indicates the file name.', 'type' => 'string', 'example' => 'diamonds.csv', 'title' => ''],
+ 'DatabaseDesc' => ['description' => 'The database description.', 'type' => 'string', 'example' => 'This is a sample database.', 'title' => ''],
+ 'DescUpdateTime' => ['description' => 'The time when the database description was last updated.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the file was created.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'Size' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '999', 'title' => ''],
+ 'IsInternal' => ['description' => 'Indicates whether the dataset is built-in. Valid values:'."\n"
+ .'- Y: The dataset is built-in.'."\n"
+ .'- N: The dataset is not built-in.', 'type' => 'string', 'example' => 'N', 'title' => ''],
+ 'DmsInstanceId' => ['description' => 'The ID of the Data Management instance that hosts the instance.'."\n"
+ .' - This parameter is not returned when ImportType is FILE.', 'type' => 'integer', 'format' => 'int64', 'example' => '2740966', 'title' => ''],
+ 'DmsDbId' => ['description' => 'The ID of the Data Management database that hosts the instance.'."\n"
+ .' - This parameter is not returned when ImportType is FILE.', 'type' => 'integer', 'format' => 'int64', 'example' => '73088962', 'title' => ''],
+ 'UseUserOssBucket' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'OssBucket' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DownloadLink' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'IntranetDownloadLink' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve the list of files uploaded by data center users',
+ 'summary' => 'Retrieves the list of files uploaded by users in the data center. Only file types are supported. Database types are not supported.',
+ '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 \\"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"}]',
- ],
- 'UpdateDataLakeFunction' => [
- 'summary' => '更新湖仓自定义函数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataCenterDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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\\": false,\\n \\"OssBucket\\": \\"\\",\\n \\"DownloadLink\\": \\"\\",\\n \\"IntranetDownloadLink\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListDataCenterTable' => [
+ 'summary' => 'Retrieves a list of user-uploaded tables from the data center, for file types only.',
+ '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' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
- 'name' => 'DbName',
+ 'name' => 'InstanceName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the instance.'."\n"
+ ."\n"
+ .'- If `ImportType` is `FILE`, this parameter represents the file ID of the data center.', 'type' => 'string', 'required' => false, 'example' => 'f-ean8u5881qk4*********xh5y', 'title' => ''],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.'."\n"
+ ."\n"
+ .'- If `ImportType` is `FILE`, this parameter represents the file name.', 'type' => 'string', 'required' => false, 'example' => 'diamonds.csv', 'title' => ''],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'diamonds', 'title' => ''],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword for a fuzzy search of database tables.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
+ ],
+ [
+ 'name' => 'ImportType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The import type.'."\n"
+ ."\n"
+ .'- FILE', 'type' => 'string', 'required' => false, 'example' => 'FILE', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of records to return per page. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'CallFrom',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For frontend use only.', 'type' => 'string', 'required' => false, 'example' => '仅前端使用', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The code that indicates the result of the request. If the request fails, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableId' => ['description' => 'The ID of the data table.', 'type' => 'string', 'example' => 'xa8wib4ga3a2*********fjbx', 'title' => ''],
+ 'ImportType' => ['description' => 'The import type. Valid value:'."\n"
+ ."\n"
+ .'- **FILE**: The data is imported from a file.', 'type' => 'string', 'example' => 'FILE', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.'."\n"
+ ."\n"
+ .'- If `ImportType` is `FILE`, this parameter returns the file ID.', 'type' => 'string', 'example' => 'f-ean8u5881qk4*********xh5y', 'title' => ''],
+ 'DatabaseName' => ['description' => 'The database name.'."\n"
+ ."\n"
+ .'- If `ImportType` is `FILE`, this parameter returns the file name.', 'type' => 'string', 'example' => 'diamonds.csv', 'title' => ''],
+ 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'diamonds'."\n", 'title' => ''],
+ 'TableDesc' => ['description' => 'The description of the data table.', 'type' => 'string', 'example' => '这是一份钻石数据。', 'title' => ''],
+ 'DescUpdateTime' => ['description' => 'The time when the data table description was last updated.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the data table was created.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'DmsInstanceId' => ['description' => 'The ID of the DMS instance that hosts the database.'."\n"
+ ."\n"
+ .'- This parameter is not returned if `ImportType` is `FILE`.', 'type' => 'integer', 'format' => 'int64', 'example' => '2310246', 'title' => ''],
+ 'DmsDbId' => ['description' => 'The ID of the DMS database.'."\n"
+ ."\n"
+ .'- This parameter is not returned if `ImportType` is `FILE`.', 'type' => 'integer', 'format' => 'int64', 'example' => '69950353', 'title' => ''],
+ ],
+ 'description' => 'The details of a data table.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of the data tables.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalElements' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ ],
+ 'description' => 'The data returned in the response.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataCenterTable',
+ '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' => 'All Resource', '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' => 'Retrieves a list of data lake catalogs.',
+ '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The keyword used to search for data catalog names.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The tenant ID. Call the GetUserActiveTenant or ListUserTenants operation to get the value of this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'FunctionName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my_funciton',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C1D39814-9808-47F8-AFE0-AF167239****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Function' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLFunction',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233****'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- ******false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '400'],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'CataLogList' => [
+ 'description' => 'A list of data catalogs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A data catalog.', '$ref' => '#/components/schemas/DLCatalog', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeCatalog',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'DeleteDataLakeFunction' => [
- 'summary' => '删除湖仓自定义函数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeCatalog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListDataLakeDatabase' => [
+ 'summary' => 'Retrieves a list of databases in a data lake.',
+ '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',
],
@@ -6726,102 +8273,94 @@
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the catalog. To find the catelog name, go to the [Data Lake console](https://dlf.console.aliyun.com/cn-hangzhou/metadata/catalog?spm=a2c4g.11186623.0.0.5a225658pT4Dkr).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'DbName',
+ 'name' => 'SearchKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'A keyword to search for database names.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'FunctionName',
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my_funciton',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'Tid',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. Valid values:'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no more results are available.'."\n"
+ ."\n"
+ .'- If **NextToken** has a value, it is the token for the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C****',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '400'],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'DatabaseList' => [
+ 'description' => 'The list of databases.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The details of the database.', '$ref' => '#/components/schemas/DLDatabase', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, no more results are available.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2g****'],
+ 'MaxResults' => ['description' => 'The maximum number of entries returned per page. This parameter is used with \\`NextToken\\` for paging.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeDatabase',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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\\": \\"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' => '获取数据湖函数列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6834,10 +8373,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '249778',
- 'abilityTreeNodes' => [
- 'FEATUREdms90TD19',
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -6845,145 +8381,100 @@
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default'],
],
[
'name' => 'FunctionNamePattern',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.*',
- ],
+ 'schema' => ['description' => 'A regular expression used to filter the returned function names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '.*'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
- ],
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, there is no subsequent query.'."\n"
+ ."\n"
+ .'- If **NextToken** has a value, it is the token for the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
'FunctionList' => [
- 'description' => '',
+ 'description' => 'A list of functions.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/DLFunction',
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f056501ada12****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
+ 'items' => ['description' => 'The function details.', '$ref' => '#/components/schemas/DLFunction', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. If this parameter is not returned, it indicates that all results have been returned.', 'type' => 'string', 'title' => '', 'example' => 'f056501ada12****'],
+ 'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeFunction',
+ 'summary' => 'Retrieves a list of data lake functions.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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\\": \\"\\",\\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"}]',
+ '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' => '获取数据湖函数名列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6996,10 +8487,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '249778',
- 'abilityTreeNodes' => [
- 'FEATUREdms90TD19',
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdms90TD19', 'FEATUREdmsKIHNZQ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -7007,278 +8495,228 @@
[
'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '3****',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hive',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
'name' => 'FunctionNamePattern',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.*',
- ],
+ 'schema' => ['description' => 'A regular expression used to filter function names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '.*'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f056501ada12****',
- ],
+ 'schema' => ['description' => 'The token that is used to page through results. Set this parameter to the \\`NextToken\\` value that is returned in the last response to retrieve the next page of results. You do not need to specify this parameter for the first request.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, there is no subsequent query.'."\n"
+ ."\n"
+ .'- If **NextToken** returns a value, it is the token for the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The page size. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F1C78D32-1AFD-58AD-9DD2-C8A08969****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F1C78D32-1AFD-58AD-9DD2-C8A08969****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
'FunctionNameList' => [
- 'description' => '',
+ 'description' => 'The list of function names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my_funciton',
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f056501ada12****',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
+ 'items' => ['description' => 'The function name.', 'type' => 'string', 'title' => '', 'example' => 'my_funciton'],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'f056501ada12****'],
+ 'MaxResults' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeFunctionName',
+ 'summary' => 'Retrieves a list of data lake function names.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeFunctionName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
],
- '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/Workspace/code/default/test.ipynb',
- ],
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'Params',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{\'dt\': \'2022-10-14\'}',
- ],
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'SessionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8vkixxxxx***',
- ],
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'Retry',
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
+ ],
+ [
+ 'name' => 'PartNames',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The list of partition names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The partition name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'part_1'],
'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
[
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set this parameter to the value of NextToken that is returned in the last response.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no subsequent query is needed.'."\n"
+ ."\n"
+ .'- If **NextToken** has a value, that value is the token to start the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
+ ],
+ [
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8630242382****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrMsg' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Request Invalid',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'IcICC2nbMpYp9KygS43n010100',
- ],
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5zrs5szpiezlb9m3qxi6zp32h',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'PartitionList' => [
+ 'description' => 'The list of partitions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the data lake table partition.', '$ref' => '#/components/schemas/DLPartition', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'],
+ 'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakePartition',
+ 'summary' => 'Retrieves the list of partitions of a data lake table.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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' => [
- 'summary' => '查看Notebook任务运行结果',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListDataLakePartitionByFilter' => [
+ 'summary' => 'Retrieves a list of partitions for a data lake table based on filter conditions.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7290,375 +8728,352 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c2b4cb5a-7420-49a8-aa7c-528becd6e1bf',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8630242382****',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8141456676986429894916354',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_table'],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Query conditional expression. Supported operators:'."\n"
+ ."\n"
+ .'- Comparison operators: =, <>, !=, <, <=, >, and >=. For example: \\`ds>20240101\\`.'."\n"
+ ."\n"
+ .'- Logical operators: AND, OR, and NOT. For example: \\`ds LIKE \'20240%\'\\`.'."\n"
+ ."\n"
+ .'- The BETWEEN operator, which specifies a range. For example: \\`ds BETWEEN 20240101 AND 20241201\\`.'."\n"
+ ."\n"
+ .'- The IN operator, which specifies a set of values. For example: \\`ds IN (20240101, 20240102)\\`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ds>20241201'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. Valid values:'."\n"
+ ."\n"
+ .'- If this parameter is left empty, no more results are returned.'."\n"
+ ."\n"
+ .'- If a value is returned, the value is the token for the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Instance not found.',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'NotebookSchedulePreviewUrl' => [
- 'type' => 'string',
- ],
- 'Status' => [
- 'type' => 'string',
- ],
- 'Progress' => [
- 'type' => 'string',
- ],
- 'Result' => [
- 'type' => 'string',
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'PartitionList' => [
+ 'description' => 'The list of partitions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the data lake table partitions.', '$ref' => '#/components/schemas/DLPartition', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'],
+ 'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakePartitionByFilter',
+ '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"}]',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou'."\n",
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'CallFrom',
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'table_name'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first call.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no subsequent query is needed.'."\n"
+ ."\n"
+ .'- If **NextToken** has a return value, it is the token to start the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0FEE5834-C55A-5995-A6A3-B443304965BD',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OssCredential' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request',
- ],
- 'OssDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20260101T135341Z',
- ],
- 'OssSignatureVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSS4-HMAC-SHA256',
- ],
- 'OssSignature' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********',
- ],
- 'OssSecurityToken' => [
- 'description' => '',
- '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
+ 'RequestId' => ['title' => '', 'description' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'PartitionNameList' => [
+ 'description' => 'A list of partition names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The partition name.', 'type' => 'string', 'title' => '', 'example' => 'part_1'],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'],
+ 'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FEE5834-C55A-5995-A6A3-B443304965BD\\",\\n \\"Data\\": {\\n \\"OssCredential\\": \\"STS.NXzWrLJ6fp**********/20260101/cn-hangzhou/oss/aliyun_v4_request\\",\\n \\"OssDate\\": \\"20260101T135341Z\\",\\n \\"OssSignatureVersion\\": \\"OSS4-HMAC-SHA256\\",\\n \\"OssSignature\\": \\"9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********\\",\\n \\"OssSecurityToken\\": \\"CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********\\",\\n \\"Policy\\": \\"eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********\\\\n\\",\\n \\"UploadHost\\": \\"https://**********.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"UploadDir\\": \\"data_agent/file_upload/16738266********/20260101T135341Z/eurzkytli9ksnur**********\\"\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\"\\n}","type":"json"}]',
- ],
- 'FileUploadCallback' => [
- 'summary' => 'FileUploadCallback',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakePartitionName',
+ 'summary' => 'Retrieves a list of partition names for a data lake table.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakePartitionName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou'."\n",
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'Filename',
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'conversion_metrics.csv',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'UploadLocation',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'data_agent/file_upload/174483******/20251219T******Z/n87bgtx6dk******/conversion_metrics.csv',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'FileSize',
+ 'name' => 'TableNamePattern',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '8110',
- ],
+ 'schema' => ['description' => 'The name of the metadata table. This parameter supports regular expressions.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '.*'],
],
[
- 'name' => 'CallFrom',
+ 'name' => 'TableType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TrailCenter',
- ],
+ 'schema' => ['description' => 'The type of the table. Valid values:'."\n"
+ ."\n"
+ .'- MANAGED\\_TABLE: Internal table.'."\n"
+ ."\n"
+ .'- EXTERNAL\\_TABLE: External table.'."\n"
+ ."\n"
+ .'- VIRTUAL\\_VIEW: Virtual view.'."\n"
+ ."\n"
+ .'- INDEX\\_TABLE: Index table.'."\n"
+ ."\n"
+ .'- MATERIALIZED\\_VIEW: Materialized view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MANAGED_TABLE'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token used to retrieve the next page of results. To retrieve the next page, set this parameter to the \\`NextToken\\` value from the previous response. If you do not specify this parameter, the first page is returned.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, there are no more queries.'."\n"
+ ."\n"
+ .'- If **NextToken** has a value, the value is the token to start the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '841BC14F-8E21-56B0-A7D6-593C5841AC84',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FileId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f-8*******01m'."\n",
- ],
- ],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '3D3FB827-E667-50DB-AD59-C83F8237****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'TableList' => [
+ 'description' => 'The list of table details.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of tables.', '$ref' => '#/components/schemas/DLTable', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'],
+ 'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeTable',
+ 'summary' => 'Retrieves a list of data lake tables.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', '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"}]',
- ],
- 'GetChatContent' => [
- 'summary' => 'GetChatContent',
- 'path' => '/api/v1/chat/stream',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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\\": \\"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"}]',
+ ],
+ 'ListDataLakeTableName' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7670,214 +9085,454 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sess_12345',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'AgentId',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx-xxxx-xxxx',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'Checkpoint',
+ 'name' => 'TableNamePattern',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- 'default' => '0',
- ],
+ 'schema' => ['description' => 'The regular expression used to match table names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '.*'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set this parameter to the value of NextToken that is returned from the last call. You do not need to specify this parameter for the first call.'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no subsequent query is required.'."\n"
+ ."\n"
+ .'- If **NextToken** has a return value, the value is the token for the next query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f056501ada12****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'title' => '', 'example' => '20'],
+ ],
+ [
+ 'name' => 'TableType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the table. Valid values:'."\n"
+ ."\n"
+ .'- MANAGED\\_TABLE: Internal table.'."\n"
+ ."\n"
+ .'- EXTERNAL\\_TABLE: Foreign table.'."\n"
+ ."\n"
+ .'- VIRTUAL\\_VIEW: Virtual view.'."\n"
+ ."\n"
+ .'- INDEX\\_TABLE: Index table.'."\n"
+ ."\n"
+ .'- MATERIALIZED\\_VIEW: Materialized view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MANAGED_TABLE'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Data understanding completed.',
- ],
- 'event_type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DATA',
- ],
- 'content_type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'str',
- ],
- 'checkpoint' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'level' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'category' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PLAN',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'TableNameList' => [
+ 'description' => 'A list of table names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'test_name'],
+ 'title' => '',
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NesLoKLEdIZrKhDT7I2gS****'],
+ 'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeTableName',
+ 'summary' => 'Retrieves a list of data lake table names.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
- ],
- 'DeleteFileUpload' => [
- 'summary' => 'DeleteFileUpload',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTableName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'ListDataLakeTablebaseInfo' => [
+ 'summary' => 'Retrieves the basic information about tables in a data lake.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou'."\n",
- ],
+ 'schema' => ['description' => 'The number of rows on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'title' => '', 'example' => '10'],
],
[
- 'name' => 'FileId',
+ 'name' => 'Page',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'f-8*******01m'."\n",
- ],
+ 'schema' => ['description' => 'The page number of the list for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'title' => '', 'example' => '1'],
],
[
- 'name' => 'CallFrom',
+ 'name' => 'SearchKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TrailCenter',
- ],
+ 'schema' => ['description' => 'The keyword used to search for table names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database where the table is located.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID. Call the GetUserActiveTenant operation to get the value of this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'title' => '', 'example' => '3****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The return values are:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '400'],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Specified parameter Rows is not valid.'],
+ 'TablebaseInfoList' => [
+ 'description' => 'The list of data lake tables.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The basic information of a table.', '$ref' => '#/components/schemas/DLTablebaseInfo', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The number of tables that meet the conditions.', 'type' => 'string', 'title' => '', 'example' => '100'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDataLakeTablebaseInfo',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTablebaseInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document.', 'type' => 'string', 'required' => false, 'example' => 'test.md', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The token used to retrieve the next page of results. Omit this parameter to get the first page. If the response returns a `NextToken`, it indicates that more results are available. To get the next page, pass this `NextToken` value in the `NextToken` parameter of your next request. A null value for NextToken indicates that all results have been retrieved.', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The maximum number of entries to return on each page.'."\n"
+ ."\n"
+ .'Valid values: 1 to 100.'."\n"
+ ."\n"
+ .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChunkTitlePattern',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A filter pattern. The operation returns only the chunks whose titles contain this pattern.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortFieldName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The sort field. Valid values:'."\n"
+ ."\n"
+ .'- **id** (default): The chunk ID.'."\n"
+ ."\n"
+ .'- **hits**: The number of hits.'."\n"
+ ."\n"
+ .'- **modifyTime**: The modification time.', 'type' => 'string', 'required' => false, 'example' => 'hits', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortOrder',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The sort order. Valid values:'."\n"
+ ."\n"
+ .'- **ASC** (default): ascending order.'."\n"
+ ."\n"
+ .'- **DESC**: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique request ID. If you encounter an error, provide this ID for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FileId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f-8*******01m'."\n",
- ],
- ],
- ],
+ 'type' => 'array',
+ 'items' => ['description' => 'The data structure for a single chunk.', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseChunk', 'title' => '', 'example' => ''],
+ 'description' => 'A list of chunks.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates if the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of chunks that meet the filter criteria. (This feature is not yet supported, and the value is always 0.)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries returned on this page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The pagination token for the next page of results.', 'type' => 'string', 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDocumentChunks',
+ 'summary' => 'Queries a list of chunks.',
+ '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"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"2e12aeb5-52cd-4834-bcd8-****\\",\\n \\"DocName\\": \\"test.md\\",\\n \\"Content\\": \\"abc\\",\\n \\"ChunkTitle\\": \\"titile1\\",\\n \\"ChunkMtime\\": \\"2026-04-20 15:51:27\\"\\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' => 'SendChatMessage',
- 'methods' => [
- 'post',
+ 'ListDocuments' => [
+ 'summary' => 'Lists the documents in a knowledge base.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
],
+ 'parameters' => [
+ [
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The pagination token to retrieve the next page of results. Omit this parameter to retrieve the first page. A `NextToken` value in the response indicates that more results are available. To fetch the next page, pass this value in a subsequent request. A `null` value indicates that all results have been retrieved.', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The maximum number of documents to return per page.'."\n"
+ ."\n"
+ .'Valid values: 1 to 100.'."\n"
+ ."\n"
+ .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'NamePattern',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The document name filter. Returns only documents whose names contain this value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortFieldName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The sort field. Valid values:'."\n"
+ ."\n"
+ .'- `id` (default): The document ID.'."\n"
+ ."\n"
+ .'- `hits`: The number of hits.'."\n"
+ ."\n"
+ .'- `modifyTime`: The modification time.', 'type' => 'string', 'required' => false, 'example' => 'hits', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortOrder',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The sort order. Valid values:'."\n"
+ ."\n"
+ .'- **ASC** (default): Sorts in ascending order.'."\n"
+ ."\n"
+ .'- **DESC**: Sorts in descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
+ ],
+ [
+ 'name' => 'Filters',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The document property filter. The following properties are supported:'."\n"
+ ."\n"
+ .'- `fileExt`: The document extension.'."\n"
+ ."\n"
+ .'- `state`: The document status.', 'type' => 'string', 'required' => false, 'example' => '{"fileExt":"pdf","state":0}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'TotalCount' => ['description' => 'The total number of documents that meet the specified criteria. This parameter is not currently supported and always returns 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The response structure.', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument', 'title' => '', 'example' => ''],
+ 'description' => 'A list of documents.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****', 'title' => ''],
+ 'MaxResults' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code, returned only when the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message, returned only when the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response structure.',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListDocuments',
+ '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\\": \\"kb-***\\",\\n \\"Name\\": \\"test.md\\",\\n \\"Description\\": \\"abc\\",\\n \\"FileExt\\": \\"md\\",\\n \\"DocumentLoaderName\\": \\"ADBPGLoader\\",\\n \\"TextSplitterName\\": \\"ChineseRecursiveTextSplitter\\",\\n \\"GmtCreate\\": \\"2026-04-22 22:59:35\\",\\n \\"GmtModified\\": \\"2026-04-24 21:22:53\\",\\n \\"FileSize\\": 20307,\\n \\"DocsCount\\": 123,\\n \\"State\\": 0,\\n \\"Summary\\": \\"This is a test document.\\",\\n \\"Keywords\\": \\"[\\\\\\"test\\\\\\",\\\\\\"abc\\\\\\"]\\"\\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' => [],
@@ -7886,517 +9541,381 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sess_12345',
- ],
+ 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'h8r********4fch', 'title' => ''],
],
[
- 'name' => 'AgentId',
+ 'name' => 'FileId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_12345',
- ],
+ 'schema' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => 'f-8*******01m'."\n", 'title' => ''],
],
[
- 'name' => 'Message',
+ 'name' => 'CallFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'what can you do?',
- ],
+ 'schema' => ['description' => 'For front-end use only.', 'type' => 'string', 'required' => false, 'example' => '仅前端使用', 'title' => ''],
],
[
- 'name' => 'MessageType',
+ 'name' => 'FileFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'primary',
- 'default' => 'primary',
- 'enum' => [
- 'primary',
- 'additional',
- 'cancel',
- 'operate',
- ],
- ],
+ 'schema' => ['description' => 'The file source.', 'type' => 'string', 'required' => false, 'example' => 'Agent', 'title' => ''],
],
[
- 'name' => 'ReplyTo',
+ 'name' => 'FileCategory',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The file category.',
+ 'enumValueTitles' => ['WebReport' => 'Web report', 'TextReport' => 'Text report', 'DefaultArtifact' => 'Default artifact'],
'type' => 'string',
'required' => false,
- 'example' => '0',
- 'default' => '0',
+ 'example' => 'TextReport',
+ 'title' => '',
],
],
[
- 'name' => 'QuotedMessage',
+ 'name' => 'SortColumn',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The sort column.',
+ 'enumValueTitles' => ['gmtCreated' => 'Creation time'],
'type' => 'string',
'required' => false,
- 'example' => '{"version":"v0"}',
+ 'example' => 'gmtCreated',
+ 'title' => '',
],
],
[
- 'name' => 'Question',
+ 'name' => 'SortDirection',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The sort direction.',
+ 'enumValueTitles' => ['asc' => 'Ascending order', 'desc' => 'Descending order'],
'type' => 'string',
'required' => false,
- 'example' => '',
+ 'example' => 'asc',
+ 'title' => '',
],
],
[
- 'name' => 'DataSource',
+ 'name' => 'DownloadLinkExpire',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The validity period of the download link, in seconds. This parameter applies only to files in user-owned Object Storage Service (OSS) buckets. The default is 3600.'."\n"
+ ."\n"
+ .'- Minimum value: 3600 (1 hour)'."\n"
+ ."\n"
+ .'- Maximum value: 129600 (36 hours)'."\n"
+ ."\n"
+ .'Notes:'."\n"
+ ."\n"
+ .'- Download links for files in the built-in OSS are valid for 1 hour.'."\n"
+ ."\n"
+ .'-', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'DataSourceType' => [
- 'description' => '',
- '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' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my_table',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'f-8*******01m'."\n", 'title' => ''],
+ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'samele_report.md', 'title' => ''],
+ 'FileType' => ['description' => 'The file extension.', 'type' => 'string', 'example' => 'md'."\n", 'title' => ''],
+ 'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '7453', 'title' => ''],
+ 'UploadLocation' => ['description' => 'The upload path.', 'type' => 'string', 'example' => 'data_agent/agent_file_upload/16738266********/4mynz********/samele_report.md', 'title' => ''],
+ 'DownloadLink' => ['description' => 'The public download link.', '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', 'title' => ''],
+ 'IntranetDownloadLink' => ['description' => 'The internal download link.', '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', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '20372822********'."\n", 'title' => ''],
+ 'AliyunParentUid' => ['description' => 'The ID of the Alibaba Cloud master account.', 'type' => 'string', 'example' => '16738266********', 'title' => ''],
+ 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'h8r********4fch', 'title' => ''],
+ 'FileFrom' => ['description' => 'The file source.', 'type' => 'string', 'example' => 'Agent', 'title' => ''],
+ 'FileCategory' => [
+ 'description' => 'The file category.',
+ 'enumValueTitles' => ['WebReport' => 'web report', 'TextReport' => 'text report', 'DefaultArtifact' => 'default artifact'],
+ 'type' => 'string',
+ 'example' => 'TextReport',
+ 'title' => '',
+ ],
+ 'GmtCreated' => ['description' => 'The time when the file was created.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ ],
+ 'description' => 'The file object.',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- ],
- 'FileId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '353676',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- 'DbName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fsy_trial',
- ],
- 'DmsInstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2310246',
- ],
- 'DmsDatabaseId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '11231',
+ 'description' => 'The list of file objects.',
+ 'title' => '',
+ 'example' => '',
],
],
- 'required' => false,
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListFileUpload',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SessionConfig',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Language' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENGLISH',
- ],
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'CustomAgentStage' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'ReportWaterMark' => [
- 'type' => 'string',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListFileUpload',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tag',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The tag of the knowledge base. In DataAgent, this is the space ID.', 'type' => 'string', 'required' => true, 'example' => '1dq7qod8hxtt1***', 'title' => ''],
+ ],
+ [
+ 'name' => 'NamePattern',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A keyword to search for in the names of knowledge bases.', 'type' => 'string', 'required' => false, 'example' => 'order', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The token used to retrieve the next page of results. Valid values:'."\n"
+ ."\n"
+ .'- Omit this parameter for the first request.'."\n"
+ ."\n"
+ .'- If the previous response returned a **NextToken** value, use it to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'zCXSmY0CJbybp6FZV7vo0Wjw64X-*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The maximum number of entries to return on each page. Use this parameter with the `NextToken` parameter to implement pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'Filters',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The filter conditions for the knowledge bases, specified as a JSON string. The only supported key is `state`. Valid values are `0` and `1`.', 'type' => 'string', 'required' => false, 'example' => '{"state":1}', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortFieldName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sort field. Valid values:'."\n"
+ ."\n"
+ .'- `id`: Sorts by knowledge base ID. This is the default.'."\n"
+ ."\n"
+ .'- `name`: Sorts by knowledge base name.',
+ 'enumValueTitles' => ['name' => 'name', 'id' => 'id'],
+ 'type' => 'string',
'required' => false,
+ 'example' => 'name',
+ 'title' => '',
],
],
[
- 'name' => 'ParentSessionId',
- 'in' => 'query',
+ 'name' => 'SortOrder',
+ 'in' => 'formData',
'schema' => [
+ 'description' => 'The sort order. Valid values:'."\n"
+ ."\n"
+ .'- **ASC**: Ascending order. This is the default.'."\n"
+ ."\n"
+ .'- **DESC**: Descending order.',
+ 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
'type' => 'string',
+ 'required' => false,
+ 'example' => 'Desc',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FE65CE1F-155B-1A38-9A3A-0208982C773B',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '""',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'],
'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => 'Message'."\n",
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'SessionId' => [
- 'description' => 'SessionId'."\n",
- 'type' => 'string',
- 'example' => '6zbqbhoamv7gk20p8pgygt4hh',
- ],
- 'AgentId' => [
- 'description' => 'AgentId'."\n",
- 'type' => 'string',
- 'example' => '3jqqdiuxunfe2f7feren21eeq',
- ],
- ],
- ],
- 'Success' => [
- 'description' => 'Success'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'type' => 'array',
+ 'items' => ['description' => 'The details of a knowledge base.', '$ref' => '#/components/schemas/OneMetaKnowledgeBase', 'title' => '', 'example' => ''],
+ 'description' => 'A list of knowledge base objects.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Success' => ['description' => 'Indicates whether the request was successful. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter Tag is not valid.', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of knowledge bases matching the query. This feature is not currently supported and the returned value is always `0`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'default' => '20', 'example' => '20', 'title' => ''],
+ 'NextToken' => ['description' => 'The token used to retrieve the next page of results.'."\n"
+ ."\n"
+ .'- If this parameter is empty, all results have been returned.'."\n"
+ ."\n"
+ .'- If a value is returned, use it in the next request to retrieve the next page of results.', 'type' => 'string', 'example' => 'NesLoKLEdIZrKhDT7I2gS****', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListKnowledgeBases',
+ 'summary' => 'Returns a paginated list of knowledge bases.',
+ '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"}]',
+ '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' => 'DescribeDataAgentSession',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListWorkspaceCode' => [
+ 'summary' => 'Lists code files and directories at a specified path in a workspace.',
+ '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',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'SessionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c61n7gmopfvuascr70xmavzrj',
- ],
- ],
- [
- 'name' => 'WorkspaceId',
+ 'name' => 'Path',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The path of the file or directory.', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/default/test.ipynb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '18****-*****-*******7A3122F',
- ],
'Data' => [
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '976*********p',
- ],
- 'SessionStatus' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'AgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cu0cs*******mf',
- ],
- 'AgentStatus' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Title' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ChatHistoryLocations' => [
- 'description' => '',
+ 'List' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Url' => [
- 'description' => '',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'File' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f-8*******01m',
- ],
- 'SessionConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'Language' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHINESE',
- ],
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ca-e*******ckd',
- ],
- 'CustomAgentStage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'debug',
- ],
- 'Mode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ANALYSIS',
- ],
- 'EnableSearch' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'McpServerIds' => [
- 'title' => '会话配置中的MCP服务器ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '会话配置中的MCP服务器ID',
- 'type' => 'string',
- 'example' => '2q1tu90**********6uttu2nw',
- ],
- ],
- 'UserOssBucket' => [
- 'type' => 'string',
- ],
- 'EncryptType' => [
- 'title' => '加密类型',
- 'type' => 'string',
- ],
- 'EncryptKey' => [
- 'title' => '加密秘钥',
- 'type' => 'string',
- ],
- 'ReportWaterMark' => [
- 'title' => '报告水印',
- 'type' => 'string',
- ],
- 'ReportPageWidth' => [
- 'title' => '报告页面宽度',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'Name' => ['description' => 'The name of the file or directory.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'Symlink' => ['description' => 'The target of the symlink.', 'type' => 'string', 'example' => '../abc.py', 'title' => ''],
+ 'IsDir' => ['description' => 'Indicates whether the object is a directory.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Size' => ['description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''],
+ 'Mtime' => ['description' => 'The modification time of the file.'."\n"
+ ."\n"
+ .'The time is in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.'."\n"
+ ."\n"
+ .'This parameter is returned only for files.', 'type' => 'string', 'example' => '2026-01-01T10:11:12Z', 'title' => ''],
],
+ 'description' => 'An object that represents a file or directory.',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1731645908000',
- ],
- 'Saved' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FavoriteInWorkspace' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'An array of objects representing the files and directories.',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
- ],
+ 'title' => '',
+ 'description' => 'The data returned in the response.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListWorkspaceCode',
+ 'description' => 'This operation lists the code files and directories at a specified path in a workspace.',
+ '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"}]',
+ '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' => 'CreateDataAgentSession',
+ 'ModifyCustomAgent' => [
+ 'summary' => 'Modify a custom agent in a personal space or workspace',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8405,277 +9924,427 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'Title',
+ 'name' => 'CustomAgentId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the custom agent.', 'type' => 'string', 'required' => true, 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'Agent测试名称', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the custom agent.', 'type' => 'string', 'required' => false, 'example' => 'Agent测试描述', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataJson',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data scope for the agent, specified in a **JSON-formatted string**.'."\n"
+ ."\n"
+ .'- General parameters:'."\n"
+ ."\n"
+ .' - `tableFlag`: Set this to `true` to specify the data scope.'."\n"
+ ."\n"
+ .' - `scope`: The value must be `personal`.'."\n"
+ ."\n"
+ .' - `personal`: The parameters for files or databases.'."\n"
+ ."\n"
+ .'**For files**, use the following parameters:'."\n"
+ ."\n"
+ .'- `DataSourceType`: The value must be `remote_data_center`.'."\n"
+ ."\n"
+ .'- `FileId`: The file ID.'."\n"
+ ."\n"
+ .'- `Database`: The database name returned by the `ListDataCenterTable` operation. This is typically the file name.'."\n"
+ ."\n"
+ .'- `Tables`: The table names returned by the `ListDataCenterTable` operation.'."\n"
+ ."\n"
+ .'- `TableIds`: The table IDs returned by the `ListDataCenterTable` operation.'."\n"
+ ."\n"
+ .'- `RegionId`: The current region.'."\n"
+ ."\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"
+ .'**For databases**, use the following parameters:'."\n"
+ ."\n"
+ .'- `DataSourceType`: The value must be `database`.'."\n"
+ ."\n"
+ .'- `DmsInstanceId`: The ID of the DMS instance, which is returned by the data center API.'."\n"
+ ."\n"
+ .'- `DmsDatabaseId`: The ID of the DMS database, which is returned by the data center API.'."\n"
+ ."\n"
+ .'- `FileId`: The instance name. This parameter is deprecated.'."\n"
+ ."\n"
+ .'- `DbName`: The database name returned by the data center API.'."\n"
+ ."\n"
+ .'- `Database`: The database name returned by the data center API.'."\n"
+ ."\n"
+ .'- `Tables`: The table names returned by the data center API.'."\n"
+ ."\n"
+ .'- `TableIds`: The table IDs returned by the data center API.'."\n"
+ ."\n"
+ .'- `Engine`: The database engine type. Valid values: `mysql` and `postgresql`.'."\n"
+ ."\n"
+ .'- `RegionId`: The current region.'."\n"
+ ."\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", 'title' => ''],
+ ],
+ [
+ 'name' => 'Instruction',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The system instruction for the custom agent.'."\n"
+ ."\n"
+ .'- The maximum length is 10,000 characters.', 'type' => 'string', 'required' => false, 'example' => '分析框架：'."\n"
+ .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n"
+ .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n"
+ .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', 'title' => ''],
+ ],
+ [
+ 'name' => 'Knowledge',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A text-based knowledge base for the custom agent.'."\n"
+ ."\n"
+ .'- The maximum length is 10,000 characters.', 'type' => 'string', 'required' => false, 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ ],
+ [
+ 'name' => 'KnowledgeConfigList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessType' => [
+ 'description' => 'The access type.'."\n"
+ ."\n"
+ .'- `mcp`: Connects via the MCP service.',
+ 'enumValueTitles' => ['mcp' => 'Connects via the MCP service.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mcp',
+ 'title' => '',
+ ],
+ 'McpServerId' => ['description' => 'The ID of the MCP server.', 'type' => 'string', 'required' => false, 'example' => 'nhdpt9adf6ac**********ca', 'title' => ''],
+ 'KbUuid' => ['description' => 'The UUID of the knowledge base.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The configuration for the external knowledge base.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The configurations for the external knowledge base.',
'required' => false,
+ 'title' => '',
'example' => '',
],
],
[
- 'name' => 'File',
+ 'name' => 'ExecutionConfig',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'SkipPlan' => ['description' => 'Specifies whether to skip the plan confirmation step.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Specifies whether to skip all SQL confirmation steps.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Specifies whether to skip the confirmation for web report generation.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Specifies whether to prevent the agent from asking for user input during execution.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => 'The execution configuration.',
'required' => false,
- 'example' => 'f-8*******01m',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'SessionConfig',
+ 'name' => 'ScheduleTaskConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
- 'Language' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CHINESE',
- ],
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-e*******ckd',
- ],
- 'CustomAgentStage' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'debug',
- ],
- 'Mode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ANALYSIS',
- ],
- 'EnableSearch' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'McpServerIds' => [
- 'title' => '会话配置中的MCP服务器ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '会话配置中MCP服务器ID',
- 'type' => 'string',
- 'example' => '2q1tu9**********66uttu2nw',
- ],
- ],
- 'UserOssBucket' => [
- 'type' => 'string',
- ],
- 'EncryptType' => [
- 'title' => '加密方式',
- 'type' => 'string',
- ],
- 'EncryptKey' => [
- 'title' => '加密秘钥',
- 'type' => 'string',
- ],
- 'ReportWaterMark' => [
- 'title' => '报告水印',
- 'type' => 'string',
- ],
- 'ReportPageWidth' => [
- 'title' => '报告页面宽度',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'RelatedSessionId' => ['description' => 'The ID of a previous session to use as a reference.', 'type' => 'string', 'required' => false, 'example' => '4m24*****mg7j2v', 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'required' => false, 'example' => '0 0 0,1 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The query for the scheduled task.', 'type' => 'string', 'required' => false, 'example' => '分析一下这份数据，给出简报', 'title' => ''],
],
+ 'description' => 'The configuration for the scheduled task.',
'required' => false,
- 'title' => '会话配置',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'TextReportConfig',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The formatting instructions for the text report.'."\n"
+ ."\n"
+ .'- The maximum length is 10,000 characters.', 'type' => 'string', 'required' => false, 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ ],
+ [
+ 'name' => 'WebReportConfig',
'in' => 'query',
+ 'schema' => ['description' => 'The formatting instructions for the web report.'."\n"
+ ."\n"
+ .'- The maximum length is 50,000 characters.', 'type' => 'string', 'required' => false, 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ ],
+ [
+ 'name' => 'DMSUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'CallbackConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12****',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The callback type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ToolId' => ['description' => 'The ID of the tool to call.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['description' => 'The prompt to use for the callback.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['description' => 'The arguments for the callback.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['description' => 'The timestamp of the callback.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The callback configuration.',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'RelatedSessionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1CB***********3F1A',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
'Data' => [
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '976*********p',
- ],
- 'SessionStatus' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'AgentId' => [
- 'description' => 'Agent Id',
- 'type' => 'string',
- 'example' => 'cu0cs*******mf',
- ],
- 'AgentStatus' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Title' => [
- 'description' => '',
- 'type' => 'string',
+ 'CustomAgentId' => ['description' => 'The custom agent ID.', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Name' => ['description' => 'The custom agent name.', 'type' => 'string', 'example' => 'Agent测试名称', 'title' => ''],
+ 'Description' => ['description' => 'The custom agent description.', 'type' => 'string', 'example' => 'Agent测试描述', 'title' => ''],
+ 'DataJson' => ['description' => 'The data scope in JSON format.', '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"
+ .'}', 'title' => ''],
+ 'Instruction' => ['description' => 'The instruction for the agent.', 'type' => 'string', 'example' => '分析框架：'."\n"
+ .'1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；'."\n"
+ .'2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；'."\n"
+ .'3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；', 'title' => ''],
+ 'Knowledge' => ['description' => 'The text-based knowledge for the agent.', 'type' => 'string', 'example' => '核心指标定义：'."\n"
+ .'1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；'."\n"
+ .'2、订单量为每日有效下单笔数；'."\n"
+ .'3、UV（独立访客）指访问网站或APP的去重用户数；'."\n"
+ .'4、转化率=支付订单数 / UV，反映流量转化效率；', 'title' => ''],
+ 'Status' => ['description' => 'The agent status.', 'type' => 'string', 'example' => 'RELEASED', 'title' => ''],
+ 'ReleaseTime' => ['description' => 'The release time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'OfflineTime' => ['description' => 'The offline time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'Modifier' => ['description' => 'ID of the last modifier.', 'type' => 'string', 'example' => '20372822********', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
+ 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '20372822********'."\n", 'title' => ''],
+ 'AliyunParentUid' => ['description' => 'The main Alibaba Cloud account ID.', 'type' => 'string', 'example' => '16738266********', 'title' => ''],
+ 'DmsUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2025-12-11T14:04:32.000+00:00', 'title' => ''],
+ 'KnowledgeConfigList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessType' => [
+ 'description' => 'The access type.'."\n"
+ ."\n"
+ .'- mcp: Connects via MCP.',
+ 'enumValueTitles' => ['mcp' => 'Access using the MCP method'],
+ 'type' => 'string',
+ 'example' => 'mcp',
+ 'title' => '',
+ ],
+ 'McpServerId' => ['description' => 'The MCP server ID.', 'type' => 'string', 'example' => 'nhdpt9adf6ac**********ca', 'title' => ''],
+ 'KbUuid' => ['description' => 'The knowledge base UUID.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'Configuration of an external knowledge base.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'Configurations for external knowledge bases.',
+ 'title' => '',
'example' => '',
],
- 'File' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'f-8*******01m',
- ],
- 'SessionConfig' => [
+ 'ExecutionConfig' => [
'type' => 'object',
'properties' => [
- 'Language' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHINESE',
- ],
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ca-e*******ckd',
- ],
- 'CustomAgentStage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'debug',
- ],
- 'Mode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ANALYSIS',
- ],
- 'EnableSearch' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'McpServerIds' => [
- 'title' => '会话配置中的MCP服务器ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '会话配置中的MCP服务器ID',
- 'type' => 'string',
- 'example' => '2q1tu90**********6uttu2nw',
- ],
- ],
- 'UserOssBucket' => [
- 'type' => 'string',
- ],
- 'EncryptType' => [
- 'title' => '加密类型',
- 'type' => 'string',
- ],
- 'EncryptKey' => [
- 'title' => '加密密钥',
- 'type' => 'string',
- ],
- 'ReportWaterMark' => [
- 'title' => '报告水印',
- 'type' => 'string',
- ],
- 'ReportPageWidth' => [
- 'title' => '报告页面宽度',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'SkipPlan' => ['description' => 'Specifies whether to skip plan confirmation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Specifies whether to skip all SQL confirmations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Specifies whether to skip web report confirmation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Specifies whether to skip asking for human input during execution.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => 'The execution configuration.',
+ 'title' => '',
+ 'example' => '',
],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1765262307992',
+ 'TextReportConfig' => ['description' => 'Formatting requirements for the text report.', 'type' => 'string', 'example' => '文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'WebReportConfig' => ['description' => 'Formatting requirements for the web report.', 'type' => 'string', 'example' => '网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字', 'title' => ''],
+ 'CreatorUserName' => ['description' => 'Name of the user who created the agent.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'ModifierUserName' => ['description' => 'Name of the user who last modified the agent.', 'type' => 'string', 'example' => 'HaoY*****', 'title' => ''],
+ 'DMSUnit' => ['description' => 'The current DMS unit.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'IsScheduleTask' => ['description' => 'Indicates whether a scheduled task is configured.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'NextRuntime' => ['description' => 'The next runtime for the scheduled task.'."\n"
+ ."\n"
+ .'- This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767715200', 'title' => ''],
+ 'ScheduleTaskConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedSessionId' => ['description' => 'The ID of a reference session.', 'type' => 'string', 'example' => '4m24*****mg7j2v', 'title' => ''],
+ 'CronExpression' => ['description' => 'The cron expression for the task.', 'type' => 'string', 'example' => '0 0 0 ? * 1-7', 'title' => ''],
+ 'Query' => ['description' => 'The query for the task.', 'type' => 'string', 'example' => '分析一下这份数据，给出简报', 'title' => ''],
+ ],
+ 'description' => 'The scheduled task configuration.',
+ 'title' => '',
+ 'example' => '',
],
- 'Saved' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'CallbackConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The callback type.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ToolId' => ['description' => 'The ID of the tool to be called.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackPrompt' => ['description' => 'The callback prompt.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackArgs' => ['description' => 'The callback arguments.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'CallbackTime' => ['description' => 'The callback timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ ],
+ 'description' => 'The callback configuration.',
+ 'title' => '',
+ 'example' => '',
],
+ 'RelatedSessionId' => ['description' => 'The ID of a reference session.', 'type' => 'string', 'title' => '', 'example' => ''],
],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UnknownError',
+ 'description' => 'The response data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ModifyCustomAgent',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:ModifyCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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"}]',
+ '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' => 'Operate custom agents in personal spaces and workspaces.',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8684,857 +10353,1010 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou'."\n",
- ],
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => false, 'example' => '56kv1pvl9uvt9**********bb', 'title' => ''],
],
[
- 'name' => 'SessionId',
+ 'name' => 'CustomAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'h8r********4fch',
- ],
+ 'schema' => ['description' => 'Custom Agent ID', 'type' => 'string', 'required' => true, 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
],
[
- 'name' => 'FileId',
+ 'name' => 'OperateType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Operation type',
+ 'enumValueTitles' => ['SET_DEFAULT' => 'Set default agent', 'RELEASE' => 'Publish', 'CANCEL_DEFAULT' => 'Cancel default agent', 'OFFLINE' => 'Offline'],
'type' => 'string',
- 'required' => false,
- 'example' => 'f-8*******01m'."\n",
+ 'required' => true,
+ 'example' => 'RELEASE',
+ 'title' => '',
],
],
- [
- 'name' => 'CallFrom',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Is the request successful? Return values are as follows:'."\n"
+ ."\n"
+ .'- True: The request is successful.'."\n"
+ ."\n"
+ .'- False: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message returned when the call fails.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomAgentId' => ['description' => 'Custom Agent ID', 'type' => 'string', 'example' => 'ca-4y3ca4khkcu**********ysf', 'title' => ''],
+ 'Success' => ['description' => 'Is the operation successful?', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'Operation message', 'type' => 'string', 'example' => 'Custom agent successfully released', 'title' => ''],
+ ],
+ 'description' => 'Return struct',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'OperateCustomAgent',
+ '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' => 'All Resource', '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' => 'The unique ID of the Airflow instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'af-b3a7f110a6vmvn7****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the DMS workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'WebReport' => '',
- 'TextReport' => '',
- 'DefaultArtifact' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
+ 'Root' => ['description' => 'The redeployment result.', 'type' => 'boolean', 'title' => '', 'example' => '{\'Responses\': {\'responses\': [{\'Uuid\': \'af-63ly5o1yuf076ifrpbxpka396\', \'Success\': True}]}}'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'example' => 'TextReport',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'RedeployAirflow',
+ 'summary' => 'Redeploy an Airflow instance',
+ 'description' => 'Redeploys an Airflow instance.',
+ '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' => 'Removes a user from a workspace.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'SortColumn',
+ 'name' => 'DMSUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'MemberId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the member account to remove.', 'type' => 'string', 'required' => false, 'example' => '21482*****7584', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'gmtCreated' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D2-*****-A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
],
- 'example' => 'gmtCreated',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'RemoveUserToDataAgentWorkspace',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SortDirection',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'asc' => '',
- 'desc' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:RemoveUserToDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => 'asc',
],
],
],
+ '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' => 'Query a knowledge base',
+ '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' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The query text.', 'type' => 'string', 'required' => true, 'example' => 'What is GraphRAG?', 'title' => ''],
+ ],
+ [
+ 'name' => 'TopK',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of top-ranked results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A filter for the data, specified as a SQL `WHERE` clause.', 'type' => 'string', 'required' => false, 'example' => 'title = \'test\' AND name like \'test%\'', 'title' => ''],
+ ],
+ [
+ 'name' => 'Metrics',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The distance metric for retrieval. If unspecified, this defaults to the metric configured for the knowledge base. Only set this parameter if you have specific requirements.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- `l2`: Euclidean distance.'."\n"
+ ."\n"
+ .'- `ip`: Inner product.'."\n"
+ ."\n"
+ .'- `cosine`: Cosine similarity.', 'type' => 'string', 'required' => false, 'example' => 'cosine', 'title' => ''],
+ ],
+ [
+ 'name' => 'HybridSearch',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The hybrid search algorithm. If this parameter is not set, the system directly compares and ranks the scores from the dense vector and full-text searches.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- `RRF`: Reciprocal Rank Fusion. This method uses a parameter `k` to control the fusion effect. For more information, see the `HybridSearchArgs` configuration.'."\n"
+ ."\n"
+ .'- `Weight`: Weighted ranking. This method applies weights to the vector and full-text search scores before ranking. For more information, see the `HybridSearchArgs` configuration.'."\n"
+ ."\n"
+ .'- `Cascaded`: Performs a full-text search first, followed by a vector search on the results of the full-text search.', 'type' => 'string', 'required' => false, 'example' => 'RRF', 'title' => ''],
+ ],
+ [
+ 'name' => 'HybridSearchArgs',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Parameters for the specified `HybridSearch` algorithm. Both `RRF` and `Weight` are supported. You can use the `HybridPathsSetting` object to specify the retrieval paths: dense vector (`dense`), sparse vector (`sparse`), and full-text search (`fulltext`). If this object is not provided, the default retrieval paths are `dense` and `fulltext`.'."\n"
+ ."\n"
+ .'- `RRF`: Specifies the constant `k` in the scoring formula `1/(k+rank_i)`. The value of `k` must be an integer greater than 1. The format is as follows:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "HybridPathsSetting": {'."\n"
+ .' "paths": "dense,fulltext"'."\n"
+ .' },'."\n"
+ .' "RRF": {'."\n"
+ .' "k": 60'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'- `Weight`:'."\n"
+ ."\n"
+ .' - Two-path recall (do not specify `HybridPathsSetting`; specify only `alpha`):'."\n"
+ ."\n"
+ .' - The score is calculated using the formula: `alpha * dense_score + (1-alpha) * fulltext_score`. The `alpha` parameter balances the scores from the dense vector and full-text searches. Its value must be in the range \\[0, 1], where 0 relies solely on full-text search, and 1 relies solely on dense vector search.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{ '."\n"
+ .' "Weight": {'."\n"
+ .' "alpha": 0.5'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'- Three-path recall:'."\n"
+ ."\n"
+ .' - The score is calculated using the formula: `normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score`. The `dense`, `sparse`, and `fulltext` parameters are the weights for the dense vector, sparse vector, and full-text searches, respectively. Their values must be 0 or greater. The system automatically normalizes the weights to sum to 1 (for example, `normalized_x = x / (dense + sparse + fulltext)`).'."\n"
+ ."\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 } }', 'title' => ''],
+ ],
+ [
+ 'name' => 'IncludeVector',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to include the vector in the results. The default value is `false`.'."\n"
+ ."\n"
+ .'> - **false**: The vector is not returned.'."\n"
+ .'>'."\n"
+ .'> - **true**: The vector is returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'IncludeMetadataFields',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The metadata fields to return, separated by commas. By default, no metadata fields are returned.', 'type' => 'string', 'required' => false, 'example' => 'title,page', 'title' => ''],
+ ],
+ [
+ 'name' => 'RerankFactor',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The factor used to rerank vector search results. The value must be in the range (1, 5].'."\n"
+ ."\n"
+ .'> - Reranking may be slow if document chunks are sparse.'."\n"
+ .'>'."\n"
+ .'> - The number of items to rerank, calculated as `ceil(TopK * RerankFactor)`, should not exceed 50.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'RecallWindow',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The recall window. If specified, this parameter expands the context of the retrieved results. The format is a two-element array `[A, B]`, where `-10 <= A <= 0` and `0 <= B <= 10`.'."\n"
+ ."\n"
+ .'> - Recommended when document chunks are highly fragmented, which might cause context loss during retrieval.'."\n"
+ .'>'."\n"
+ .'> - Reranking occurs before windowing is applied.', 'type' => 'string', 'required' => false, 'example' => '[-5,5]', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The field to use for sorting the results. By default, this parameter is empty.'."\n"
+ ."\n"
+ .'The field must be a metadata field or a default table field, such as `id`. Supported formats include:'."\n"
+ ."\n"
+ .'You can specify a single field (for example, `chunk_id`), multiple comma-separated fields (for example, `block_id, chunk_id`), or fields with descending order (for example, `block_id DESC, chunk_id DESC`).', 'type' => 'string', 'required' => false, 'example' => 'created_at', 'title' => ''],
+ ],
+ [
+ 'name' => 'Offset',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The offset for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ ],
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
- ],
+ 'RequestId' => ['description' => 'The unique request ID. Use this ID to troubleshoot errors.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FileId' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '20372822********'."\n",
- ],
- 'AliyunParentUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '16738266********',
- ],
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'h8r********4fch',
- ],
- 'FileFrom' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Agent',
- ],
- 'FileCategory' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'WebReport' => '',
- 'TextReport' => '',
- 'DefaultArtifact' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Results' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The unique ID of the vector.', 'type' => 'string', 'example' => '3b35c95-57f3-442f-9220-xxxxx', 'title' => ''],
+ 'Content' => ['description' => 'The content of the retrieved text chunk.', '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.', 'title' => ''],
+ 'FileName' => ['description' => 'The name of the source document.', 'type' => 'string', 'example' => '1.txt', 'title' => ''],
+ 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader.', 'type' => 'string', 'example' => '{"page_pos": 1}', 'title' => ''],
+ 'Score' => ['description' => 'The similarity score of the result. This score depends on the distance metric (`l2`, `ip`, or `cosine`) specified when the index was created.', 'type' => 'number', 'format' => 'double', 'example' => '0.81', 'title' => ''],
+ 'Vector' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'A single floating-point value from the vector.', 'type' => 'number', 'format' => 'double', 'example' => '1.2123', 'title' => ''],
+ 'description' => 'The vector data as an array of floating-point numbers.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Metadata' => ['description' => 'A key-value map of the metadata.', 'type' => 'object', 'example' => '{"title":"test"}', 'title' => ''],
+ 'RerankScore' => ['description' => 'The rerank score.', 'type' => 'number', 'format' => 'double', 'example' => '6.2345', 'title' => ''],
+ 'RetrievalSource' => ['description' => 'The method used for retrieval. Valid values: `1` (vector retrieval), `2` (full-text search), and `3` (hybrid search).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
- 'example' => 'TextReport',
+ 'description' => 'A single retrieval result.',
+ 'title' => '',
+ 'example' => '',
],
- 'GmtCreated' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-12-11T14:04:32.000+00:00',
+ 'description' => 'The retrieved results.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Matches' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => 'The text content.', '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.', 'title' => ''],
+ 'FileName' => ['description' => 'The name of the source document.', 'type' => 'string', 'example' => '1.txt', 'title' => ''],
+ 'Id' => ['description' => 'The unique ID of the vector.', 'type' => 'string', 'example' => '3b35c95-57f3-442f-9220-xxxxx', 'title' => ''],
+ 'LoaderMetadata' => ['description' => 'The metadata generated by the document loader.', 'type' => 'string', 'example' => '{"page_pos": 1}', 'title' => ''],
+ 'Metadata' => ['description' => 'A key-value map of the metadata.', 'type' => 'object', 'example' => '{"title":"test"}', 'title' => ''],
+ ],
+ 'description' => 'A matched data object.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'Matched items from the windowing process.',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
+ 'description' => 'The response payload.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ErrorCode' => ['description' => 'The error code for a failed request.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'RetrieveKnowledgeBase',
+ '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"}]',
+ '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',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SaveWorkspaceCode' => [
+ 'summary' => 'Saves workspace code. If the file does not exist, a new file is automatically created.',
+ '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' => '', 'description' => 'The ID of the workspace to publish (numeric ID).', 'type' => 'string', 'required' => true, 'example' => '12345678'],
+ ],
+ [
+ 'name' => 'Path',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The file path to save.', 'type' => 'string', 'required' => true, 'example' => '/Workspace/code/test.py'],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The code content.', 'type' => 'string', 'required' => true, 'example' => 'print(123)', 'title' => ''],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to forcibly overwrite the file regardless of whether it has been modified by others.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
+ ],
+ [
+ 'name' => 'Repo',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The repository information. Pass this parameter when creating a git repo directory during the save action.', 'type' => 'string', 'required' => false, 'example' => 'git@codeup.aliyun.com:test/abc.git', 'title' => ''],
+ ],
+ [
+ 'name' => 'Mtime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The file modification time. The GetWorkspaceCode operation returns this mtime value. When calling SaveWorkspaceCode, include this mtime to compare against the server-side value. If the mtime does not match, the save fails, indicating that the server-side version has changed.', 'type' => 'string', 'required' => false, 'example' => '2026-01-01T10:11:12Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'Iac',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether the file is an infrastructure as code template file. Set this parameter to true for YAML configuration files edited through the visual editor.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '56kv1pvl9uvt9**********bb',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Message' => ['title' => '', 'description' => 'The error message. This parameter is returned with a specific error message when the request fails, and is empty when the request succeeds.', 'type' => 'string', 'example' => 'Failed to publish，repo branch empty'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Save workspace code (create or edit)',
+ 'description' => 'Publishes workspace code.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:SaveWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Sends a user message to a specified session or cancels a session.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'SearchKey',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DMSUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Data Management unit you are currently in. If you choose to analyze a database, this information is used to correctly connect to your Data Management instance. You can go to the Data Management console to view your current Data Management unit. If you are a user of the Alibaba Cloud China Website, set this parameter to ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The session ID. This parameter is required. You can call the CreateAgentSession operation to obtain the session ID.', 'type' => 'string', 'required' => false, 'example' => 'sess_***', 'title' => ''],
+ ],
+ [
+ 'name' => 'AgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The agent ID. This parameter is required. You can obtain the current agent ID from the response of the CreateAgentSession operation. Agent resources have a lifecycle, so the agent ID that you specify in each request may change.', 'type' => 'string', 'required' => false, 'example' => 'agent_***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Message',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The message content to send to the agent.', 'type' => 'string', 'required' => true, 'example' => 'what can you do?', 'title' => ''],
+ ],
+ [
+ 'name' => 'MessageType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The message type. Default value: `[primary]`. '."\n"
+ ."\n"
+ .'- In normal cases, set the message type to `[primary]` when interacting with the agent.'."\n"
+ ."\n"
+ .'- When the message is a response to a human-in-the-loop question from the agent, set the type to `[additional]`.'."\n"
+ ."\n"
+ .'- When the message is intended to trigger report generation, set the type to `[report]`.'."\n"
+ ."\n"
+ .'- When the message is intended to cancel the current session, set the type to `[cancel]`.',
'type' => 'string',
'required' => false,
- 'example' => '',
+ 'default' => 'primary',
+ 'enum' => ['primary', 'additional', 'cancel', 'operate', 'report'],
+ 'example' => 'primary',
+ 'title' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'ReplyTo',
'in' => 'query',
+ 'schema' => ['description' => '**Important**'."\n"
+ ."\n"
+ .'When this message is a reply to an agent message (for example, the agent asks a clarifying question through ASK_HUMAN), set reply_to to the exact Checkpoint sequence number carried in that agent message. If this message is not a targeted reply, such as requesting the agent to perform further in-depth analysis after analysis is complete, you can leave reply_to empty or set it to "0". '."\n"
+ ."\n"
+ .'This field affects how the agent decides to process the message. Passing an incorrect value may cause the analysis results to be less effective than expected.', 'type' => 'string', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'QuotedMessage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The quoted content. This parameter is typically used when interacting with the agent.', 'type' => 'string', 'required' => false, 'example' => '{"version":"v0"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'Question',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The specific question that the agent asks the user through human-in-the-loop. This parameter is required when the message type is `additional`.', 'type' => 'string', 'required' => false, 'example' => '请提供计算GMV的口径。', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataSource',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NEW' => '',
- 'RELEASED' => '',
- 'DRAFT' => '',
- 'OFFLINE' => '',
+ 'description' => 'The data source information. This parameter is optional. You can pass only one data source in this parameter. Use the DataSources parameter instead.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceType' => ['description' => 'The data source type. Valid values: `[remote_data_center, database]`, indicating that the analysis is performed on a file or a database.', 'type' => 'string', 'required' => false, 'example' => 'remote_data_center', 'title' => ''],
+ 'DataSourceId' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
+ 'Location' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'localhost', 'title' => ''],
+ 'Database' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''],
+ 'Engine' => ['description' => 'The database engine type.', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''],
+ 'Tables' => [
+ 'description' => 'The list of table names to analyze.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the table to analyze.', 'type' => 'string', 'required' => false, 'example' => 'my_table', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => '35****', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ 'DbName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''],
+ 'DmsInstanceId' => ['description' => 'The ID of the instance in Data Management.', 'type' => 'string', 'required' => false, 'example' => '12******', 'title' => ''],
+ 'DmsDatabaseId' => ['description' => 'The ID of the database in Data Management.', 'type' => 'string', 'required' => false, 'example' => '23******', 'title' => ''],
],
- 'example' => 'RELEASED',
+ 'required' => false,
+ 'example' => 'null',
+ 'title' => '',
],
],
[
- 'name' => 'QueryAllReleased',
+ 'name' => 'SessionConfig',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
+ 'description' => 'The special configuration for this session. Only the configuration passed in the first SendMessage call within the same session takes effect.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Language' => ['description' => 'Only Chinese and English are supported. The default value is Chinese. Only uppercase values are supported.', 'type' => 'string', 'required' => false, 'example' => 'ENGLISH', 'title' => ''],
+ 'CustomAgentId' => ['description' => 'Deprecated. Use the input parameters of CreateAgentSession instead.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
+ 'CustomAgentStage' => ['description' => 'Deprecated. Use the input parameters of CreateAgentSession instead.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
+ 'ReportWaterMark' => ['description' => 'The text of up to 64 characters that is used as a watermark in the generated PDF report.', 'type' => 'string', 'required' => false, 'example' => '示例水印', 'title' => ''],
+ 'Mode' => ['description' => 'The mode. Valid values:'."\n"
+ .' - **ASK_DATA**: data query mode.'."\n"
+ .' - **ANALYSIS**: analysis mode.'."\n"
+ .' - **INSIGHT**: insight mode.', 'type' => 'string', 'required' => false, 'example' => 'ANALYSIS', 'title' => ''],
+ 'SkipPlan' => ['description' => 'Specifies whether to skip the plan confirmation step.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
+ 'SkipSqlConfirm' => ['description' => 'Specifies whether to skip all SQL confirmations.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''],
+ 'SkipWebReportConfirm' => ['description' => 'Specifies whether to skip the web report generation confirmation.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
+ 'SkipAskHuman' => ['description' => 'Specifies whether to disable user inquiries during the process.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
+ 'EnableSearch' => ['description' => 'Specifies whether to enable web search.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'KbUuidList' => ['description' => 'The list of knowledge base IDs.', 'type' => 'string', 'required' => false, 'example' => 'dasd***cc211', 'title' => ''],
+ 'McpServerIds' => ['description' => 'The MCP server IDs in the session configuration.', 'type' => 'string', 'required' => false, 'example' => '2q1tu90**********6uttu2nw', 'title' => ''],
+ 'PlanMode' => ['description' => 'Specifies whether to enable the plan. Valid values: disable, enable, and force. Default value: enable.', 'type' => 'string', 'required' => false, 'example' => 'disable', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ParentSessionId',
'in' => 'query',
+ 'schema' => ['description' => 'The parent session ID.', 'type' => 'string', 'required' => false, 'example' => '20qrliuoo7p2vlsfg*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataSources',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The detailed data source information. This parameter is optional.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The detailed data source information. This parameter is optional.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceType' => ['description' => 'The data source type. Valid values: remote_data_center and database, indicating that the analysis is performed on a file or a database.', 'type' => 'string', 'required' => false, 'example' => 'remote_data_center', 'title' => ''],
+ 'DataSourceId' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
+ 'Location' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'localhost', 'title' => ''],
+ 'Database' => ['description' => 'Deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''],
+ 'Engine' => ['description' => 'The database engine type.', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''],
+ 'Tables' => [
+ 'description' => 'The list of table names to analyze.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the table to analyze.', 'type' => 'string', 'required' => false, 'example' => 'my_table', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => 'f-4w*******', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''],
+ 'DbName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'mydatabase', 'title' => ''],
+ 'DmsInstanceId' => ['description' => 'The ID of the instance in Data Management.', 'type' => 'string', 'required' => false, 'example' => '248*****', 'title' => ''],
+ 'DmsDatabaseId' => ['description' => 'The ID of the database in Data Management.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'TaskConfig',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The configuration items that affect only the current task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ReportConfig' => [
+ 'description' => 'The report rule configuration. Only when MessageType is REPORT, a report task is executed based on this configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ReportType' => ['description' => 'The service type. Valid values: TextReport and WebReport, indicating that the task generates a text report or a web report. Only WebReport is supported.', 'type' => 'string', 'required' => false, 'example' => 'WebReport', 'title' => ''],
+ 'ReportTheme' => ['description' => 'The report theme. Valid values: default, journal, legacy, and neobrutalism.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ 'ReportPrompt' => ['description' => 'The prompt that the report must follow.', 'type' => 'string', 'required' => false, 'example' => 'generate a report', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => '20',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'c1p71ne***baexrt3o', 'title' => ''],
+ ],
+ [
+ 'name' => 'UserOssBucket',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The OSS bucket of the user. If this parameter is not specified, the analysis process is securely stored in built-in storage.', 'type' => 'string', 'required' => false, 'example' => 'my-bucket', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'After the Jarvis web application receives and caches the request, it directly returns a 200 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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE65CE1F-****-****-****-******'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ca-4y3ca4khkcu**********ysf',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Instruction' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Knowledge' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Status' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '56kv1pvl9uvt9**********bb',
- ],
- 'Region' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'AliyunUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20372822********',
- ],
- 'AliyunParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '16738266********',
- ],
- 'DmsUnit' => [
- 'description' => '',
- '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' => [
- 'type' => 'boolean',
- ],
- 'SkipWebReportConfirm' => [
- 'type' => 'boolean',
- ],
- 'SkipAskHuman' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- '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', 'title' => ''],
+ 'SessionId' => ['description' => 'SessionId'."\n", 'type' => 'string', 'example' => '6zbqbho********', 'title' => ''],
+ 'AgentId' => ['description' => 'AgentId'."\n", 'type' => 'string', 'example' => '3jqqdiuxun******', 'title' => ''],
+ 'MessageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '922d7fd2-77fb-4549-9091-d51da225d47f', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'Success' => ['description' => 'Success'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Send chat message',
+ 'description' => '## Request description'."\n"
+ ."\n"
+ .'- `agent_id` and `session_id` are required fields.'."\n"
+ .'- `message_type` defaults to `primary`. Set it to `additional` or `cancel` when you need to append information or cancel a session.'."\n"
+ .'- The `reply_to` field indicates which agent message this message is responding to. The default value is `0`.'."\n"
+ .'- When `message_type` is `additional`, the `question` field is required.'."\n"
+ .'- `quoted_message` can be used to quote the content of a previous user message.'."\n"
+ .'- Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are optional but provide more detailed context information.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:SendChatMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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"}]',
+ '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',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SetWorkspaceCodePublishSetting' => [
+ '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' => ['description' => 'The numeric ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '12345678', 'title' => ''],
+ ],
+ [
+ 'name' => 'Config',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The deployment configuration, provided as a JSON string. The repos array specifies the Git repositories in the workspace, primarily for setting the branch for publishing. The exclude parameter specifies which directories to skip.', 'type' => 'string', 'required' => true, 'example' => '{"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '56kv1pvl9uvt9**********bb',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The error message returned if the call fails. This parameter is empty if the call succeeds.', 'type' => 'string', 'example' => 'Failed to publish，repo branch empty', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code if the call fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'- **true**: The call was successful.'."\n"
+ ."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'SetWorkspaceCodePublishSetting',
+ 'summary' => 'Sets the code deployment configuration for a workspace. This is an asynchronous operation that returns a key. Use this key to query the operation\'s status by calling the WorkspaceActionStatus operation.',
+ 'description' => 'Sets the default code deployment configuration for a workspace. This configuration includes the Git repository branch and the directories to exclude from deployment.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ca-4y3ca4khkcu**********ysf',
- ],
+ 'schema' => ['description' => 'The ID of the Data Management Service (DMS) workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '20923*****7291'],
+ ],
+ [
+ 'name' => 'CuQuota',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The compute unit (CU) quota for the workspace.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '200'],
+ ],
+ [
+ 'name' => 'Region',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to enable auto-payment for the order.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'title' => '', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A unique, client-generated token to ensure request idempotence. The token can contain only ASCII characters and must be no longer than 64 characters. For more information, see How to ensure idempotence.', 'type' => 'string', 'required' => false, 'example' => 'acdxxx', 'title' => ''],
],
],
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter Tid is not valid.',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'title' => '', 'example' => 'NOT_FOUND'],
'Data' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'CustomAgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ca-4y3ca4khkcu**********ysf',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataJson' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Instruction' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Knowledge' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Status' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '56kv1pvl9uvt9**********bb',
- ],
- 'Region' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'AliyunUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20372822********',
- ],
- 'AliyunParentUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '16738266********',
- ],
- 'DmsUnit' => [
- 'description' => '',
- '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' => [
- 'type' => 'boolean',
- ],
- 'SkipWebReportConfirm' => [
- 'type' => 'boolean',
- ],
- 'SkipAskHuman' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- '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' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'title' => '', 'example' => '20923*****7291'],
+ 'InstanceId' => ['description' => 'The ID of the billing instance.', 'type' => 'string', 'title' => '', 'example' => 'i-2zehld3y1tphzctyyq7o'],
+ 'CuQuota' => ['description' => 'The compute unit (CU) quota.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'CuQuotaUsage' => ['description' => 'The amount of compute unit (CU) quota used.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
+ 'Status' => ['description' => 'The status of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Success'],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '263013787210103'],
+ 'State' => ['description' => 'The status of the order.', 'type' => 'string', 'title' => '', 'example' => 'Catched'],
],
+ 'title' => '',
+ 'description' => 'The returned data.',
+ 'example' => '',
],
+ 'Message' => ['description' => 'A human-readable message about the request\'s outcome.', 'type' => 'string', 'title' => '', 'example' => 'This record is being collected, please wait for a moment.'],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'SetWorkspaceQuota',
+ 'summary' => 'Sets the quota for a workspace.',
+ 'description' => 'Sets the quota for a specific workspace.',
+ '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"}]',
+ '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' => 'Initiates an accuracy self-test task.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9543,397 +11365,335 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'MemberId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20282*****7591',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RoleName',
+ 'name' => 'DmsUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'admin',
- ],
+ 'schema' => ['description' => 'The DMS unit used to create the resource.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'CsvFile',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The accuracy test sample.', 'type' => 'string', 'required' => false, 'example' => '包含问题、答案[、SQL]的文件', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D94F5232-xxx-EH0H28FGGI5I'],
+ 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'- True: The request is successful. '."\n"
+ .'- False: The request fails.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response struct.',
'type' => 'object',
'properties' => [
- 'MemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20282*****7591',
- ],
- 'UserName' => [
- 'description' => '',
- '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' => 'The ID of the accuracy test task.', 'type' => 'string', 'example' => '692abb8f-xxx-77fec862db34', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Start a self-test task',
+ 'description' => 'Initiates an accuracy self-test task.',
+ '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"}]',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the accuracy test task.', 'type' => 'string', 'required' => false, 'example' => '692abb8f-xxxx-xxxx-xxxx-xxxxxxxxxxxx'."\n", 'title' => ''],
],
[
- 'name' => 'WorkspaceType',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MY',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'WorkspaceName',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workspaceTest',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Stop an accuracy test task',
+ 'summary' => 'Stops an accuracy self-test task.',
+ 'description' => 'Stops an accuracy self-test task.',
+ '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' => 'A client token to ensure request idempotence.', 'type' => 'string', 'required' => false, 'example' => 'token-****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'AirflowId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The unique ID of the Airflow instance.', 'type' => 'string', 'required' => true, 'example' => 'af-test****', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'AirflowName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'no use',
- ],
+ 'schema' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'example' => 'testairflow', 'title' => '', 'required' => false],
],
[
- 'name' => 'NextToken',
+ 'name' => 'StartupFile',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'no use',
- ],
+ 'schema' => ['description' => 'The path to the startup script for the Airflow instance.', 'type' => 'string', 'example' => 'default/startup.sh', 'title' => '', 'required' => false],
],
[
- 'name' => 'Order',
+ 'name' => 'WorkerServerlessReplicas',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DESC',
- ],
+ 'schema' => ['description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'example' => 'test airflow', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'PluginsDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory path where Airflow scans for plugins.', 'type' => 'string', 'example' => 'default/plugins', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'AppSpec',
'in' => 'query',
+ 'schema' => ['description' => 'The specifications of the Airflow instance.', 'type' => 'string', 'example' => 'SMALL', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'RequirementFile',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path to the requirements file for package dependencies.', 'type' => 'string', 'example' => 'default/requirements.txt', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'DagsDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory path where Airflow scans for DAGs.', 'type' => 'string', 'example' => 'default/dags', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'DataMountInfoList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/DataMountInfo', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CreateTime',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'GracefulShutdownTimeout',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '60', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'EnableServerless',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Data Management Service (DMS) workspace ID.', 'type' => 'string', 'required' => true, 'example' => '863024238280****', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-F****', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'NOT_FOUND', 'title' => ''],
+ 'Root' => [
+ 'description' => 'Details of the updated Airflow instance.',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'Content' => [
- 'description' => '',
+ 'AirflowName' => ['description' => 'The name of the Airflow instance.', 'type' => 'string', 'example' => 'test airflow', 'title' => ''],
+ 'AppSpec' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'SMALL', 'title' => ''],
+ 'AppType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'AIRFLOW', 'title' => ''],
+ 'CustomAirflowCfg' => [
+ 'description' => 'A list of custom configuration items.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Creator' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '20923*****7291',
- ],
- ],
- ],
- ],
- 'TotalElements' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '122',
+ 'items' => ['description' => 'A configuration item.', 'type' => 'string', 'example' => 'smtp.username=test', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'TotalPages' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
+ 'DagsDir' => ['description' => 'The directory where DAGs are scanned.', 'type' => 'string', 'example' => 'default/dags', 'title' => ''],
+ 'DeployErrorMsg' => ['description' => 'The error message returned upon deployment failure.', 'type' => 'string', 'example' => 'quota exists', 'title' => ''],
+ 'Description' => ['description' => 'The description of the Airflow instance.', 'type' => 'string', 'example' => 'order schedule', 'title' => ''],
+ 'Environments' => ['description' => 'The environment variables.', 'type' => 'string', 'example' => 'k=v', 'title' => ''],
+ 'GmtCreated' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2025-01-07T15:10:32+08:00', 'title' => ''],
+ 'OssBucketName' => ['description' => 'The name of the Object Storage Service (OSS) bucket.', 'type' => 'string', 'example' => 'osstest', 'title' => ''],
+ 'OssPath' => ['description' => 'The path in OSS where logs are stored.', 'type' => 'string', 'example' => '/airflow', 'title' => ''],
+ 'PluginsDir' => ['description' => 'The directory where Airflow plugins are scanned.', 'type' => 'string', 'example' => 'default/plugins', 'title' => ''],
+ 'RequirementFile' => ['description' => 'The path to the Python requirements file.', 'type' => 'string', 'example' => 'default/requirements.txt', 'title' => ''],
+ 'Requirements' => ['description' => 'The Python package requirements.', 'type' => 'string', 'example' => 'jieba==0.42', 'title' => ''],
+ 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'sg-2ze1nak7h0alg1w5****', 'title' => ''],
+ 'StartupFile' => ['description' => 'The startup script for the Airflow container.', 'type' => 'string', 'example' => 'default/startup.sh', 'title' => ''],
+ 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'DEPLOYED', 'title' => ''],
+ 'Uuid' => ['description' => 'The Airflow instance ID.', 'type' => 'string', 'example' => 'af-xxx', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-hp3hyga33aur8tj36****', 'title' => ''],
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp16ko44pgciwv0****', 'title' => ''],
+ 'WorkerServerlessReplicas' => ['description' => 'The number of worker node replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '86302423828****', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
+ 'AirflowVersion' => ['description' => 'The version of Airflow.', 'type' => 'string', 'example' => '3.1', 'title' => ''],
+ 'DataMountInfoList' => [
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/DataMountInfo', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => 'A data mount item.',
+ 'title' => '',
+ 'example' => '',
],
+ 'EnableServerless' => ['description' => 'Indicates whether serverless mode is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'GracefulShutdownTimeout' => ['description' => 'The graceful shutdown timeout, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
],
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'nu use',
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'no use',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Unknown error', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'UpdateAirflow',
+ 'summary' => 'Updates the properties of an Airflow instance.',
+ '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 \\"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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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 \\"AirflowVersion\\": \\"3.1\\",\\n \\"DataMountInfoList\\": [\\n {\\n \\"OssBucket\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"MountFolderName\\": \\"\\",\\n \\"ReadOnly\\": false\\n }\\n ],\\n \\"EnableServerless\\": false,\\n \\"GracefulShutdownTimeout\\": 60\\n },\\n \\"Message\\": \\"Unknown error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'AddUserToDataAgentWorkspace' => [
- 'summary' => '为空间添加用户',
+ 'UpdateDataAgentAccuracyTest' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9942,141 +11702,130 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The accuracy test instance ID.', 'type' => 'string', 'required' => false, 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file ID in the data center.', 'type' => 'string', 'required' => false, 'example' => 'f-8*******01m'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomerAgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new custom agent ID.', 'type' => 'string', 'required' => false, 'example' => 'ca-xxxxxxxxxxxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'Dataset',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data source.', 'type' => 'string', 'required' => false, 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxxxx\\",\\"DmsDatabaseId\\":\\"752xxxxx\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]', 'title' => ''],
+ ],
+ [
+ 'name' => 'Mode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The analysis mode to be tested.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'EvaluationPrompt',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The accuracy evaluation criteria. An empty value indicates the default criteria.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20923*****7291',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
],
[
- 'name' => 'MemberId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20282*****7591',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RoleName',
+ 'name' => 'DmsUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'admin',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxConcurrent',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of concurrent sessions during the test.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'NeedDelete',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether sessions are displayed after analysis. This parameter is not supported.', 'type' => 'boolean', 'required' => false, 'example' => 'no use', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the test item.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''],
+ ],
+ [
+ 'name' => 'Desc',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E0D21075-xxx-FD8AD04A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful. '."\n"
+ .'- **false**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'Specified parameter Tid is not valid.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response struct.',
'type' => 'object',
'properties' => [
- 'MemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20282*****7591',
- ],
- 'UserName' => [
- 'description' => '',
- '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' => 'The file ID.', 'type' => 'string', 'example' => 'f-8*******01m'."\n", 'title' => ''],
+ 'AgentId' => ['description' => 'Agent Id', 'type' => 'string', 'example' => 'cu0cs*******mf', 'title' => ''],
+ 'Dataset' => ['description' => 'The data source. We recommend that you configure this in the custom agent.', 'type' => 'string', 'example' => '[{\\"DataSourceType\\":\\"database\\",\\"RegionId\\":\\"cn-hangzhou\\",\\"DmsInstanceId\\":\\"27xxxxx\\",\\"DmsDatabaseId\\":\\"752xxxxx\\",\\"Database\\":\\"employees\\",\\"Tables\\":[\\"employees\\",\\"salaries\\",\\"departments\\"]}]', 'title' => ''],
+ 'Mode' => ['description' => 'The analysis mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'EvaluationPrompt' => ['description' => 'The accuracy evaluation criteria. An empty value indicates the default criteria.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '8wfig6l33n4f4xxxxxxxxxx', 'title' => ''],
+ 'AccuracyTest' => ['description' => 'The ID of the accuracy test item.', 'type' => 'string', 'example' => 'at-106n4rg17gv9fxxxxxxxxxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Update an accuracy test item',
+ 'summary' => 'Updates the content of an accuracy test item.',
+ 'description' => 'Updates the content of an accuracy test item.',
+ '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"}]',
+ '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' => '更新空间的信息',
+ 'summary' => 'Updates workspace information.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10088,150 +11837,110 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdmsKIHNZQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'DMSUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20923*****7291',
- ],
+ 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '20923*****7291', 'title' => ''],
],
[
'name' => 'WorkspaceName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'yunqitest_v2',
- ],
+ 'schema' => ['description' => 'The new name for the workspace.', 'type' => 'string', 'required' => false, 'example' => 'yunqitest_v2', 'title' => ''],
],
[
'name' => 'WorkspaceDesc',
'in' => 'query',
+ 'schema' => ['description' => 'The new description for the workspace.', 'type' => 'string', 'required' => false, 'example' => 'space for test new', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsSessionShareEnabled',
+ 'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Specifies whether to enable session sharing for the workspace. Valid values: true and false.',
+ 'enumValueTitles' => ['false' => ''],
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'space for test new',
+ 'example' => 'true',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-***-695C'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
'Data' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20923*****7291',
- ],
- 'WorkspaceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yunqitest_v2',
- ],
- 'WorkspaceStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'space for test new',
- ],
- 'Creator' => [
- 'description' => '',
- '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' => 'The ID of the workspace.', 'type' => 'string', 'example' => '20923*****7291', 'title' => ''],
+ 'WorkspaceName' => ['description' => 'The updated name of the workspace.', 'type' => 'string', 'example' => 'yunqitest_v2', 'title' => ''],
+ 'WorkspaceStatus' => ['description' => 'The updated status of the workspace.', 'type' => 'string', 'example' => 'space for test new', 'title' => ''],
+ 'Creator' => ['description' => 'The user ID (UID) of the workspace creator.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'RoleName' => ['description' => 'The user role in the workspace.', 'type' => 'string', 'example' => 'active', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the workspace was created, specified as a UNIX timestamp in seconds.', 'type' => 'string', 'example' => '1765960516', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the workspace was last modified, specified as a UNIX timestamp in seconds.', 'type' => 'string', 'example' => '1765962516', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'space for test new', 'title' => ''],
+ 'TotalMember' => ['description' => 'The total number of members in the workspace.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'IsSessionShareEnabled' => [
+ 'description' => 'Indicates whether session sharing is enabled in the workspace.',
+ 'enumValueTitles' => ['true' => '', 'false' => ''],
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'title' => '',
],
],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The returned data.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataAgentSpaceInfo',
+ '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 \\"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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataAgentSpaceInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Changes the role of a workspace member.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10240,481 +11949,558 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The current DMS unit.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'WorkspaceName',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workspaceTest',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''],
],
[
- 'name' => 'WorkspaceDesc',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Space for test',
- ],
+ 'schema' => ['description' => 'The UID of the member whose role you want to change.', 'type' => 'string', 'required' => false, 'example' => '20282*****7591', 'title' => ''],
+ ],
+ [
+ 'name' => 'RoleName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The role to assign to the member.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E0D2-*****-A63B6',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D2-*****-A63B6'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'DMS-DA-40114', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Specified parameter is not valid.', 'title' => ''],
'Data' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'WorkspaceId' => [
- 'description' => '',
- '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' => '',
- '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' => 'The UID of the member whose role was changed.', 'type' => 'string', 'example' => '20282*****7591', 'title' => ''],
+ 'UserName' => ['description' => 'The RAM username.', 'type' => 'string', 'example' => 'yunqitest', 'title' => ''],
+ 'RoleName' => ['description' => 'The new role of the user.', 'type' => 'string', 'example' => 'admin', 'title' => ''],
+ 'JoinTime' => ['description' => 'The time when the user joined the workspace. This is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1765961516'."\n", 'title' => ''],
+ 'TotalTaskNumber' => ['description' => 'The total number of tasks for the user in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'RunningTaskNumber' => ['description' => 'The number of running tasks for the user in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DMS-DA-40114',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Specified parameter is not valid.',
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataAgentWorkspaceMemberRole',
+ '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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataAgentWorkspaceMemberRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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 \\"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' => 'Updates the information of a data lakehouse database.',
'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' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'Description',
'in' => 'query',
+ 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The storage path of the database. Supported protocols include oss, s3, and s3a.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss://path/to/database'],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The key-value pairs of the database properties.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The key and value of the parameter.', 'title' => '', 'example' => '{"key":"value"}'."\n"],
+ 'title' => '',
+ 'example' => '',
],
],
[
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
+ ],
+ [
'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- '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' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3****'],
+ 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Database' => ['description' => 'The details of the database.', '$ref' => '#/components/schemas/DLDatabase', 'title' => '', 'example' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataLakeDatabase',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SearchMemberId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20273',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Update a user-defined function in a data lake.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'SearchRoleName',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'yunqi',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'DbName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'FunctionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The details of the function.', 'required' => true, '$ref' => '#/components/schemas/DLFunctionInput', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Tid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'FunctionName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_funciton'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NesLoK****',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'C1D39814-9808-47F8-AFE0-AF167239****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Function' => ['description' => 'The details of the function.', '$ref' => '#/components/schemas/DLFunction', 'title' => '', 'example' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataLakeFunction',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Order',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', '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' => 'Updates the partition information of a data lake table.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'OrderBy',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gmt_create',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'table_name'],
+ ],
+ [
+ 'name' => 'PartitionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The information about the partition to be updated.', 'required' => true, '$ref' => '#/components/schemas/DLPartitionInput', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '20282*****7591',
- ],
- 'UserName' => [
- 'description' => '',
- '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' => '',
- '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataLakePartition',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The name of the data catalog.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive'],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default'],
+ ],
+ [
+ 'name' => 'TableInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The information about the table.', 'required' => true, '$ref' => '#/components/schemas/DLTableInput', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](~~181330~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3****'],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table to update. If you do not want to change the table name, set this parameter to the same value as the Name parameter in TableInput.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '100g_customer'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20923*****7291',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E175****'],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => 'UnknownError'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Table' => ['description' => 'The details of the table.', '$ref' => '#/components/schemas/DLTable', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDataLakeTable',
+ 'summary' => 'Updates the information of a data lake table.',
+ '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"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The document name.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
+ ],
+ [
+ 'name' => 'NewDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The new document description.', 'type' => 'string', 'required' => true, 'example' => 'test123', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique ID of the request. Use this ID for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => ['description' => 'The response object.', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument', 'title' => '', 'example' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code for a failed request.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message for a failed request.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The data returned.',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateDocument',
+ 'summary' => 'Updates the description of a document.',
+ '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 \\"GmtCreate\\": \\"2026-04-22 22:59:35\\",\\n \\"GmtModified\\": \\"2026-04-24 21:22:53\\",\\n \\"FileSize\\": 20307,\\n \\"DocsCount\\": 123,\\n \\"State\\": 0,\\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}","type":"json"}]',
+ ],
+ 'UpdateKnowledgeBase' => [
+ 'summary' => 'Updates a knowledge base.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10723,358 +12509,1802 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'required' => true, 'example' => 'kb-HZ-zgr1***', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Name',
'in' => 'query',
+ 'schema' => ['description' => 'The new knowledge base name.', 'type' => 'string', 'required' => false, 'example' => 'updated kb name', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new knowledge base description.', 'type' => 'string', 'required' => false, 'example' => 'updated kb desc', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20923*****7291'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6'],
+ 'Data' => ['description' => 'The returned data.', '$ref' => '#/components/schemas/OneMetaKnowledgeBase', 'title' => '', 'example' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned on failure.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response structure.',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateKnowledgeBase',
+ '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' => 'Uploads a document to a knowledge base.',
+ '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' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The OSS location of the input file. Construct this path by appending the file name to the `UploadDir` value returned by the `DescribeKnowledgeBaseUploadSignature` operation.', 'type' => 'string', 'required' => true, 'example' => 'knowledge_base/1666698629****/kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The description of the document.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChunkSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The size of each document chunk. The default is 250, and the maximum is 2,048.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '250', 'title' => ''],
+ ],
+ [
+ 'name' => 'ChunkOverlap',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of overlapping characters between adjacent chunks. This value cannot exceed `ChunkSize`. The default is 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''],
+ ],
+ [
+ 'name' => 'Separators',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'A separator.', 'type' => 'string', 'required' => false, 'example' => '\\n', 'title' => ''],
+ 'description' => 'An array of strings used to split text.'."\n"
+ ."\n"
+ .'> - This critical parameter affects data chunking results and is related to the splitter specified by `TextSplitterName`.'."\n"
+ .'>'."\n"
+ .'> - In most cases, you can omit this parameter. The service automatically assigns default separators based on `TextSplitterName`.',
'required' => false,
- 'example' => '21482*****7584',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ZhTitleEnhance',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to enable title enhancement.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'TextSplitterName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the text splitter.', 'type' => 'string', 'required' => false, 'example' => 'ChineseRecursiveTextSplitter', 'title' => ''],
+ ],
+ [
+ 'name' => 'DocumentLoaderName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document loader. The default is `ADBPGLoader`.', 'type' => 'string', 'required' => false, 'example' => 'ADBPGLoader', 'title' => ''],
+ ],
+ [
+ 'name' => 'VlEnhance',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to enable visual-linguistic (VL) enhanced content recognition for complex documents. The default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'SplitterModel',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The splitter model to use. The default is `qwen3-8b`.', 'type' => 'string', 'required' => false, 'example' => 'qwen3-8b', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ 'Data' => ['description' => 'The returned data object.', '$ref' => '#/components/schemas/OneMetaKnowledgeBaseDocument', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'description' => 'The response body.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UploadDocument',
+ '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"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67E910F2-4B62-5B0C-ACA3-7547695C****\\",\\n \\"Success\\": false,\\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' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREdmsKIHNZQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'KbUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The unique identifier for the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'kb-***', 'title' => ''],
+ ],
+ [
+ 'name' => 'DocumentName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the document.', 'type' => 'string', 'required' => true, 'example' => 'test.md', 'title' => ''],
+ ],
+ [
+ 'name' => 'Chunks',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A list of document chunks to upsert.', '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"
+ .']', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The unique request ID. Use this ID to troubleshoot errors.', 'type' => 'string', 'title' => '', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****'],
+ 'Data' => ['description' => 'Indicates whether the update was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The update succeeded.'."\n"
+ ."\n"
+ .'- **false**: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'KnowledgeBaseNotFound', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Resource not found kb-***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpsertDocumentChunks',
+ 'summary' => 'Upserts document chunks into a knowledge base.',
+ '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' => 'Queries the log of an asynchronous task in a workspace.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou'."\n",
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12****', 'title' => ''],
],
[
- 'name' => 'SubAccountId',
+ 'name' => 'Key',
'in' => 'query',
+ 'schema' => ['description' => 'The key for the session playback history.', 'type' => 'string', 'required' => true, 'example' => 'qps', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20282*****7591',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The response message. This can be an error message or an informational notice.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'Data' => ['description' => 'The log.', 'type' => 'string', 'example' => 'log info', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates if the request succeeded. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request succeeded.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'description' => 'The response body.',
+ 'example' => '',
],
],
],
+ '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' => 'WorkspaceActionLog',
+ 'description' => 'Pass the `key` to view the execution log of the corresponding asynchronous task. Use this API for troubleshooting.',
+ '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"}]',
+ 'translator' => 'machine',
+ ],
+ 'WorkspaceActionStatus' => [
+ 'summary' => 'Queries the status of an asynchronous task in a workspace. Operations such as a deployment return a key. Call this operation with the key to retrieve the task\'s 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' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
+ ],
+ [
+ 'name' => 'Key',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique key that identifies the asynchronous task. You can obtain this key from the response of an operation, such as a deployment.', 'type' => 'string', 'required' => true, 'example' => 'ws-xxx-xxxx', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'yunqitest',
- ],
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20282*****7591'."\n",
- ],
- 'CreateDate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1765960516',
- ],
- 'UpdateDate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1765962516',
- ],
- 'MainAccountId' => [
- 'description' => '',
+ 'Status' => [
+ 'description' => 'The status of the asynchronous task. Valid values: SUCCESS, ERROR, TIMEOUT, and CANCEL.',
'type' => 'string',
- 'example' => '167*****166',
+ 'required' => true,
+ 'example' => '{\'phase\': \'Created\', \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}',
+ 'enum' => ['ERROR', 'TIMEOUT', 'SUCCESS', 'CANCEL', 'QUEUED', 'RUNNING'],
+ 'title' => '',
],
+ 'StartTime' => ['description' => 'The time when the task started.', 'type' => 'string', 'example' => '2026-01-13T14:30:20.582182728+08:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => '2026-01-13T14:30:20.582182728+08:00', 'title' => ''],
+ 'Data' => ['description' => 'The error message if the task fails.', 'type' => 'string', 'example' => 'action failed', 'title' => ''],
],
- ],
+ 'title' => '',
+ 'description' => 'The returned data.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'This record is being collected, please wait for a moment.', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidTid', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- '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' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'WorkspaceActionStatus',
+ 'description' => 'Provide the key returned by an asynchronous action, such as a deployment, to retrieve the task\'s status.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => '数据管理'],
],
- '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"}]',
+ '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' => [
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The workspace ID (numeric ID) for the code deployment.', 'type' => 'string', 'required' => true, 'example' => '12345678', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20923*****7291',
- ],
+ 'name' => 'Config',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The configuration for the code deployment, specified as a JSON string. The `repos` array identifies the Git repositories in the workspace and specifies the branch to deploy. The `exclude` array lists directories to skip during the deployment.', 'type' => 'string', 'required' => true, 'example' => '{"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '20923*****7291',
- ],
- 'WorkspaceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'workspaceTest',
- ],
- 'WorkspaceStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'active',
- ],
- 'Creator' => [
- 'description' => '',
- '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' => 'The key for the asynchronous code deployment. Use this key to query its status.', 'type' => 'string', 'example' => 'ws-xxxx-xxxxxx', 'title' => ''],
],
- ],
+ 'title' => '',
+ 'description' => 'An object that contains the key for the asynchronous code deployment.',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The error message returned if the request fails. This parameter is empty on success.', 'type' => 'string', 'example' => 'Failed to deploy，repo branch empty', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67E910F2-4B62-5B0C-ACA3-7547695C****', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UnknownError', 'title' => ''],
+ 'Success' => ['description' => 'Indicates if the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'WorkspaceCodePublish',
+ 'summary' => 'This asynchronous API returns a key. Use this key to query the WorkspaceActionStatus API for the code deployment status.',
+ 'description' => 'Deploys the code in a workspace.',
+ '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"}]',
+ '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' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dms.cn-shenzhen.aliyuncs.com', 'vpc' => 'dms-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms.cn-beijing.aliyuncs.com', 'endpoint' => 'dms.cn-beijing.aliyuncs.com', 'vpc' => 'dms-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms.cn-shanghai.aliyuncs.com', 'endpoint' => 'dms.cn-shanghai.aliyuncs.com', 'vpc' => 'dms-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms.cn-hongkong.aliyuncs.com', 'endpoint' => 'dms.cn-hongkong.aliyuncs.com', 'vpc' => 'dms-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dms.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dms.cn-hangzhou.aliyuncs.com', 'vpc' => 'dms-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Not enough Agent seats.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dms', 'title' => 'dms'],
+ ],
+ 'ram' => [
+ 'productCode' => 'Dms',
+ 'productName' => 'Data Management',
+ 'ramCodes' => ['dms'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetDataAgentSubAccountInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataAgentSubAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeTable',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataCenterTable',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataCenterTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchCreateDataLakePartitions',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:BatchCreateDataLakePartitions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataLakeFunction',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCustomAgent',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataAgentWorkspace',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentAccuracyTestTasks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentAccuracyTestTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFileUpload',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteFileUpload',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataLakeFunction',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveUserToDataAgentWorkspace',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:RemoveUserToDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataLakeCatalog',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeCatalog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeDatabase',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataLakeFunction',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataCenterDatabase',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataCenterDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAirflow',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataLakePartition',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataAgentKnowledgeBase',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentKnowledgeBase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeKnowledgeBaseUploadSignature',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeKnowledgeBaseUploadSignature',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchUpdateDataLakePartitions',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:BatchUpdateDataLakePartitions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWorkspaceCode',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFileUpload',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListFileUpload',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeTablebaseInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTablebaseInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataLakeTable',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataAgentSession',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAirflowLoginToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:CreateAirflowLoginToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFileUploadSignature',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeFileUploadSignature',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RedeployAirflow',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:RedeployAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDocumentChunks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDocumentChunks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopDataAgentAccuracyTestTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:StopDataAgentAccuracyTestTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataLakeTable',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataLakeDatabase',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAirflows',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListAirflows',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpsertDocumentChunks',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpsertDocumentChunks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendChatMessage',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:SendChatMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataLakeTable',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDocument',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDocuments',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDataAgentSession',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataLakePartition',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataAgentSpaceInfo',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataAgentSpaceInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataAgentWorkspaceMemberRole',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataAgentWorkspaceMemberRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSqlConsoleOperationLog',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetSqlConsoleOperationLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataAgentAccuracyTest',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataAgentAccuracyTest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FileUploadCallback',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:FileUploadCallback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetNotebookTaskStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetNotebookTaskStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataLakeDatabase',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataLakePartition',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentSession',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeCatalog',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeCatalog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'WorkspaceActionStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:WorkspaceActionStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataLakeDatabase',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWorkspaceCode',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDocumentChunks',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDocumentChunks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakePartitionName',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakePartitionName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentAccuracyTestInstances',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentAccuracyTestInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListKnowledgeBases',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListKnowledgeBases',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetWorkspaceCodePublishSetting',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:SetWorkspaceCodePublishSetting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'WorkspaceActionLog',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:WorkspaceActionLog',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWorkspaceQuota',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetWorkspaceQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetWorkspaceQuota',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:SetWorkspaceQuota',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddUserToDataAgentWorkspace',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:AddUserToDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeFunction',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeFunction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakePartition',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakePartition',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWorkspaceCode',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDocument',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartDataAgentAccuracyTestTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:StartDataAgentAccuracyTestTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadDocument',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:UploadDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RetrieveKnowledgeBase',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:RetrieveKnowledgeBase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAirflow',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataAgentKnowledgeBase',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteDataAgentKnowledgeBase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataAgentAccuracyTest',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDataAgentAccuracyTest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentAccuracyTestResults',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentAccuracyTestResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'WorkspaceCodePublish',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:WorkspaceCodePublish',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataAgentWorkspace',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeFunctionName',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeFunctionName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataLakeTable',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataLakeTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetChatContent',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetChatContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentWorkspace',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentWorkspace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OperateCustomAgent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:OperateCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataAgentWorkspaceMember',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataAgentWorkspaceMember',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyCustomAgent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:ModifyCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveWorkspaceCode',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:SaveWorkspaceCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAirflow',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataAgentAccuracyTest',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateDataAgentAccuracyTest',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomAgent',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dms:DeleteCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWorkspaceCodePublishSetting',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetWorkspaceCodePublishSetting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakeTableName',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakeTableName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataLakePartitionByFilter',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListDataLakePartitionByFilter',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCustomAgent',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dms:CreateCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfigAirflow',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:ConfigAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeKnowledgeBaseStats',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:DescribeKnowledgeBaseStats',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCustomAgent',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dms:ListCustomAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataAgentWorkspaceInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataAgentWorkspaceInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAirflowVersions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:ListAirflowVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDocument',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateKnowledgeBase',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dms:UpdateKnowledgeBase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataLakeDatabase',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetDataLakeDatabase',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAirflow',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dms:GetAirflow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dms', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:28:30 +0000