summaryrefslogtreecommitdiff
path: root/data/en_us/dms-enterprise
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/dms-enterprise
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dms-enterprise')
-rw-r--r--data/en_us/dms-enterprise/2018-11-01/api-docs.php53281
1 files changed, 53281 insertions, 0 deletions
diff --git a/data/en_us/dms-enterprise/2018-11-01/api-docs.php b/data/en_us/dms-enterprise/2018-11-01/api-docs.php
new file mode 100644
index 0000000..85cc291
--- /dev/null
+++ b/data/en_us/dms-enterprise/2018-11-01/api-docs.php
@@ -0,0 +1,53281 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'dms-enterprise',
+ 'version' => '2018-11-01',
+ ],
+ 'directories' => [
+ [
+ 'id' => 155801,
+ 'title' => 'User management',
+ 'type' => 'directory',
+ 'children' => [
+ 'DeleteUser',
+ 'UpdateUser',
+ 'DisableUser',
+ 'EnableUser',
+ 'ListUsers',
+ 'GetUser',
+ 'GetUserActiveTenant',
+ 'ListUserTenants',
+ 'RegisterUser',
+ ],
+ ],
+ [
+ 'id' => 155811,
+ 'title' => 'Instance management',
+ 'type' => 'directory',
+ 'children' => [
+ 'AddInstance',
+ 'ModifyInstance',
+ 'ListInstances',
+ 'GetInstance',
+ 'DeleteInstance',
+ 'RegisterInstance',
+ 'UpdateInstance',
+ 'SimplyAddInstance',
+ ],
+ ],
+ [
+ 'id' => 155817,
+ 'title' => 'Operation audit',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetOpLog',
+ 'ListInstanceLoginAuditLog',
+ 'ListProxySQLExecAuditLog',
+ 'ListSQLExecAuditLog',
+ ],
+ ],
+ [
+ 'id' => 155822,
+ 'title' => 'Approval processes management',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListWorkFlowTemplates',
+ 'ListWorkFlowNodes',
+ 'SetWorkflowExtraInfo',
+ ],
+ ],
+ [
+ 'id' => 155825,
+ 'title' => 'Metadata management of databases and tables',
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 155839,
+ 'title' => 'Logic databases and tables',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateLogicDatabase',
+ 'AddLogicTableRouteConfig',
+ 'DeleteLogicDatabase',
+ 'DeleteLogicTableRouteConfig',
+ 'ListLogicDatabases',
+ 'GetLogicDatabase',
+ 'ListLogicTables',
+ 'GetDBTopology',
+ 'GetTableDBTopology',
+ 'ListLogicTableRouteConfig',
+ 'EditLogicDatabase',
+ ],
+ ],
+ [
+ 'id' => 199585,
+ 'title' => 'Data Lake tables',
+ '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',
+ ],
+ ],
+ 'SearchDatabase',
+ 'SearchTable',
+ 'ListDatabases',
+ 'ListTables',
+ 'ListTableColumns',
+ 'ListColumns',
+ 'ListIndexes',
+ 'GetDatabase',
+ 'GetPhysicalDatabase',
+ 'GetTableTopology',
+ 'GetMetaTableDetailInfo',
+ 'GetMetaTableColumn',
+ 'SyncInstanceMeta',
+ 'SyncDatabaseMeta',
+ 'GetTableKnowledgeInfo',
+ 'EditMetaKnowledgeAsset',
+ ],
+ ],
+ [
+ 'id' => 155851,
+ 'title' => 'Ticket management',
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 155852,
+ 'title' => 'General operations',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateOrder',
+ 'GetApprovalDetail',
+ 'ListOrders',
+ 'GetOrderBaseInfo',
+ 'SubmitOrderApproval',
+ 'ApproveOrder',
+ 'CloseOrder',
+ 'GetOrderAttachmentFile',
+ 'PreviewWorkflow',
+ ],
+ ],
+ [
+ 'id' => 155860,
+ 'title' => 'Permission application',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetOwnerApplyOrderDetail',
+ 'GetPermApplyOrderDetail',
+ ],
+ ],
+ [
+ 'id' => 155863,
+ 'title' => 'Database and table synchronization',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateStructSyncOrder',
+ 'GetStructSyncOrderDetail',
+ 'GetStructSyncJobDetail',
+ 'GetStructSyncJobAnalyzeResult',
+ 'GetStructSyncExecSqlDetail',
+ 'SubmitStructSyncOrderApproval',
+ 'ExecuteStructSync',
+ ],
+ ],
+ [
+ 'id' => 155871,
+ 'title' => 'Data change',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDataCorrectOrder',
+ 'CreateDataCronClearOrder',
+ 'CreateDataImportOrder',
+ 'CreateFreeLockCorrectOrder',
+ 'ModifyDataCorrectExecSQL',
+ 'PauseDataCorrectSQLJob',
+ 'GetDataCorrectTaskDetail',
+ 'GetDataCronClearTaskDetailList',
+ 'GetDataCorrectRollbackFile',
+ 'GetDataCorrectBackupFiles',
+ 'GetDataCorrectOrderDetail',
+ 'GetDataCronClearConfig',
+ 'GetDataCorrectSQLFile',
+ 'ListDataCorrectPreCheckSQL',
+ 'ListDataCorrectPreCheckDB',
+ 'ExecuteDataCorrect',
+ 'RetryDataCorrectPreCheck',
+ 'RestartDataCorrectSQLJob',
+ 'ListDataImportSQLPreCheckDetail',
+ 'ListDataImportSQLType',
+ 'GetDataImportSQL',
+ 'SkipDataCorrectRowCheck',
+ 'CreateProcCorrectOrder',
+ ],
+ ],
+ [
+ 'id' => 155888,
+ 'title' => 'Schema design',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreatePublishGroupTask',
+ 'ListDDLPublishRecords',
+ 'GetTableDesignProjectFlow',
+ 'GetTableDesignProjectInfo',
+ ],
+ ],
+ [
+ 'id' => 155891,
+ 'title' => 'Data export',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDatabaseExportOrder',
+ 'CreateDataExportOrder',
+ 'ExecuteDataExport',
+ 'GetDataExportPreCheckDetail',
+ 'GetDataExportDownloadURL',
+ 'GetDatabaseExportOrderDetail',
+ 'GetDataExportOrderDetail',
+ 'GetDbExportDownloadURL',
+ 'SuspendDataExportJob',
+ 'PauseDataExportJob',
+ 'RemoveDataExportJob',
+ 'RestartDataExportJob',
+ ],
+ ],
+ [
+ 'id' => 155895,
+ 'title' => 'SQL review',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateSQLReviewOrder',
+ 'GetSQLReviewCheckResultStatus',
+ 'ListSQLReviewOriginSQL',
+ 'GetSQLReviewOptimizeDetail',
+ ],
+ ],
+ [
+ 'id' => 182112,
+ 'title' => 'Data tracking',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDataTrackOrder',
+ 'GetDataTrackJobDegree',
+ 'GetDataTrackJobTableMeta',
+ 'GetDataTrackOrderDetail',
+ 'SearchDataTrackResult',
+ 'DownloadDataTrackResult',
+ 'QueryDataTrackResultDownloadStatus',
+ ],
+ ],
+ [
+ 'id' => 155900,
+ 'title' => 'File upload',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateUploadFileJob',
+ 'CreateUploadOSSFileJob',
+ 'GetUserUploadFileJob',
+ ],
+ ],
+ [
+ 'id' => 182765,
+ 'title' => 'Data archiving',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDataArchiveOrder',
+ 'GetDataArchiveOrderDetail',
+ 'GetDataArchiveCount',
+ 'GetPagedInstance',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 155904,
+ 'title' => 'SQL task management',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListDBTaskSQLJob',
+ 'ListDBTaskSQLJobDetail',
+ 'GetDBTaskSQLJobLog',
+ 'GetOnlineDDLProgress',
+ 'GenerateSqlFromNL',
+ ],
+ ],
+ [
+ 'id' => 155908,
+ 'title' => 'Permission management',
+ 'type' => 'directory',
+ 'children' => [
+ 'SetOwners',
+ 'ListInstanceUserPermissions',
+ 'ListDatabaseUserPermssions',
+ 'ListUserPermissions',
+ 'GrantUserPermission',
+ 'RevokeUserPermission',
+ 'ListAuthorizedInstancesForUser',
+ 'ListAuthorizedUsersForInstance',
+ 'ListAuthorizedDatabasesForUser',
+ 'ListAuthorizedUsersForDatabase',
+ ],
+ ],
+ [
+ 'id' => 155915,
+ 'title' => 'Security management',
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 175207,
+ 'title' => 'Security rule set management',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateStandardGroup',
+ 'ListStandardGroups',
+ 'UpdateStandardGroup',
+ 'DeleteStandardGroup',
+ 'GetStandardGroup',
+ ],
+ ],
+ [
+ 'id' => 175341,
+ 'title' => 'Sensitive field management',
+ 'type' => 'directory',
+ 'children' => [
+ 'AddDesensitizationRule',
+ 'ListDesensitizationRule',
+ 'ModifyDesensitizationStrategy',
+ 'ListClassificationTemplates',
+ 'ListSensitiveDataAuditLog',
+ 'ListSensitiveColumns',
+ 'ListSensitiveColumnsDetail',
+ 'ChangeColumnSecLevel',
+ 'ChangeColumnSecurityLevel',
+ 'GetClassificationTemplate',
+ 'ListSensitivityLevel',
+ 'ListSensitiveColumnInfo',
+ ],
+ ],
+ [
+ 'id' => 155916,
+ 'title' => 'Secure access proxy',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateProxy',
+ 'DeleteProxy',
+ 'ListProxies',
+ 'GetProxy',
+ 'CreateProxyAccess',
+ 'DeleteProxyAccess',
+ 'ListProxyAccesses',
+ 'InspectProxyAccessSecret',
+ 'GetProxyAccess',
+ ],
+ ],
+ [
+ 'id' => 179228,
+ 'title' => 'Authority template',
+ 'type' => 'directory',
+ 'children' => [
+ 'GrantTemplateAuthority',
+ 'RevokeTemplateAuthority',
+ 'CreateAuthorityTemplate',
+ 'UpdateAuthorityTemplate',
+ 'AddAuthorityTemplateItems',
+ 'GetAuthorityTemplateItem',
+ 'GetAuthorityTemplate',
+ 'ListAuthorityTemplate',
+ 'DeleteAuthorityTemplate',
+ ],
+ ],
+ [
+ 'id' => 199547,
+ 'title' => 'Permission policies',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateAbacPolicy',
+ 'ListAbacPolicies',
+ 'UpdateAbacPolicy',
+ 'DeleteAbacPolicy',
+ 'GetAbacPolicy',
+ 'CreateAbacAuthorization',
+ 'CreateAbacAuthorization',
+ 'ListAbacAuthorizations',
+ 'DeleteAbacAuthorization',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 155928,
+ 'title' => 'Data query',
+ 'type' => 'directory',
+ 'children' => [
+ 'ExecuteScript',
+ ],
+ ],
+ [
+ 'id' => 168142,
+ 'title' => 'Data development',
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 168143,
+ 'title' => 'Task orchestration',
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateTaskFlowConstants',
+ 'DeleteTaskFlow',
+ 'OfflineTaskFlow',
+ 'ListTaskFlow',
+ 'GetTaskInstanceRelation',
+ 'ListTaskFlowInstance',
+ 'ListDAGVersions',
+ 'ReDeployLhDagVersion',
+ 'UpdateScenario',
+ 'ResumeTaskFlowInstance',
+ 'UpdateTaskContent',
+ 'ListTaskFlowsByPage',
+ 'ListScenarios',
+ 'UpdateTaskConfig',
+ 'ListTaskFlowConstants',
+ 'BackFill',
+ 'UpdateTaskTimeVariables',
+ 'ListTaskFlowTimeVariables',
+ 'UpdateTaskFlowTimeVariables',
+ 'UpdateTaskFlowCooperators',
+ 'CreateScenario',
+ 'DeleteScenario',
+ 'UpdateSLARules',
+ 'GetRuleNumLimitOfSLA',
+ 'GetIntervalLimitOfSLA',
+ 'ListDefaultSLARules',
+ 'ListTaskFlowCooperators',
+ 'ListSLARules',
+ 'GetTask',
+ 'MoveTaskFlowToScenario',
+ 'GetTaskFlowNotification',
+ 'UpdateTaskName',
+ 'UpdateTaskOutput',
+ 'DeleteTaskFlowEdgesByCondition',
+ 'ListTaskFlowEdgesByCondition',
+ 'AddTaskFlowEdges',
+ 'UpdateTaskFlowNameAndDesc',
+ 'GetTaskFlowGraph',
+ 'UpdateTaskFlowEdges',
+ 'UpdateTaskFlowOwner',
+ 'UpdateTaskFlowSchedule',
+ 'UpdateTaskFlowRelations',
+ 'UpdateTaskFlowNotification',
+ 'ListTasksInTaskFlow',
+ 'CreateTaskFlow',
+ 'SuspendTaskFlowInstance',
+ 'ReRunTaskFlowInstance',
+ 'MakeTaskFlowInstanceSuccess',
+ 'DeleteTask',
+ 'PublishAndDeployTaskFlow',
+ 'StopTaskFlowInstance',
+ 'CreateTask',
+ 'UpdateTaskContentV2',
+ 'TryRunTaskFlow',
+ ],
+ ],
+ [
+ 'id' => 168144,
+ 'title' => 'Data warehouse development',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateLakeHouseSpace',
+ 'GetLhSpaceByName',
+ 'DeleteLakeHouseSpace',
+ 'ListLhTaskFlowAndScenario',
+ 'AddLhMembers',
+ 'DeleteLhMembers',
+ 'ChangeLhDagOwner',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 175344,
+ 'title' => 'Orders',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListEffectiveOrders',
+ 'RefundPayAsYouGoOrder',
+ 'BuyPayAsYouGoOrder',
+ ],
+ ],
+ [
+ 'id' => 231570,
+ 'title' => 'Asset category',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateMetaCategory',
+ 'ListMetaCategory',
+ 'UpdateMetaCategory',
+ 'DeleteMetaCategory',
+ 'ListTablesInCategory',
+ 'AddTableToCategory',
+ 'RemoveTableFromCategory',
+ ],
+ ],
+ [
+ 'id' => 182884,
+ 'title' => 'SQL lineage',
+ 'type' => 'directory',
+ 'children' => [
+ 'AnalyzeSQLLineage',
+ ],
+ ],
+ [
+ 'id' => 245352,
+ 'title' => 'Workspace',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateWorkspace',
+ 'DeleteWorkspace',
+ 'GetWorkspace',
+ 'ListWorkspaces',
+ 'UpdateWorkspace',
+ ],
+ ],
+ [
+ 'id' => 313015,
+ 'title' => 'Others',
+ 'type' => 'directory',
+ 'children' => [
+ 'OptimizeSqlByMetaAgent',
+ 'FixSqlByMetaAgent',
+ 'AnswerSqlSyntaxByMetaAgent',
+ 'ListUserOwnedResources',
+ 'CheckBatchTableAccessPermission',
+ 'ChatWithDesensitize',
+ 'ChatWithDesensitizeSSE',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'ColumnKnowledgeInfo' => [
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'columnName',
+ ],
+ 'Description' => [
+ 'description' => 'Field description in the CREATE TABLE statement.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'description',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'columnType',
+ ],
+ 'Position' => [
+ 'description' => 'The field order in the CREATE TABLE statement.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'backendName' => 'position',
+ ],
+ 'AssetDescription' => [
+ 'description' => 'User-edited business knowledge content, which can be modified via the EditMetaKnowledgeAsset API.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'assetDescription',
+ ],
+ 'AssetModifiedGmt' => [
+ 'description' => 'The last modified time of the field.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'assetModifiedGmt',
+ ],
+ ],
+ 'description' => '',
+ ],
+ 'DLCatalog' => [
+ 'title' => 'Catalog',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => [
+ 'title' => 'Description',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'init default catalog',
+ 'backendName' => 'description',
+ ],
+ 'Name' => [
+ 'title' => 'Name',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'name',
+ ],
+ 'Location' => [
+ 'title' => 'Location',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'DLColumn' => [
+ 'title' => 'Column',
+ 'description' => 'Column properties.',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'title' => 'comment',
+ 'description' => 'The comment of the column.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'from deserializer',
+ 'backendName' => 'comment',
+ ],
+ 'Type' => [
+ 'title' => 'type',
+ 'description' => 'The data type of the column, including array, bigint, binary, boolean, char, date, decimal, double, float, int, interval, map, set, smallint, string, struct, timestamp, tinyint, union, varchar.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'string',
+ 'backendName' => 'type',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the column.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'col',
+ 'backendName' => 'name',
+ ],
+ ],
+ ],
+ 'DLDatabase' => [
+ 'title' => 'Database',
+ 'description' => 'The information about the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The description of the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'Default database for catalog hive',
+ 'backendName' => 'description',
+ ],
+ 'Parameters' => [
+ 'description' => 'The parameters related to the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => 'key/value',
+ 'backendName' => 'parameters',
+ ],
+ 'DbId' => [
+ 'title' => 'dbId',
+ 'description' => 'The database ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '19',
+ 'backendName' => 'dbId',
+ ],
+ 'CatalogName' => [
+ 'title' => 'catalogName',
+ 'description' => 'The name of the catalog.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'name',
+ ],
+ 'Location' => [
+ 'title' => 'location',
+ 'description' => 'The storage path of the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'DLFunction' => [
+ 'description' => 'The information about functions.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'FunctionName' => [
+ 'description' => 'The name of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'my_funciton',
+ 'backendName' => 'functionName',
+ ],
+ 'OwnerName' => [
+ 'description' => 'The owner of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'ownerName',
+ ],
+ 'OwnerType' => [
+ 'description' => 'The type of the owner. Valid values:'."\n"
+ ."\n"
+ .'* ROLE'."\n"
+ .'* GROUP'."\n"
+ .'* USER'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'ownerType',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ 'backendName' => 'creatorId',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The type of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'JAVA',
+ 'backendName' => 'functionType',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the function was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'createTime',
+ ],
+ 'ResourceUris' => [
+ 'description' => 'The resource URIs of the function. You cannot modify the resource URIs after the function is created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The URI used to access the resource.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLResourceUri',
+ ],
+ 'backendName' => 'resourceUris',
+ ],
+ 'ClassName' => [
+ 'description' => 'The JAVA class that contains the function code.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'com.example.hive.MyCustomUDF',
+ 'backendName' => 'className',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'DbName' => [
+ 'description' => 'The name of the queried database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'dbName',
+ ],
+ 'ModifierId' => [
+ 'description' => 'The ID of the user who modified the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '26****',
+ 'backendName' => 'modifierId',
+ ],
+ ],
+ ],
+ 'DLFunctionInput' => [
+ 'description' => 'The information about the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'FunctionName' => [
+ 'description' => 'The name of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'my_funciton',
+ 'backendName' => 'functionName',
+ ],
+ 'OwnerName' => [
+ 'description' => 'The owner of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'zhangsan',
+ 'backendName' => 'ownerName',
+ ],
+ 'OwnerType' => [
+ 'description' => 'The type of the owner.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ROLE'."\n"
+ .'* GROUP'."\n"
+ .'* USER'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'ROLE' => 'ROLE',
+ 'GROUP' => 'GROUP',
+ 'USER' => 'USER',
+ ],
+ 'example' => 'USER',
+ 'backendName' => 'ownerType',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ 'backendName' => 'creatorId',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The type of the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'JAVA',
+ 'backendName' => 'functionType',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the function was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'createTime',
+ ],
+ 'ResourceUris' => [
+ 'description' => 'The resource URIs of the function. You cannot modify the resource URIs after the function is created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The URI used to access the resource.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLResourceUri',
+ ],
+ 'backendName' => 'resourceUris',
+ ],
+ 'ClassName' => [
+ 'description' => 'The JAVA class that contains the function code.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'com.example.hive.MyCustomUDF',
+ 'backendName' => 'className',
+ ],
+ 'ModifierId' => [
+ 'description' => 'The ID of the user who modified the function.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '26****',
+ 'backendName' => 'modifierId',
+ ],
+ ],
+ ],
+ 'DLOrder' => [
+ 'title' => 'Order',
+ 'description' => 'Column sorting information.',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Order' => [
+ 'title' => 'order',
+ 'description' => 'The position of the column in the sort.',
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'backendName' => 'order',
+ ],
+ 'Col' => [
+ 'title' => 'col',
+ 'description' => 'The name of the column.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'col1',
+ 'backendName' => 'col',
+ ],
+ ],
+ ],
+ 'DLPartition' => [
+ 'description' => 'The partition information.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The table name.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'table_name',
+ 'backendName' => 'tableName',
+ ],
+ 'Sd' => [
+ 'description' => 'The description of the data storage.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'sd',
+ '$ref' => '#/components/schemas/DLStorageDescriptor',
+ ],
+ 'Parameters' => [
+ 'description' => 'The key-value pair of the partition.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'The key and value of the key-value pair.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '{"key":"value"}',
+ ],
+ 'backendName' => 'parameters',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the partition was created. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1735109884',
+ 'backendName' => 'createTime',
+ ],
+ 'Values' => [
+ 'description' => 'The values in a partition key column.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the partition key column.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'part_val1',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'values',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'DbName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'dbName',
+ ],
+ 'LastAccessTime' => [
+ 'description' => 'The time when the table was last accessed.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'lastAccessTime',
+ ],
+ ],
+ ],
+ 'DLPartitionInput' => [
+ 'description' => 'The partition information.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Parameters' => [
+ 'description' => 'The key-value pair of the partition.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'The key and value of the key-value pair.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '{"key":"value"}',
+ ],
+ 'backendName' => 'parameters',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the partition was created. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1735109884',
+ 'backendName' => 'createTime',
+ ],
+ 'Values' => [
+ 'description' => 'The values of the partition key columns.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the partition key column.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'part_val1',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'values',
+ ],
+ 'StorageDescriptor' => [
+ 'description' => 'The description of the data storage.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'sd',
+ '$ref' => '#/components/schemas/DLStorageDescriptor',
+ ],
+ 'LastAccessTime' => [
+ 'description' => 'The time when the partition was last accessed. The value is a UNIX timestamp. Unit: seconds.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'lastAccessTime',
+ ],
+ ],
+ ],
+ 'DLResourceUri' => [
+ 'description' => 'The resource information.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'description' => 'The resource type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ARCHIVE'."\n"
+ .'* JAR'."\n"
+ .'* FILE'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'ARCHIVE' => 'ARCHIVE',
+ 'JAR' => 'JAR',
+ 'FILE' => 'FILE',
+ ],
+ 'example' => 'JAR',
+ 'backendName' => 'resourceType',
+ ],
+ 'Uri' => [
+ 'description' => 'The URL used to access the resource.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar',
+ 'backendName' => 'uri',
+ ],
+ ],
+ ],
+ 'DLSerdeInfo' => [
+ 'title' => 'SerdeInfo',
+ 'description' => 'The serialization and deserialization information.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'SerializationLib' => [
+ 'title' => 'serializationLib',
+ 'description' => 'The class name of the serialization library.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe',
+ 'backendName' => 'serializationLib',
+ ],
+ 'DeserializerClass' => [
+ 'title' => 'deserializerClass',
+ 'description' => 'The name of the class used for deserialization.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.serde2.OpenCSVSerde',
+ 'backendName' => 'deserializerClass',
+ ],
+ 'Parameters' => [
+ 'title' => 'parameters',
+ 'description' => 'Serialization-related parameters in key-value pairs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => '{ "serialization.format": "1"'."\n"
+ .' }',
+ 'backendName' => 'parameters',
+ ],
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The description of serialization.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '"serialize"',
+ 'backendName' => 'description',
+ ],
+ 'SerdeType' => [
+ 'description' => 'The type of serialization.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'backendName' => 'serdeType',
+ 'title' => 'serdeType',
+ ],
+ 'SerializerClass' => [
+ 'title' => 'serializerClass',
+ 'description' => 'The name of class used for serialization.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe',
+ 'backendName' => 'serializerClass',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of serialization.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'name',
+ 'backendName' => 'name',
+ ],
+ ],
+ ],
+ 'DLSkewedInfo' => [
+ 'title' => 'SkewedInfo',
+ 'description' => 'The data structure that stores the information about skewed columns.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'SkewedColValues' => [
+ 'title' => 'skewedColValues',
+ 'description' => 'The lists of skewed column values. Each list provides a set of associated values.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of skewed column values.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values of the skewed columns.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '"123"',
+ 'extendType' => 'true',
+ ],
+ 'itemName' => 'SkewedColValue',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'skewedColValues',
+ 'itemName' => 'SkewedColValue',
+ ],
+ 'SkewedColValueLocationMaps' => [
+ 'title' => 'skewedColValueLocationMaps',
+ 'description' => 'The mappings between skewed values and columns.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => '{“col1”:"val1"}',
+ 'backendName' => 'skewedColValueLocationMaps',
+ ],
+ 'SkewedColNames' => [
+ 'title' => 'skewedColNames',
+ 'description' => 'The list of skewed column names.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The names of the skewed fields.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'col1',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'skewedColNames',
+ 'itemName' => 'SkewedColName',
+ ],
+ ],
+ ],
+ 'DLStorageDescriptor' => [
+ 'title' => 'StorageDescriptor',
+ 'description' => 'The description of the data storage.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalColumns' => [
+ 'title' => 'originalColumns',
+ 'description' => 'The description of the original column.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the column.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLColumn',
+ ],
+ 'backendName' => 'originalColumns',
+ 'itemName' => 'OriginalColumn',
+ ],
+ 'SortCols' => [
+ 'title' => 'sortCols',
+ 'description' => 'The description of the column based on which you want to sort query results.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The column based on which you want to sort query results.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLOrder',
+ ],
+ 'backendName' => 'sortCols',
+ 'itemName' => 'SortCol',
+ ],
+ 'Parameters' => [
+ 'title' => 'parameters',
+ 'description' => 'Other parameter mappings of data storage.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => 'key/value',
+ 'backendName' => 'parameters',
+ ],
+ 'SkewedInfo' => [
+ 'title' => 'skewedInfo',
+ 'description' => 'The information about the skewed column.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'skewedInfo',
+ '$ref' => '#/components/schemas/DLSkewedInfo',
+ ],
+ 'InputFormat' => [
+ 'title' => 'inputFormat',
+ 'description' => 'The name of the input format class that is used to read data.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.mapred.SequenceFileInputFormat',
+ 'backendName' => 'inputFormat',
+ ],
+ 'OutputFormat' => [
+ 'title' => 'outputFormat',
+ 'description' => 'The name of the output format class that is used to write data.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat',
+ 'backendName' => 'outputFormat',
+ ],
+ 'Columns' => [
+ 'title' => 'columns',
+ 'description' => 'The description of the data columns.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the columns.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLColumn',
+ ],
+ 'backendName' => 'columns',
+ 'itemName' => 'Column',
+ ],
+ 'IsCompressed' => [
+ 'title' => 'isCompressed',
+ 'description' => 'Specifies whether the stored data is compressed.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ 'backendName' => 'isCompressed',
+ ],
+ 'SerdeInfo' => [
+ 'title' => 'serdeInfo',
+ 'description' => 'The information about how to perform data serialization and deserialization.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'serdeInfo',
+ '$ref' => '#/components/schemas/DLSerdeInfo',
+ ],
+ 'BucketCols' => [
+ 'title' => 'bucketCols',
+ 'description' => 'The list of bucket column names, which determines the distribution of stored data based on hashes.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The bucket column.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '2010',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'bucketCols',
+ 'itemName' => 'BucketCol',
+ ],
+ 'NumBuckets' => [
+ 'title' => 'numBuckets',
+ 'description' => 'The number of buckets.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '-1',
+ 'backendName' => 'numBuckets',
+ ],
+ 'Location' => [
+ 'title' => 'location',
+ 'description' => 'The location where the data is stored.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'DLTable' => [
+ 'title' => 'Table',
+ 'description' => 'The information about the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ViewOriginalText' => [
+ 'title' => 'viewOriginalText',
+ 'description' => 'The original text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewOriginalText',
+ ],
+ 'Owner' => [
+ 'title' => 'owner',
+ 'description' => 'The name of the table owner.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'owner',
+ ],
+ 'TableType' => [
+ 'title' => 'tableType',
+ 'description' => 'The type of the table. Valid values: MANAGED_TABLE, EXTERNAL_TABLE, VIRTUAL_VIEW, INDEX_TABLE, and MATERIALIZED_VIEW.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'EXTERNAL_TABLE',
+ 'backendName' => 'tableType',
+ ],
+ 'Parameters' => [
+ 'title' => 'parameters',
+ 'description' => 'The key-value pair.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => '{'."\n"
+ .' "EXTERNAL": "TRUE",'."\n"
+ .' "delta.minReaderVersion": "1"}',
+ 'backendName' => 'parameters',
+ ],
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The description of the application table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '1410769',
+ 'backendName' => 'description',
+ ],
+ 'CreatorId' => [
+ 'title' => 'creatorId',
+ 'description' => 'The ID of the user who created the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '88653',
+ 'backendName' => 'creatorId',
+ ],
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The time when the data table was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'createTime',
+ ],
+ 'StorageDescriptor' => [
+ 'title' => 'StorageDescriptor',
+ 'description' => 'The description of data storage, including the storage characteristics and format of the table.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'storageDescriptor',
+ '$ref' => '#/components/schemas/DLStorageDescriptor',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'lastAccessTime',
+ 'description' => 'The time when the table was last accessed.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'lastAccessTime',
+ ],
+ 'Retention' => [
+ 'title' => 'retention',
+ 'description' => 'The retention period of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ 'backendName' => 'retention',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '100g_customer',
+ 'backendName' => 'name',
+ ],
+ 'OwnerType' => [
+ 'title' => 'ownerType',
+ 'description' => 'The type of the table owner. Valid values: USER, ROLE, and GROUP.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'ownerType',
+ ],
+ 'ViewExpandedText' => [
+ 'title' => 'viewExpandedText',
+ 'description' => 'The expanded text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewExpandedText',
+ ],
+ 'DbId' => [
+ 'title' => 'dbId',
+ 'description' => 'The ID of the database in which the table is stored.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '19',
+ 'backendName' => 'dbId',
+ ],
+ 'DbName' => [
+ 'title' => 'dbName',
+ 'description' => 'The name of the database in which the table is stored.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'dbName',
+ ],
+ 'CatalogName' => [
+ 'title' => 'catalogName',
+ 'description' => 'The name of the catalog to which the table belongs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'PartitionKeys' => [
+ 'title' => 'partitionKeys',
+ 'description' => 'The column attributes of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Column'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLColumn',
+ ],
+ 'backendName' => 'partitionKeys',
+ 'itemName' => 'PartitionKey',
+ ],
+ 'ModifierId' => [
+ 'title' => 'modifierId',
+ 'description' => 'The ID of the user who last modified the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1410769',
+ 'backendName' => 'modifierId',
+ ],
+ 'Location' => [
+ 'title' => 'location',
+ 'description' => 'The storage path of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'DLTablebaseInfo' => [
+ 'title' => 'TablebaseInfo',
+ 'description' => 'The basic information about the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'title' => 'owner',
+ 'description' => 'The owner of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'test',
+ 'backendName' => 'owner',
+ ],
+ 'ViewOriginalText' => [
+ 'title' => 'viewOriginalText',
+ 'description' => 'The original text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewOriginalText',
+ ],
+ 'TableType' => [
+ 'title' => 'tableType',
+ 'description' => 'The type of the table. Valid values: MANAGED_TABLE, EXTERNAL_TABLE, VIRTUAL_VIEW, INDEX_TABLE, and MATERIALIZED_VIEW.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'EXTERNAL_TABLE',
+ 'backendName' => 'tableType',
+ ],
+ 'Parameters' => [
+ 'title' => 'parameters',
+ 'description' => 'Additional parameters for the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'example' => ' "EXTERNAL": "TRUE"',
+ 'backendName' => 'parameters',
+ ],
+ 'Description' => [
+ 'title' => 'description',
+ 'description' => 'The comment of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '"table"',
+ 'backendName' => 'description',
+ ],
+ 'CreatorId' => [
+ 'title' => 'creatorId',
+ 'description' => 'The ID of the user who created the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '141****',
+ 'backendName' => 'creatorId',
+ ],
+ 'CreateTime' => [
+ 'title' => 'createTime',
+ 'description' => 'The time when the table was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'createTime',
+ ],
+ 'LastAccessTime' => [
+ 'title' => 'lastAccessTime',
+ 'description' => 'The time when the table was last accessed.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'lastAccessTime',
+ ],
+ 'Retention' => [
+ 'title' => 'retention',
+ 'description' => 'The retention period of the table. Unit: days.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30000',
+ 'backendName' => 'retention',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '100g_customer',
+ 'backendName' => 'name',
+ ],
+ 'OwnerType' => [
+ 'title' => 'ownerType',
+ 'description' => 'The type of the table owner. Valid values: USER, ROLE, and GROUP.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'ROLE ',
+ 'backendName' => 'ownerType',
+ ],
+ 'ViewExpandedText' => [
+ 'title' => 'viewExpandedText',
+ 'description' => 'The expanded text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewExpandedText',
+ ],
+ 'DbId' => [
+ 'title' => 'dbId',
+ 'description' => 'The ID of the database in which the table is stored.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '19',
+ 'backendName' => 'dbId',
+ ],
+ 'DbName' => [
+ 'title' => 'dbName',
+ 'description' => 'The name of the database in which the table is stored.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '100g_customer',
+ 'backendName' => 'dbName',
+ ],
+ 'CatalogName' => [
+ 'title' => 'catalogName',
+ 'description' => 'The catalog to which the table belongs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'PartitionKeys' => [
+ 'title' => 'partitionKeys',
+ 'description' => 'The column attributes of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The attributes of the column.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLColumn',
+ ],
+ 'backendName' => 'partitionKeys',
+ 'itemName' => 'Column',
+ ],
+ 'ModifierId' => [
+ 'title' => 'modifierId',
+ 'description' => 'The time when the table was modified.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1410769',
+ 'backendName' => 'modifierId',
+ ],
+ 'Location' => [
+ 'title' => 'location',
+ 'description' => 'The storage path of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'MetaCategory' => [
+ 'description' => 'The information about the category.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryId' => [
+ 'description' => 'The category ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '30000181325',
+ 'backendName' => 'id',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The creation time.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '2024-08-13 10:02:02',
+ 'backendName' => 'gmtCreate',
+ ],
+ 'Depth' => [
+ 'description' => 'The level of the category. This parameter is set to 1 for a root category.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'backendName' => 'depth',
+ ],
+ 'ParentCategoryId' => [
+ 'description' => 'The ID of the parent category. This parameter is left empty for a root category.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '30000322682',
+ 'backendName' => 'parentCategoryId',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the category.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'default',
+ 'backendName' => 'categoryName',
+ ],
+ ],
+ ],
+ 'MetaCategoryTableEntity' => [
+ 'description' => 'The data table information item under the category of the attributable asset.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryId' => [
+ 'description' => 'The category ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => 'FC-1D123DF554A45AAB',
+ 'backendName' => 'categoryId',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'test_table',
+ 'backendName' => 'tableName',
+ ],
+ 'Description' => [
+ 'description' => 'The description.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'ga_platform_alb',
+ 'backendName' => 'description',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '174****',
+ 'backendName' => 'instanceId',
+ ],
+ 'TableSchemaName' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'dbo',
+ 'backendName' => 'tableSchemaName',
+ ],
+ 'DbId' => [
+ 'description' => 'The database ID. You can call the [ListDatabases](~~141873~~) operation to query the ID of a physical database and the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n"
+ ."\n"
+ .'> The value of DatabaseId is that of DbId.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123***',
+ 'backendName' => 'dbId',
+ ],
+ 'CatalogName' => [
+ 'description' => 'For PostgreSQL-compatible databases, specify the database name.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'hive',
+ 'backendName' => 'catalogName',
+ ],
+ 'DatabaseSearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ 'backendName' => 'databaseSearchName',
+ ],
+ 'SchemaName' => [
+ 'description' => 'Database name (for PostgreSQL-compatible databases, specify the schema name). You can call the [SearchDatabase](~~141876~~) operation to query the name of the database.'."\n"
+ ."\n"
+ .'> You can also call the [ListDatabases](~~141873~~) operation to query the SchemaName of a physical database or call the [ListLogicDatabases](~~141874~~) operation to query the SchemaName of a logical database.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'test_schema',
+ 'backendName' => 'schemaName',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. Valid values include but are not limited to:'."\n"
+ ."\n"
+ .'* **MySQL**'."\n"
+ .'* **SQLServer**'."\n"
+ .'* **PostgreSQL**'."\n"
+ .'* **Oracle**'."\n"
+ .'* **DRDS**'."\n"
+ .'* **OceanBase**'."\n"
+ .'* **Mongo**'."\n"
+ .'* **Redis**'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ 'backendName' => 'dbType',
+ ],
+ ],
+ ],
+ 'open_struct_DLTableInput' => [
+ 'description' => 'The information about the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The owner of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ 'backendName' => 'owner',
+ ],
+ 'ViewOriginalText' => [
+ 'description' => 'The original text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewOriginalText',
+ ],
+ 'TableType' => [
+ 'description' => 'The type of the metadata table. Valid values: MANAGED_TABLE, EXTERNAL_TABLE, VIRTUAL_VIEW, INDEX_TABLE, and MATERIALIZED_VIEW.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'EXTERNAL_TABLE',
+ 'backendName' => 'tableType',
+ ],
+ 'Parameters' => [
+ 'description' => 'The key-value pairs.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'description' => 'The key-value pair.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "EXTERNAL": "TRUE",'."\n"
+ .' "delta.minReaderVersion": "1"}',
+ ],
+ 'backendName' => 'parameters',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'test',
+ 'backendName' => 'description',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '8***',
+ 'backendName' => 'creatorId',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the table was created.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1731586286',
+ 'backendName' => 'createTime',
+ ],
+ 'StorageDescriptor' => [
+ 'title' => 'storageDescriptor',
+ 'description' => 'The description of data storage, including the storage characteristics and format of the table.'."\n",
+ 'visibility' => 'Public',
+ 'backendName' => 'storageDescriptor',
+ '$ref' => '#/components/schemas/DLStorageDescriptor',
+ ],
+ 'LastAccessTime' => [
+ 'description' => 'The time when the table was last accessed.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1608707407',
+ 'backendName' => 'lastAccessTime',
+ ],
+ 'Retention' => [
+ 'description' => 'The retention period of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ 'backendName' => 'retention',
+ ],
+ 'Name' => [
+ 'title' => 'name',
+ 'description' => 'The table name.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '100g_customer',
+ 'backendName' => 'name',
+ ],
+ 'OwnerType' => [
+ 'description' => 'The type of the owner. Valid values: USER, ROLE, and GROUP.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'USER',
+ 'backendName' => 'ownerType',
+ ],
+ 'ViewExpandedText' => [
+ 'description' => 'The expanded text of the view if the table type is view.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '""',
+ 'backendName' => 'viewExpandedText',
+ ],
+ 'PartitionKeys' => [
+ 'description' => 'The column attributes of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the columns.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DLColumn',
+ ],
+ 'backendName' => 'partitionKeys',
+ ],
+ 'ModifierId' => [
+ 'description' => 'The ID of the user who last modified the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1410769',
+ 'backendName' => 'modifierId',
+ ],
+ 'Location' => [
+ 'description' => 'The storage path of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'oss://xxx',
+ 'backendName' => 'location',
+ ],
+ ],
+ ],
+ 'PartitionError' => [
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorDetail' => [
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'auth failed',
+ 'backendName' => 'errorDetail',
+ ],
+ 'Values' => [
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => 'part_val1'."\n",
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'values',
+ ],
+ ],
+ ],
+ 'TableKnowledgeInfo' => [
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The table name.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'tableName',
+ ],
+ 'Description' => [
+ 'description' => 'Table description in the CREAT TABLE statement.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'description',
+ ],
+ 'AssetDescription' => [
+ 'description' => 'Table usage instructions, which are not editable in OpenAPI.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'assetDescription',
+ ],
+ 'Summary' => [
+ 'description' => 'Table business description, which can be edited via EditMetaKnowledgeAsset.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'summary',
+ ],
+ 'ColumnList' => [
+ 'description' => 'The columns of the table.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The columns of the table.'."\n",
+ 'visibility' => 'Public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/ColumnKnowledgeInfo',
+ ],
+ 'backendName' => 'columnList',
+ ],
+ 'AssetModifiedGmt' => [
+ 'description' => 'Last modified time.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'backendName' => 'assetModifiedGmt',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'DeleteUser' => [
+ 'summary' => 'Deletes an Alibaba Cloud account that is no longer used.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. '."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](https://www.alibabacloud.com/help/en/data-management-service/latest/manage-dms-tenants) topic.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique ID (UID) of Alibaba Cloud account to delete.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified user not exists.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF402235-C6CB-52B7-953A-33C100078D15\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"The specified user not exists.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteUser',
+ 'description' => 'The effect of deleting a user by calling this operation is the same as that of deleting a user by choosing System Management > User Management in the DMS Enterprise console. The administrator of DMS Enterprise can call this operation to delete a user that is no longer used from DMS Enterprise. After the user is deleted, the data source permission, data owner configuration, and database administrator (DBA) configuration of the corresponding Alibaba Cloud account or Resource Access Management (RAM) user are revoked and become invalid.'."\n"
+ ."\n"
+ .'> This operation only removes the association of the Alibaba Cloud account or RAM user with DMS Enterprise of the enterprise, rather than actually deleting the Alibaba Cloud account or RAM user. After the user is deleted, the Alibaba Cloud account or RAM user cannot log on to DMS Enterprise, unless the user is added to DMS Enterprise again.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateUser' => [
+ 'summary' => 'Updates user information.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud unique ID (UID) of the user to update.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123456789',
+ ],
+ ],
+ [
+ 'name' => 'UserNick',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RoleNames',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The roles that the user assumes. For more information about the valid values, see the Request parameters section in the [UpdateUser](~~465812~~) topic.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ADMIN,DBA',
+ ],
+ ],
+ [
+ 'name' => 'Mobile',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DingTalk ID or mobile number of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '188xxxxxxxx',
+ ],
+ ],
+ [
+ 'name' => 'MaxExecuteCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum number of queries that can be performed each day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'MaxResultCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum number of rows that can be queried each day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'UidString',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the String type. If you specify this parameter, the UID of the Long type is replaced.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '322824****:dmstest.wu@A201***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E9BEBF41-4F69-4605-A5D5-A67955173941',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request succeeded.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9BEBF41-4F69-4605-A5D5-A67955173941\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E9BEBF41-4F69-4605-A5D5-A67955173941</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateUser',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DisableUser' => [
+ 'summary' => 'Disables a user that is temporarily not used in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified user not exists.',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"The specified user not exists.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableUserResponse>\\n <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>\\n <Success>true</Success>\\n</DisableUserResponse>","errorExample":""}]',
+ 'title' => 'DisableUser',
+ 'description' => 'The effect of disabling a user by calling this operation is the same as that of disabling a user by choosing System Management > User Management in the DMS Enterprise console. The administrator of DMS Enterprise can call this operation to disable a user that is temporarily not used in DMS Enterprise. After the user is disabled, the data source permission, data owner configuration, and database administrator (DBA) configuration of the corresponding Alibaba Cloud account or Resource Access Management (RAM) user are revoked and become invalid.'."\n"
+ ."\n"
+ .'> This operation only stops the Alibaba Cloud account or RAM user from logging on to DMS Enterprise of the enterprise, rather than actually disabling the Alibaba Cloud account or RAM user. After the user is disabled, the Alibaba Cloud account or RAM user cannot log on to DMS Enterprise, unless the user is enabled again. The disabled user, however, still exists in DMS Enterprise.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'EnableUser' => [
+ 'summary' => 'Enables a user that is disabled.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To obtain the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Tenant information](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails. ',
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified user not exists.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"The specified user not exists.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableUserResponse>\\n <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>\\n <Success>true</Success>\\n</EnableUserResponse>","errorExample":""}]',
+ 'title' => 'EnableUser',
+ 'description' => 'The effect of enabling a user by calling this operation is the same as that of enabling a user by choosing System Management > User Management in the DMS Enterprise console. The administrator of DMS Enterprise can call this operation to enable a user that has been disabled in DMS Enterprise. After the user is enabled, the corresponding Alibaba Cloud account or Resource Access Management (RAM) user can continue to log on to DMS Enterprise and perform relevant operations.'."\n"
+ ."\n"
+ .'> This operation only enables the Alibaba Cloud account or RAM user to log on to DMS Enterprise of the enterprise and perform relevant operations, rather than granting other permissions to the Alibaba Cloud account or RAM user.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListUsers' => [
+ 'summary' => 'Queries the details of users.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '12582',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Role',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The role that is assigned to the user. Valid values:'."\n"
+ ."\n"
+ .'* **USER**: a regular user.'."\n"
+ .'* **DBA** : a database administrator (DBA).'."\n"
+ .'* **ADMIN**: a Data Management (DMS) administrator.'."\n"
+ .'* **SECURITY_ADMIN**: a security administrator.'."\n"
+ .'* **STRUCT_READ_ONLY**: a schema read-only user.'."\n"
+ ."\n"
+ .'> To check your role, move the pointer over the profile picture in the upper-right corner of the DMS console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'DBA',
+ 'enum' => [
+ 'DBA',
+ 'ADMIN',
+ 'USER',
+ 'SECURITY_ADMIN',
+ 'STRUCT_READ_ONLY',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UserState',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the user. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The user is normal.'."\n"
+ .'* **DISABLE**: The user is disabled.'."\n"
+ .'* **DELETE**: The user is deleted.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'NORMAL',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The search keyword. Fuzzy match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'Valid values: 10, 20, 50, and 100.**** Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '69161997-6030-53BA-A333-DBEC83B732FF',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidTid',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Specified parameter Tid is not valid.',
+ ],
+ 'UserList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'User' => [
+ 'description' => 'The details of users.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'State' => [
+ 'description' => 'The status of the user. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The user is normal.'."\n"
+ .'* **DISABLE**: The user is disabled.'."\n"
+ .'* **DELETE**: The user is deleted.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'CurResultCount' => [
+ 'description' => 'The number of rows that were queried on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '8****',
+ ],
+ 'LastLoginTime' => [
+ 'description' => 'The time when the user last logged on to the console.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-08 13:43:43',
+ ],
+ 'MaxResultCount' => [
+ 'description' => 'The maximum number of rows that can be queried on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '50000',
+ ],
+ 'ParentUid' => [
+ 'description' => 'The ID of the Alibaba Cloud account of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '140692647406****',
+ ],
+ 'RoleIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RoleIds' => [
+ 'description' => 'The IDs of the roles.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the role that is assigned to the user. Valid values:'."\n"
+ ."\n"
+ .'* **1**: a regular user role.'."\n"
+ .'* **2**: a DBA role.'."\n"
+ .'* **3**: a DMS administrator role.'."\n"
+ .'* **4**: a security administrator role.'."\n"
+ .'* **6**: a schema read-only user role.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ ],
+ ],
+ ],
+ 'RoleNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RoleNames' => [
+ 'description' => 'The names of roles.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the role that is assigned to the user. Valid values:'."\n"
+ ."\n"
+ .'* **USER**: a regular user.'."\n"
+ .'* **DBA** : a DBA.'."\n"
+ .'* **ADMIN**: a DMS administrator.'."\n"
+ .'* **SECURITY_ADMIN**: a security administrator.'."\n"
+ .'* **STRUCT_READ_ONLY**: a schema read-only user.'."\n",
+ 'type' => 'string',
+ 'example' => 'ADMIN',
+ ],
+ ],
+ ],
+ ],
+ 'NickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_NickName',
+ ],
+ 'MaxExecuteCount' => [
+ 'description' => 'The maximum number of queries that can be performed on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2000',
+ ],
+ 'CurExecuteCount' => [
+ 'description' => 'The number of queries that were performed on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'Mobile' => [
+ 'description' => 'The mobile phone number of the user.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if you have set a mobile phone number in the console. To set a mobile phone number in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if you have not set a mobile phone number.'."\n",
+ 'type' => 'string',
+ 'example' => '1389999****',
+ ],
+ 'Uid' => [
+ 'description' => 'The ID of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '167382665015****',
+ ],
+ 'Email' => [
+ 'description' => 'The email address that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if you have set an email address in the console. To set an email address in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if you have not set an email address.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'DingRobot' => [
+ 'description' => 'The DingTalk chatbot URL that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if you have set a DingTalk chatbot URL in the console. To set a DingTalk chatbot URL in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if you have not set a DingTalk chatbot URL.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef',
+ ],
+ 'Webhook' => [
+ 'description' => 'The webhook URL that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If you have set a webhook URL, DMS sends notifications to the specified URL.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if you have not set a webhook URL.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://dms-XXX.aliyun.com:8***',
+ ],
+ 'SignatureMethod' => [
+ 'description' => 'The signature method that is used to secure connections when a webhook URL is used. Valid values:'."\n"
+ ."\n"
+ .'* **NONE**: no signature.'."\n"
+ .'* **HMAC_SHA1**: HMAC_SHA1.'."\n",
+ 'type' => 'string',
+ 'example' => 'HMAC_SHA1',
+ ],
+ 'NotificationMode' => [
+ 'description' => 'The notification method. The system returns one or more values. Valid values:'."\n"
+ ."\n"
+ .'* **SMS**: text message'."\n"
+ .'* **EMAIL**: email.'."\n"
+ .'* **DINGDING**: DingTalk.'."\n"
+ .'* **DINGROBOT**: DingTalk chatbot.'."\n"
+ .'* **WEBHOOK**: webhook.'."\n",
+ 'type' => 'string',
+ 'example' => 'DINGROBOT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"69161997-6030-53BA-A333-DBEC83B732FF\\",\\n \\"ErrorCode\\": \\"InvalidTid\\",\\n \\"ErrorMessage\\": \\"Specified parameter Tid is not valid.\\",\\n \\"UserList\\": {\\n \\"User\\": [\\n {\\n \\"State\\": \\"NORMAL\\",\\n \\"CurResultCount\\": 0,\\n \\"UserId\\": \\"8****\\",\\n \\"LastLoginTime\\": \\"2021-11-08 13:43:43\\",\\n \\"MaxResultCount\\": 50000,\\n \\"ParentUid\\": \\"140692647406****\\",\\n \\"RoleIdList\\": {\\n \\"RoleIds\\": [\\n 3\\n ]\\n },\\n \\"RoleNameList\\": {\\n \\"RoleNames\\": [\\n \\"ADMIN\\"\\n ]\\n },\\n \\"NickName\\": \\"test_NickName\\",\\n \\"MaxExecuteCount\\": 2000,\\n \\"CurExecuteCount\\": 0,\\n \\"Mobile\\": \\"1389999****\\",\\n \\"Uid\\": \\"167382665015****\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"DingRobot\\": \\"https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef\\",\\n \\"Webhook\\": \\"http://dms-XXX.aliyun.com:8***\\",\\n \\"SignatureMethod\\": \\"HMAC_SHA1\\",\\n \\"NotificationMode\\": \\"DINGROBOT\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListUsersResponse>\\n <TotalCount>3</TotalCount>\\n <RequestId>69161997-6030-53BA-A333-DBEC83B732FF</RequestId>\\n <UserList>\\n <User>\\n <NotificationMode/>\\n <Email>test1_email</Email>\\n <RoleNameList>\\n <RoleNames>USER</RoleNames>\\n <RoleNames>ADMIN</RoleNames>\\n </RoleNameList>\\n <NickName>王女士</NickName>\\n <MaxExecuteCount>2000</MaxExecuteCount>\\n <CurResultCount>0</CurResultCount>\\n <LastLoginTime>2022-11-23 16:03:10</LastLoginTime>\\n <Uid>23236106758310****</Uid>\\n <RoleIdList>\\n <RoleIds>1</RoleIds>\\n <RoleIds>3</RoleIds>\\n </RoleIdList>\\n <MaxResultCount>50000</MaxResultCount>\\n <State>NORMAL</State>\\n <UserId>13***</UserId>\\n <CurExecuteCount>0</CurExecuteCount>\\n <ParentUid>140692647406****</ParentUid>\\n </User>\\n <User>\\n <NotificationMode/>\\n <Email>test2_email</Email>\\n <RoleNameList>\\n <RoleNames>ADMIN</RoleNames>\\n <RoleNames>USER</RoleNames>\\n </RoleNameList>\\n <NickName>王先生</NickName>\\n <MaxExecuteCount>2000</MaxExecuteCount>\\n <CurResultCount>0</CurResultCount>\\n <LastLoginTime>2022-11-17 14:50:22</LastLoginTime>\\n <Uid>26984203785603****</Uid>\\n <RoleIdList>\\n <RoleIds>3</RoleIds>\\n <RoleIds>1</RoleIds>\\n </RoleIdList>\\n <MaxResultCount>10000</MaxResultCount>\\n <State>NORMAL</State>\\n <UserId>12****</UserId>\\n <CurExecuteCount>0</CurExecuteCount>\\n <ParentUid>140692647406****</ParentUid>\\n </User>\\n <User>\\n <NotificationMode/>\\n <Email>[email protected]</Email>\\n <RoleNameList>\\n <RoleNames>USER</RoleNames>\\n <RoleNames>ADMIN</RoleNames>\\n </RoleNameList>\\n <NickName>test_NickName</NickName>\\n <MaxExecuteCount>2000</MaxExecuteCount>\\n <CurResultCount>0</CurResultCount>\\n <LastLoginTime>2021-07-09 18:48:57</LastLoginTime>\\n <Uid>167382665015****</Uid>\\n <RoleIdList>\\n <RoleIds>1</RoleIds>\\n <RoleIds>3</RoleIds>\\n </RoleIdList>\\n <MaxResultCount>10000</MaxResultCount>\\n <State>NORMAL</State>\\n <UserId>8****</UserId>\\n <CurExecuteCount>0</CurExecuteCount>\\n <Webhook>http://****.aliyun.com:8080</Webhook>\\n <SignatureMethod>HMAC_SHA1</SignatureMethod>\\n <DingRobot>https://****.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78****</DingRobot>\\n <ParentUid>140692647406****</ParentUid>\\n </User>\\n </UserList>\\n <Success>true</Success>\\n</ListUsersResponse>","errorExample":""}]',
+ 'title' => 'ListUsers',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetUser' => [
+ 'summary' => 'Queries the information about a user.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account. You can view your UID by moving the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '22973492647626****',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [ListUsers](~~141938~~) operation to query the ID of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'User' => [
+ 'description' => 'The information about the user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'State' => [
+ 'description' => 'The status of the user. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The user is normal.'."\n"
+ .'* **DISABLE**: The user is disabled.'."\n"
+ .'* **DELETE**: The user is deleted.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'CurResultCount' => [
+ 'description' => 'The number of rows that are queried on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '28',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'LastLoginTime' => [
+ 'description' => 'The last point in time when the user logged on to the console.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-08 11:26:21',
+ ],
+ 'MaxResultCount' => [
+ 'description' => 'The maximum number of rows that can be queried on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ParentUid' => [
+ 'description' => 'The UID of the Alibaba Cloud account of the user.'."\n"
+ ."\n"
+ .'> An Alibaba Cloud account can contain one or more RAM users.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '140692647406****',
+ ],
+ 'RoleIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RoleIds' => [
+ 'description' => 'The list of role IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the role that is assigned to the user. Valid values:'."\n"
+ ."\n"
+ .'* **1**: a regular user role.'."\n"
+ .'* **2**: a database administrator (DBA) role.'."\n"
+ .'* **3**: a DMS administrator role.'."\n"
+ .'* **4**: a security administrator role.'."\n"
+ .'* **6**: a schema read-only user role.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'RoleNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RoleNames' => [
+ 'description' => 'The list of role names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the role that is assigned to the user. Valid values:'."\n"
+ ."\n"
+ .'* **USER**: a regular user.'."\n"
+ .'* **DBA** : a DBA.'."\n"
+ .'* **ADMIN**: a DMS administrator.'."\n"
+ .'* **SECURITY_ADMIN**: a security administrator.'."\n"
+ .'* **STRUCT_READ_ONLY**: a schema read-only user.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER',
+ ],
+ ],
+ ],
+ ],
+ 'NickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'User_NickName',
+ ],
+ 'MaxExecuteCount' => [
+ 'description' => 'The maximum number of queries that can be performed on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2000',
+ ],
+ 'CurExecuteCount' => [
+ 'description' => 'The number of queries that are performed on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'Mobile' => [
+ 'description' => 'The mobile number of the user.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if the user has set a mobile phone number in the console. To set a mobile phone number in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if the user has not set a mobile phone number.'."\n",
+ 'type' => 'string',
+ 'example' => '1389223****',
+ ],
+ 'Uid' => [
+ 'description' => 'The UID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '22275482072787****',
+ ],
+ 'Email' => [
+ 'description' => 'The email address that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if the user has set an email address in the console. To set an email address in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if the user has not set an email address.'."\n",
+ 'type' => 'string',
+ 'example' => 'Uesr_email',
+ ],
+ 'DingRobot' => [
+ 'description' => 'The DingTalk chatbot URL that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The system returns this parameter if the user has set a DingTalk chatbot URL in the console. To set a DingTalk chatbot URL in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to **Notice**.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if the user has not set a DingTalk chatbot URL.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://XXX.dingtalk.com/robot/send?access_token=***',
+ ],
+ 'Webhook' => [
+ 'description' => 'The webhook URL that is used to receive notifications.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the user has set a webhook URL, DMS sends notifications to the specified URL.'."\n"
+ ."\n"
+ .'* The system does not return this parameter if the user has not set a webhook URL.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://dms-XXX.aliyun.com:8***',
+ ],
+ 'SignatureMethod' => [
+ 'description' => 'The signature method that is used to secure connections when a webhook URL is used. Valid values:'."\n"
+ ."\n"
+ .'* **NONE**: no signature.'."\n"
+ .'* **HMAC_SHA1**: HMAC_SHA1.'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE',
+ ],
+ 'NotificationMode' => [
+ 'description' => 'The notification method. The system returns one or more values. Valid values:'."\n"
+ ."\n"
+ .'* **SMS**: text message'."\n"
+ .'* **EMAIL**: email.'."\n"
+ .'* **DINGDING**: DingTalk.'."\n"
+ .'* **DINGROBOT**: DingTalk chatbot.'."\n"
+ .'* **WEBHOOK**: webhook.'."\n",
+ 'type' => 'string',
+ 'example' => 'EMAIL',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '804BB128-CAFA-5DD0-BA1E-43DDE488****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unknown server error',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"State\\": \\"NORMAL\\",\\n \\"CurResultCount\\": 28,\\n \\"UserId\\": \\"51****\\",\\n \\"LastLoginTime\\": \\"2021-11-08 11:26:21\\",\\n \\"MaxResultCount\\": 10000,\\n \\"ParentUid\\": 0,\\n \\"RoleIdList\\": {\\n \\"RoleIds\\": [\\n 1\\n ]\\n },\\n \\"RoleNameList\\": {\\n \\"RoleNames\\": [\\n \\"USER\\"\\n ]\\n },\\n \\"NickName\\": \\"User_NickName\\",\\n \\"MaxExecuteCount\\": 2000,\\n \\"CurExecuteCount\\": 3,\\n \\"Mobile\\": \\"1389223****\\",\\n \\"Uid\\": \\"22275482072787****\\",\\n \\"Email\\": \\"Uesr_email\\",\\n \\"DingRobot\\": \\"https://XXX.dingtalk.com/robot/send?access_token=***\\",\\n \\"Webhook\\": \\"http://dms-XXX.aliyun.com:8***\\",\\n \\"SignatureMethod\\": \\"NONE\\",\\n \\"NotificationMode\\": \\"EMAIL\\"\\n },\\n \\"RequestId\\": \\"804BB128-CAFA-5DD0-BA1E-43DDE488****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetUserResponse>\\n <User>\\n <NotificationMode/>\\n <Email>Uesr_email</Email>\\n <RoleNameList>\\n <RoleNames>USER</RoleNames>\\n <RoleNames>ADMIN</RoleNames>\\n </RoleNameList>\\n <NickName>User_NickName</NickName>\\n <MaxExecuteCount>2000</MaxExecuteCount>\\n <CurResultCount>28</CurResultCount>\\n <LastLoginTime>2021-11-09 13:39:21</LastLoginTime>\\n <Uid>22275482072787****</Uid>\\n <RoleIdList>\\n <RoleIds>1</RoleIds>\\n <RoleIds>3</RoleIds>\\n </RoleIdList>\\n <MaxResultCount>10000</MaxResultCount>\\n <State>NORMAL</State>\\n <UserId>51****</UserId>\\n <CurExecuteCount>3</CurExecuteCount>\\n <ParentUid>140692647406****</ParentUid>\\n </User>\\n <RequestId>804BB128-CAFA-5DD0-BA1E-43DDE488****</RequestId>\\n <Success>true</Success>\\n</GetUserResponse>","errorExample":""}]',
+ 'title' => 'GetUser',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetUserActiveTenant' => [
+ 'summary' => 'Queries details of the active tenant.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Tenant' => [
+ 'description' => 'The details of the tenant.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the tenant. Valid values:'."\n"
+ ."\n"
+ .'* **ACTIVE**: The tenant is used to access DMS.'."\n"
+ .'* **IN_ACTIVE**: The tenant is not used.'."\n",
+ 'type' => 'string',
+ 'example' => 'ACTIVE',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ 'TenantName' => [
+ 'description' => 'The name of the tenant.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'TenantNotExist',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified tenant does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tenant\\": {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"Tid\\": 0,\\n \\"TenantName\\": \\"test_name\\"\\n },\\n \\"RequestId\\": \\"4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2\\",\\n \\"ErrorCode\\": \\"TenantNotExist\\",\\n \\"ErrorMessage\\": \\"The specified tenant does not exist.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetUserActiveTenantResponse>\\n <Tenant>\\n <Status>ACTIVE</Status>\\n <TenantName>test_name</TenantName>\\n <Tid>3***</Tid>\\n </Tenant>\\n <RequestId>4B63CAC5-BD7F-5C7C-82C9-59DFFBC3****</RequestId>\\n <Success>true</Success>\\n</GetUserActiveTenantResponse>","errorExample":""}]',
+ 'title' => 'GetUserActiveTenant',
+ ],
+ 'ListUserTenants' => [
+ 'summary' => 'Queries tenants.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C478D9DA-3615-50F6-A2BC-7855AD65****',
+ ],
+ 'TenantList' => [
+ 'description' => 'The details of the tenants that were returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the tenant. Valid values:'."\n"
+ ."\n"
+ .'* **ACTIVE**: The tenant is used to access DMS.'."\n"
+ .'* **IN_ACTIVE**: The tenant is not used.'."\n",
+ 'type' => 'string',
+ 'example' => 'ACTIVE',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ 'TenantName' => [
+ 'description' => 'The name of the tenant.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'TenantNotExist',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified tenant does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C478D9DA-3615-50F6-A2BC-7855AD65****\\",\\n \\"TenantList\\": [\\n {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"Tid\\": 0,\\n \\"TenantName\\": \\"test_name\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"TenantNotExist\\",\\n \\"ErrorMessage\\": \\"The specified tenant does not exist.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListUserTenantsResponse>\\n <RequestId>C478D9DA-3615-50F6-A2BC-7855AD65****</RequestId>\\n <TenantList>\\n <Status>ACTIVE</Status>\\n <TenantName>test_name</TenantName>\\n <Tid>3***</Tid>\\n </TenantList>\\n <Success>true</Success>\\n</ListUserTenantsResponse>","errorExample":""}]',
+ 'title' => 'ListUserTenants',
+ ],
+ 'RegisterUser' => [
+ 'summary' => 'Adds a user of your enterprise.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To query ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account of the user that you want to register.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345678',
+ ],
+ ],
+ [
+ 'name' => 'UserNick',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'dmstest',
+ ],
+ ],
+ [
+ 'name' => 'RoleNames',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The role that you want to assign to the user. Valid values:'."\n"
+ ."\n"
+ .'* **USER**: a regular user role'."\n"
+ .'* **DBA**: a database administrator (DBA) role'."\n"
+ .'* **ADMIN**: a DMS administrator role'."\n"
+ .'* **SECURITY_ADMIN**: a security administrator role'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the regular user role is assigned to the user by default. You can assign one or more roles to the user. Separate multiple roles with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'USER,DBA',
+ ],
+ ],
+ [
+ 'name' => 'Mobile',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The mobile number of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '130000000xx',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified user already exists.',
+ ],
+ 'Success' => [
+ 'description' => '* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"The specified user already exists.\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"HostId\\": \\"dms-enterprise.aliyuncs.com\\",\\n \\"Code\\": \\"UserExisted\\",\\n \\"Message\\": \\"The specified user already exists.\\"\\n}"},{"type":"xml","example":"<RegisterUserResponse>\\n <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>\\n <Success>true</Success>\\n</RegisterUserResponse>\\n","errorExample":"<Error>\\n <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>\\n <HostId>dms-enterprise.aliyuncs.com</HostId>\\n <Code>UserExisted</Code>\\n <Message>The specified user already exists.</Message>\\n</Error>"}]',
+ 'title' => 'RegisterUser',
+ 'description' => 'If you are an **administrator** in Data Management (DMS), you can call this operation to register a user for your enterprise. To view users that are assigned the administrator role, perform the following steps: Log on to the DMS console. In the top navigation bar, click O&M. In the left-side navigation pane, click User.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'AddInstance' => [
+ 'summary' => 'Adds a database instance to Data Management (DMS) and enable security hosting for the instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '201773',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> You can move the pointer over the profile picture in the upper-right corner of the DMS console to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '23****',
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database instance. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'InstanceSource',
+ 'in' => 'query',
+ 'schema' => [
+ '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 instance that is deployed on an Elastic Compute Service (ECS) instance.'."\n"
+ .'* **VPC_IDC**: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC).'."\n"
+ .'* **GATEWAY**: a database instance connected by using a database gateway.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'RDS',
+ ],
+ ],
+ [
+ 'name' => 'NetworkType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The network type. Valid values:'."\n"
+ ."\n"
+ .'* **CLASSIC:** the classic network.'."\n"
+ .'* **VPC**'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'VPC',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment to which the database instance belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product:** the production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'EcsInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. If your instance is a database instance connected by using a database gateway, specify the gateway ID for this parameter.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to ECS_OWN or GATEWAY.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-2zei9gs1t7h8l7ac****',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance connected over a VPC.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-2zef4o1hu7ljd****',
+ ],
+ ],
+ [
+ 'name' => 'EcsRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region in which the ECS instance resides.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to RDS, ECS_OWN, GATEWAY, or VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The endpoint that is used to connect to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '172.XX.XXX.254',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port that is used to connect to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database instance.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceType is set to ORACLE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testSid',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'testsdb',
+ ],
+ ],
+ [
+ 'name' => 'DatabasePassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the database account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceAlias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the database instance. Specify an alias that can help you identify the database instance in DMS.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'DbaId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who assumes the database administrator (DBA) role. You can call the [ListUsers](~~141938~~) or [GetInstance](~~141567~~) operation to obtain the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '27****',
+ ],
+ ],
+ [
+ 'name' => 'QueryTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for querying data from the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7200',
+ ],
+ ],
+ [
+ 'name' => 'ExportTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for exporting data from the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '86400',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellTrust',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启安全托管模式'."\n"
+ .'- NULL或其它：不开启安全托管模式',
+ 'description' => 'Specifies whether to enable the security hosting feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: enables the security hosting feature for the database instance.'."\n"
+ .'* N: disables the security hosting feature for the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellStable',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启稳定变更'."\n"
+ .'- NULL或其它：不开启稳定变更',
+ 'description' => 'Specifies whether to enable Stable Change for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: Enables Stable Change.'."\n"
+ .'* N: Disables Stable Change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NULL',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellCommon',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启安全协同'."\n"
+ .'- NULL或其它：不开启安全协同',
+ 'description' => 'Specifies whether to enable Security Collaboration for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: enables Security Collaboration.'."\n"
+ .'* N: disables Security Collaboration.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'SafeRule',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '仅在开启安全协同后有效，实例的安全规则集（GroupName），可通过调用接口ListStandardGroups或GetInstance获取该参数的值。',
+ 'description' => 'The name of the security rule set for the database instance. This parameter is required if Security Collaboration is enabled. You can call the[ListStandardGroups](~~465940~~) or [GetInstance](~~465826~~) operation to obtain the name of the security rule set from GroupName.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellSitd',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启敏感数据保护'."\n"
+ .'- NULL或其它：不开启敏感数据保护',
+ 'description' => 'Specifies whether to enable sensitive data protection. Valid values:'."\n"
+ ."\n"
+ .'* Y: enables the sensitive data protection feature for the database instance.'."\n"
+ .'* N: disables the sensitive data protection feature for the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'DataLinkName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database link for cross-database queries.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This property must be specified when UseDsql is set to 1.'."\n"
+ ."\n"
+ .'* The name can contain only lowercase letters and underscores (\\_).'."\n"
+ ."\n"
+ .'* The name must be unique within a tenant.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dblink_test',
+ ],
+ ],
+ [
+ 'name' => 'DdlOnline',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable Lock-free Schema Change. Valid values:'."\n"
+ ."\n"
+ .'* **0**: does not enable lock-free schema change.'."\n"
+ .'* **1**: uses the native online DDL operations of MySQL first.'."\n"
+ .'* **2:** uses lock-free schema change first.'."\n"
+ ."\n"
+ .'> Supported databases include ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB MyBase for MySQL, and third-party MySQL databases.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UseDsql',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable cross-database query for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0: does not enable cross-database query.**'."\n"
+ .'* **1**: enables cross-database query.'."\n"
+ ."\n"
+ .'> Supported databases include MySQL, SQL Server, PostgreSQL, PolarDB for Oracle, and Redis.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'SkipTest',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the connectivity test. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板ID，可从ListClassificationTemplates获取',
+ 'description' => 'The ID of the classification and grading template. You can call the [ListClassificationTemplates](~~465947~~) operation to query the template ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '31***',
+ ],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板类型，可从ListClassificationTemplates获取',
+ 'description' => 'The type of the classification and grading template. You can call the [ListClassificationTemplates](~~465947~~) operation to query the template type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INNER',
+ ],
+ ],
+ [
+ 'name' => 'UseSsl',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to allow Data Management Service (DMS) to connect to the database instance by using SSL connections. Before you use SSL connections, make sure that the SSL encryption feature is enabled for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0** (default): DMS automatically checks whether self-negotiation is enabled for the database instance. DMS automatically checks whether the SSL encryption feature is enabled for the database instance. If the SSL encryption feature is enabled, DMS connects to the database instance by using SSL connections. Otherwise, DMS connects to the database instance without encryption.'."\n"
+ .'* **1**: DMS connects to the database instance by using SSL connections. This value is invalid if the SSL encryption feature is disabled for the database instance.'."\n"
+ .'* **-1**: DMS does not connect to the database instance by using SSL connections.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is available only for a MySQL or Redis database instance.'."\n"
+ ."\n"
+ .'* SSL encrypts network connections at the transport layer to improve the security and integrity of data in transmission. However, SSL increases the response time of network connections.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1',
+ 'minimum' => '-1',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'RoleArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '跨租户 arn',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AddInstance',
+ 'description' => 'You must be a database administrator (DBA) or a DMS administrator. For more information, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'ModifyInstance' => [
+ 'summary' => 'Modifies the basic and advanced information about a database instance in Data Management (DMS). The basic information includes the hosting mode of the instance, the instance account username and password, and features that are enabled for the instance. The advanced information includes the environment type, the instance name in DMS, and the timeout period for querying and exporting data.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '201929',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '183****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> You can move the pointer over the profile picture in the upper-right corner of the DMS console to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '23****'."\n",
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database instance. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'InstanceSource',
+ 'in' => 'query',
+ 'schema' => [
+ '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 instance that is deployed on an Elastic Compute Service (ECS) instance.'."\n"
+ .'* **VPC_IDC**: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'RDS',
+ ],
+ ],
+ [
+ 'name' => 'NetworkType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The network type of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **CLASSIC**: the classic network.'."\n"
+ .'* **VPC**: VPC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'VPC',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'dev',
+ ],
+ ],
+ [
+ 'name' => 'EcsInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ECS instance.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to ECS_OWN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-2zei9gs1t7h8l7ac****',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The VPC ID.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-bp10wnlcmor****',
+ ],
+ ],
+ [
+ 'name' => 'EcsRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region in which the ECS instance resides.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to RDS, ECS_OWN, or VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The endpoint that is used to connect to the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '192.XXX.0.56',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port that is used to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database instance.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceType is set to ORACLE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testSid',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The account that is used to log on to the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'testsdb'."\n",
+ ],
+ ],
+ [
+ 'name' => 'DatabasePassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the account that is used to log on to the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test***'."\n",
+ ],
+ ],
+ [
+ 'name' => 'InstanceAlias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the database instance. Specify an alias that can help you quickly identify the database instance in Data Management (DMS).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'instance_test',
+ ],
+ ],
+ [
+ 'name' => 'DbaId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who assumes the database administrator (DBA) role. You can call the [ListUsers](~~141938~~) or [GetInstance](~~141567~~) operation to obtain the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '27****',
+ ],
+ ],
+ [
+ 'name' => 'QueryTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for querying data from the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '7200',
+ ],
+ ],
+ [
+ 'name' => 'ExportTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for exporting data from the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '86400',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellTrust',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启安全托管模式'."\n"
+ .'- NULL或其它：不开启安全托管模式',
+ 'description' => 'Specifies whether to enable the security hosting feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: Enable.'."\n"
+ .'* N: Disable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellStable',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启稳定变更'."\n"
+ .'- NULL或其它：不开启稳定变更',
+ 'description' => 'Specifies whether to enable Stable Change for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: Enable.'."\n"
+ .'* N: Disable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NULL',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellCommon',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启安全协同'."\n"
+ .'- NULL或其它：不开启安全协同',
+ 'description' => 'Specifies whether to enable Security Collaboration for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* Y: Enable.'."\n"
+ .'* N: Disable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'SafeRule',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '仅在开启安全协同后有效，实例的安全规则集（GroupName），可通过调用接口ListStandardGroups或GetInstance获取该参数的值。',
+ 'description' => 'The name of the security rule set for the database instance. This parameter is required if Security Collaboration is enabled. You can call the[ListStandardGroups](~~465940~~) or [GetInstance](~~465826~~) operation to obtain the name of the security rule set from GroupName.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellSitd',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启敏感数据保护'."\n"
+ .'- NULL或其它：不开启敏感数据保护',
+ 'description' => 'Specifies whether to enable sensitive data protection. Valid values:'."\n"
+ ."\n"
+ .'* Y: Enable.'."\n"
+ .'* N: Disable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'DataLinkName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database link for cross-database queries.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This property must be specified when UseDsql is set to 1.'."\n"
+ ."\n"
+ .'* The name can contain only lowercase letters and underscores (\\_).'."\n"
+ ."\n"
+ .'* The name must be unique within a tenant.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dblink_test',
+ ],
+ ],
+ [
+ 'name' => 'DdlOnline',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable lock-free schema change. Valid values:'."\n"
+ ."\n"
+ .'* **0**: Disable Lock-free Schema Change.'."\n"
+ .'* **1**: MySQL native online DDL first.'."\n"
+ .'* **2**: DMS native online DDL first.'."\n"
+ ."\n"
+ .'> Supported databases include ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB MyBase for MySQL, and third-party MySQL databases.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UseDsql',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable cross-instance query for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: Disables cross-database query.'."\n"
+ .'* **1**: Enables cross-database query.'."\n"
+ ."\n"
+ .'> Supported databases include MySQL, SQL Server, PostgreSQL, PolarDB for Oracle, and Redis.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'SkipTest',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the connectivity test. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板ID，可从ListClassificationTemplates获取',
+ 'description' => 'The ID of the classification and grading template. You can call the [ListClassificationTemplates](~~465947~~) operation to query the template ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '31***',
+ ],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板类型，可从ListClassificationTemplates获取',
+ 'description' => 'The type of the classification and grading template. You can call the [ListClassificationTemplates](~~465947~~) operation to query the template type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INNER',
+ ],
+ ],
+ [
+ 'name' => 'UseSsl',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Specifies whether to allow Data Management Service (DMS) to connect to the database instance by using SSL connections. Before you use SSL connections, make sure that the SSL encryption feature is enabled for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0** (default): DMS automatically checks whether self-negotiation is enabled for the database instance. DMS automatically checks whether the SSL encryption feature is enabled for the database instance. If the SSL encryption feature is enabled, DMS connects to the database instance by using SSL connections. Otherwise, DMS connects to the database instance without encryption.'."\n"
+ .'* **1**: DMS connects to the database instance by using SSL connections. This value is invalid if the SSL encryption feature is disabled for the database instance.'."\n"
+ .'* **-1**: DMS does not connect to the database instance by using SSL connections.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is available only for a MySQL or Redis database instance.'."\n"
+ ."\n"
+ .'* SSL encrypts network connections at the transport layer to improve the security and integrity of data in transmission. However, SSL increases the response time of network connections.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1',
+ 'minimum' => '-1',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ModifyInstance',
+ ],
+ 'ListInstances' => [
+ 'summary' => 'Queries the information about database instances.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsVESC4E',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for database instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment to which the database instance belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product:** production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: pre-release environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: system integration testing (SIT) environment'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag:** staging environment'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'InstanceSource',
+ 'in' => 'query',
+ 'schema' => [
+ '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 deployed on an Elastic Compute Service (ECS) instance'."\n"
+ .'* **VPC_IDC**: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'RDS',
+ ],
+ ],
+ [
+ 'name' => 'NetType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The network type of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **CLASSIC:** classic network'."\n"
+ .'* **VPC:** VPC'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'VPC',
+ ],
+ ],
+ [
+ 'name' => 'InstanceState',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**'."\n"
+ .'* **DISABLE**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NORMAL',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. The number cannot exceed 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'Region',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of database instances that are returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C4E04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'InstanceList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Instance' => [
+ 'description' => 'The information about the database instances that are returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'VpcId' => [
+ 'description' => 'The ID of the VPC to which the database instance belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'vpc-o6wrloqsdqc9io3mg****',
+ ],
+ 'DatabaseUser' => [
+ 'description' => 'The account that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'dbUser',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the database administrator (DBA) of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '31****',
+ ],
+ 'UseDsql' => [
+ 'description' => 'Indicates whether the cross-database query feature is enabled for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: disabled'."\n"
+ .'* **1:**: enabled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Port' => [
+ 'description' => 'The port number that is used to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'EcsInstanceId' => [
+ 'description' => 'The ID of the ECS instance on which the database instance is deployed.'."\n",
+ 'type' => 'string',
+ 'example' => '150****',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product:** production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: pre-release environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: SIT environment'."\n"
+ .'* **uat**: UAT environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag:** staging environment'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'Sid' => [
+ 'description' => 'The system ID (SID) of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the database instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '123453',
+ ],
+ ],
+ ],
+ ],
+ 'SafeRuleId' => [
+ 'description' => 'The ID of the security rule set of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the owners of the database instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the owner of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang_test',
+ ],
+ ],
+ ],
+ ],
+ 'DbaNickName' => [
+ 'description' => 'The nickname of the DBA of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'dbaName',
+ ],
+ 'QueryTimeout' => [
+ 'description' => 'The timeout period for querying data in the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ 'InstanceSource' => [
+ 'description' => 'The source of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'RDS',
+ ],
+ 'Host' => [
+ 'description' => 'The host address that is used to connect to the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '****.mysql.rds.aliyuncs.com',
+ ],
+ 'State' => [
+ 'description' => 'The status of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'DataLinkName' => [
+ 'description' => 'The name of the database link for the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'dblink_test',
+ ],
+ 'ExportTimeout' => [
+ 'description' => 'The timeout period for exporting data from the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '86400',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '150***',
+ ],
+ 'InstanceType' => [
+ 'description' => 'The type of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'DatabasePassword' => [
+ 'description' => 'The password that is used to log on to the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '******',
+ ],
+ 'InstanceAlias' => [
+ 'description' => 'The alias of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DdlOnline' => [
+ 'description' => 'Indicates whether the lock-free schema change feature is enabled for the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'EcsRegion' => [
+ 'description' => 'The ID of the region in which the database instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The control mode of the database instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'description' => 'The name of the security rule corresponding to the control mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The type of the control mode. Valid values:'."\n"
+ ."\n"
+ .'* **COMMON**: Security Collaboration'."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ ],
+ ],
+ 'SellSitd' => [
+ 'title' => '为true，敏感数据保护开启，否则未开启',
+ 'description' => 'Indicates whether the sensitive data protection feature is enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SellTrust' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C4E04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"InstanceList\\": {\\n \\"Instance\\": [\\n {\\n \\"VpcId\\": \\"vpc-o6wrloqsdqc9io3mg****\\",\\n \\"DatabaseUser\\": \\"dbUser\\",\\n \\"DbaId\\": \\"31****\\",\\n \\"UseDsql\\": 1,\\n \\"Port\\": 3306,\\n \\"EcsInstanceId\\": \\"150****\\",\\n \\"EnvType\\": \\"product\\",\\n \\"Sid\\": \\"test\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"12****\\"\\n ]\\n },\\n \\"SafeRuleId\\": \\"1\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"yuyang_test\\"\\n ]\\n },\\n \\"DbaNickName\\": \\"dbaName\\",\\n \\"QueryTimeout\\": 60,\\n \\"InstanceSource\\": \\"RDS\\",\\n \\"Host\\": \\"****.mysql.rds.aliyuncs.com\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"DataLinkName\\": \\"dblink_test\\",\\n \\"ExportTimeout\\": 86400,\\n \\"InstanceId\\": \\"150***\\",\\n \\"InstanceType\\": \\"mysql\\",\\n \\"DatabasePassword\\": \\"******\\",\\n \\"InstanceAlias\\": \\"test\\",\\n \\"DdlOnline\\": 1,\\n \\"EcsRegion\\": \\"cn-hangzhou\\",\\n \\"StandardGroup\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"GroupMode\\": \\"COMMON\\"\\n },\\n \\"SellSitd\\": true,\\n \\"SellTrust\\": \\"\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListInstancesResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>\\n <InstanceList>\\n <VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>\\n <DatabaseUser>dbUser</DatabaseUser>\\n <DbaId>31****</DbaId>\\n <UseDsql>1</UseDsql>\\n <Port>3306</Port>\\n <EcsInstanceId>150****</EcsInstanceId>\\n <EnvType>product</EnvType>\\n <Sid>test</Sid>\\n <OwnerIdList>123453</OwnerIdList>\\n <SafeRuleId>1</SafeRuleId>\\n <OwnerNameList>yuyang_test</OwnerNameList>\\n <DbaNickName>dbaName</DbaNickName>\\n <QueryTimeout>60</QueryTimeout>\\n <InstanceSource>RDS</InstanceSource>\\n <Host>****.mysql.rds.aliyuncs.com</Host>\\n <State>NORMAL</State>\\n <DataLinkName>dblink_test</DataLinkName>\\n <ExportTimeout>86400</ExportTimeout>\\n <InstanceId>150***</InstanceId>\\n <InstanceType>mysql</InstanceType>\\n <DatabasePassword>******</DatabasePassword>\\n <InstanceAlias>test</InstanceAlias>\\n <DdlOnline>1</DdlOnline>\\n <EcsRegion>cn-hangzhou</EcsRegion>\\n <StandardGroup>\\n <GroupName>test</GroupName>\\n <GroupMode>COMMON</GroupMode>\\n </StandardGroup>\\n <SellSitd>true</SellSitd>\\n </InstanceList>\\n <Success>true</Success>\\n</ListInstancesResponse>","errorExample":""}]',
+ 'title' => 'ListInstances',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstance' => [
+ 'summary' => 'Queries the details of a database instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2***',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The endpoint of the database instance. You can call the [ListInstances](~~141936~~) operation to obtain the endpoint.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '172.17.XXX.XXX',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port number that is used to connect to the database instance. You can call the [ListInstances](~~141936~~) operation to obtain the port number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '5432',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database instance. You can call the [ListInstances](~~141936~~) operation to obtain the SID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F6C80B69-3203-56AC-8021-18BA72A6F4E1',
+ ],
+ 'Instance' => [
+ 'description' => 'The details of the database instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'VpcId' => [
+ 'description' => 'The ID of the virtual private cloud (VPC) to which the database instance belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'vpc-o6wrloqsdqc9io3mg****',
+ ],
+ 'DatabaseUser' => [
+ 'description' => 'The account that is used to log on to the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'dbuser',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the database administrator (DBA) for the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '29****',
+ ],
+ 'UseDsql' => [
+ 'description' => 'Indicates whether the cross-database query feature is enabled for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: disabled'."\n"
+ .'* **1**: enabled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Port' => [
+ 'description' => 'The port number that is used to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5432',
+ ],
+ 'EcsInstanceId' => [
+ 'description' => 'The ID of the Elastic Compute Service (ECS) instance on which the database instance is deployed.'."\n",
+ 'type' => 'string',
+ 'example' => 'i-bp124ldpklqz59y3****',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: staging environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: system integration testing (SIT) environment'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag**: STAG environment'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Sid' => [
+ 'description' => 'The SID of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners for the database instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the instance Owner.',
+ 'type' => 'string',
+ 'example' => '10****',
+ ],
+ ],
+ ],
+ ],
+ 'SafeRuleId' => [
+ 'description' => 'The ID of the security rule set for the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '3****',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the owners for the database instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the instance Owner.',
+ 'type' => 'string',
+ 'example' => 'yang_test',
+ ],
+ ],
+ ],
+ ],
+ 'DbaNickName' => [
+ 'description' => 'The nickname of the DBA for the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'dbaname',
+ ],
+ 'QueryTimeout' => [
+ 'description' => 'The timeout period for querying data in the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7200',
+ ],
+ 'InstanceSource' => [
+ 'description' => 'The source of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'ECS_OWN',
+ ],
+ 'Host' => [
+ 'description' => 'The host address that is used to connect to the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.XXX.XXX',
+ ],
+ 'State' => [
+ 'description' => 'The status of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: normal'."\n"
+ .'* **DISABLE**: disabled'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'DataLinkName' => [
+ 'description' => 'The name of the database link for the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ExportTimeout' => [
+ 'description' => 'The timeout period for exporting data from the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '86400',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => '188****',
+ ],
+ 'InstanceType' => [
+ 'description' => 'The type of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'postgresql',
+ ],
+ 'DatabasePassword' => [
+ 'description' => 'The password that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'example' => '******',
+ ],
+ 'InstanceAlias' => [
+ 'description' => 'The alias of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DdlOnline' => [
+ 'description' => 'Indicates whether the lock-free schema change feature is enabled for the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'EcsRegion' => [
+ 'description' => 'The ID of the region in which the database instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-beijing',
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The control mode of the database instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'description' => 'The name of the security rule set corresponding to the control mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'test group name',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The type of the control mode. Valid values:'."\n"
+ ."\n"
+ .'* **COMMON**: Security Collaboration'."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE_CONTROL',
+ ],
+ ],
+ ],
+ 'SellSitd' => [
+ 'title' => '为true，敏感数据保护开启，否则未开启',
+ 'description' => 'Whether sensitive data protection is enabled. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Enable.'."\n"
+ ."\n"
+ .'- **false**: Close.',
+ 'type' => 'string',
+ 'example' => 'false',
+ ],
+ 'SellTrust' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F6C80B69-3203-56AC-8021-18BA72A6F4E1\\",\\n \\"Instance\\": {\\n \\"VpcId\\": \\"vpc-o6wrloqsdqc9io3mg****\\",\\n \\"DatabaseUser\\": \\"dbuser\\",\\n \\"DbaId\\": \\"29****\\",\\n \\"UseDsql\\": 0,\\n \\"Port\\": 5432,\\n \\"EcsInstanceId\\": \\"i-bp124ldpklqz59y3****\\",\\n \\"EnvType\\": \\"test\\",\\n \\"Sid\\": \\"test\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"10****\\"\\n ]\\n },\\n \\"SafeRuleId\\": \\"3****\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"yang_test\\"\\n ]\\n },\\n \\"DbaNickName\\": \\"dbaname\\",\\n \\"QueryTimeout\\": 7200,\\n \\"InstanceSource\\": \\"ECS_OWN\\",\\n \\"Host\\": \\"192.168.XXX.XXX\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"DataLinkName\\": \\"test\\",\\n \\"ExportTimeout\\": 86400,\\n \\"InstanceId\\": \\"188****\\",\\n \\"InstanceType\\": \\"postgresql\\",\\n \\"DatabasePassword\\": \\"******\\",\\n \\"InstanceAlias\\": \\"测试\\",\\n \\"DdlOnline\\": 0,\\n \\"EcsRegion\\": \\"cn-beijing\\",\\n \\"StandardGroup\\": {\\n \\"GroupName\\": \\"自由操作\\",\\n \\"GroupMode\\": \\"NONE_CONTROL\\"\\n },\\n \\"SellSitd\\": \\"false\\",\\n \\"SellTrust\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceResponse>\\n <RequestId>F6C80B69-3203-56AC-8021-18BA72A6F4E1</RequestId>\\n <Instance>\\n <Port>5432</Port>\\n <DatabasePassword>******</DatabasePassword>\\n <ExportTimeout>86400</ExportTimeout>\\n <EnvType>test</EnvType>\\n <DbaId>12****</DbaId>\\n <InstanceAlias>测试</InstanceAlias>\\n <EcsRegion>cn-beijing</EcsRegion>\\n <InstanceType>postgresql</InstanceType>\\n <QueryTimeout>7200</QueryTimeout>\\n <DataLinkName>dbl_postgresql_2</DataLinkName>\\n <SafeRuleId>3****</SafeRuleId>\\n <SellSitd>false</SellSitd>\\n <InstanceSource>ECS_OWN</InstanceSource>\\n <StandardGroup>\\n <GroupName>自由操作</GroupName>\\n <GroupMode>NONE_CONTROL</GroupMode>\\n </StandardGroup>\\n <InstanceId>188****</InstanceId>\\n <Host>172.17.XXX.XXX</Host>\\n <DdlOnline>0</DdlOnline>\\n <UseDsql>0</UseDsql>\\n <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>\\n <State>NORMAL</State>\\n <DatabaseUser>postgres</DatabaseUser>\\n <OwnerNameList>\\n <OwnerNames>yang_test</OwnerNames>\\n </OwnerNameList>\\n <DbaNickName>dbaname</DbaNickName>\\n <OwnerIdList>\\n <OwnerIds>10****</OwnerIds>\\n </OwnerIdList>\\n </Instance>\\n <Success>true</Success>\\n</GetInstanceResponse>","errorExample":""}]',
+ 'title' => 'GetInstance',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteInstance' => [
+ 'summary' => 'Removes a database instance from Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The endpoint of the database instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to obtain the endpoint.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'xxx.mysql.rds.aliyuncs.com',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port number that is used to connect to the database instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to obtain the port number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to obtain the SID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testSid',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C4E04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C4E04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteInstanceResponse>\\n <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>\\n <Success>true</Success>\\n</DeleteInstanceResponse>","errorExample":""}]',
+ 'title' => 'DeleteInstance',
+ 'description' => 'Note: You can call this operation only to remove a database instance from the instance list of DMS. The instance is not deleted or shut down.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RegisterInstance' => [
+ 'summary' => 'Registers a database instance in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'InstanceSource',
+ 'in' => 'query',
+ 'schema' => [
+ '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 deployed on an Elastic Compute Service (ECS) instance'."\n"
+ .'* **VPC_IDC:** a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'RDS',
+ ],
+ ],
+ [
+ 'name' => 'NetworkType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The network type of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **CLASSIC:** classic network'."\n"
+ .'* **VPC:** VPC'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'VPC',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment'."\n"
+ .'* dev: development environment'."\n"
+ .'* pre: pre-release environment'."\n"
+ .'* test: test environment'."\n"
+ .'* sit: system integration testing (SIT) environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment'."\n"
+ .'* pet: stress testing environment'."\n"
+ .'* stag: staging environment'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'EcsInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ECS instance on which the database instance is deployed.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceSource parameter is set to ECS_OWN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-2zei9gs1t7h8l7ac****',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the VPC to which the database instance belongs.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceSource parameter is set to VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-xxxxxxxxxxxxxxxxxxxxx',
+ ],
+ ],
+ [
+ 'name' => 'EcsRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region in which the database instance resides.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceSource parameter is set to RDS, ECS_OWN, or VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The host address that is used to connect to the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '172.XX.XXX.254',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port that is used to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceType parameter is set to ORACLE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'XXX',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The account that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dmstest',
+ ],
+ ],
+ [
+ 'name' => 'DatabasePassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '******',
+ ],
+ ],
+ [
+ 'name' => 'InstanceAlias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the database instance. Specify an alias that can help you identify the database instance in DMS.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Test instance'."\n",
+ ],
+ ],
+ [
+ 'name' => 'DbaUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who assumes the DBA role of the database instance. You can call the [ListUsers](~~141938~~) or [GetInstance](~~141567~~) operation to query the user ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '22275482072787****',
+ ],
+ ],
+ [
+ 'name' => 'SafeRule',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the security rule set (GroupName) for the database instance. You can call the [ListStandardGroups](~~417891~~) or [GetInstance](~~141567~~) operation to query the name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'QueryTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for querying data in the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '60',
+ ],
+ ],
+ [
+ 'name' => 'ExportTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for exporting data from the database instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '600',
+ ],
+ ],
+ [
+ 'name' => 'DataLinkName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database link for cross-database queries.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is required if UseDsql is set to 1.'."\n"
+ ."\n"
+ .'* The name can contain only lowercase letters and underscores (\\_).'."\n"
+ ."\n"
+ .'* The name must be unique within a tenant.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dblink_test',
+ ],
+ ],
+ [
+ 'name' => 'DdlOnline',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the lock-free schema change feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: disables the lock-free schema change feature.'."\n"
+ .'* **1**: uses the online DDL of MySQL first.'."\n"
+ .'* **2**: uses the lock-free schema change feature of DMS first.'."\n"
+ ."\n"
+ .'> Supported database types: ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB MyBase for MySQL, and third-party MySQL databases.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UseDsql',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the cross-database query feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: disables the cross-database query feature.'."\n"
+ .'* **1**: enables the cross-database query feature.'."\n"
+ ."\n"
+ .'> Supported database types: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible with Oracle), and ApsaraDB for Redis.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'SkipTest',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the connectivity test. Valid values:'."\n"
+ ."\n"
+ .'* **true:** skips the connectivity test'."\n"
+ .'* **false:** does not skip the connectivity test'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellSitd',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启敏感数据保护'."\n"
+ .'- NULL或其它：不开启敏感数据保护',
+ 'description' => '* **Y:** enables the sensitive data protection feature'."\n"
+ .'* **NULL or other:** disables the sensitive data protection feature'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板ID，可从ListClassificationTemplates获取',
+ 'description' => 'The ID of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the template ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '31***',
+ ],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '分类分级模板类型，可从ListClassificationTemplates获取',
+ 'description' => 'The type of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the template type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INNER',
+ ],
+ ],
+ [
+ 'name' => 'DbaUidByString',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用于替换DbaUid字段，可输入角色账号等非数字DbaUid',
+ 'description' => 'The ID of the user who assumes the DBA role of the database instance. If the user ID is a non-numeric value such as a role or an account, you can use this parameter to replace DbaUid.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '22275482072787****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroup',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F4E2A94B-604F-43FF-93E7-F4EE3DCF412E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true:** The request was successful.'."\n"
+ .'* **false:** The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4E2A94B-604F-43FF-93E7-F4EE3DCF412E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RegisterInstanceResponse>\\n <RequestId>F4E2A94B-604F-43FF-93E7-F4EE3DCF412E</RequestId>\\n <Success>true</Success>\\n</RegisterInstanceResponse>","errorExample":""}]',
+ 'title' => 'RegisterInstance',
+ 'description' => 'Prerequisites: You are a DMS administrator or a database administrator (DBA). You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to query your user role from the RoleIdList parameter that is returned.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '### Sample code for SDK for Python'."\n"
+ ."\n"
+ .'The following sample code provides an example on how to register a database instance that is deployed in a data center connected over a VPC.'."\n"
+ ."\n"
+ .' #coding=utf-8'."\n"
+ .' from aliyunsdkcore.client import AcsClient'."\n"
+ .' from aliyunsdkdms_enterprise.request.v20181101.RegisterInstanceRequest import RegisterInstanceRequest'."\n"
+ .' client = AcsClient('."\n"
+ .' "<your-access-key-id>",'."\n"
+ .' "<your-access-key-secret>",'."\n"
+ .' "<your-region-id>"'."\n"
+ .' )'."\n"
+ .' # Example'."\n"
+ .' request = RegisterInstanceRequest()'."\n"
+ .' # The ID of the tenant.'."\n"
+ .' request.set_Tid(1)'."\n"
+ .' # The host address that is used to connect to the database instance.'."\n"
+ .' request.set_Host("192.168.16.113")'."\n"
+ .' # The port that is used to connect to the database instance.'."\n"
+ .' request.set_Port(3314)'."\n"
+ .' # The type of the database. In this example, the parameter is set to MySQL.'."\n"
+ .' request.set_InstanceType("MySQL")'."\n"
+ .' # The source of the database instance. In this example, the parameter is set to VPC_IDC.'."\n"
+ .' request.set_InstanceSource("VPC_IDC")'."\n"
+ .' # The network type of the database instance. In this example, the parameter is set to VPC.'."\n"
+ .' request.set_NetworkType("VPC")'."\n"
+ .' request.set_EnvType("PRODUCT")'."\n"
+ .' # request.set_EcsInstanceId()'."\n"
+ .' # The ID of the VPC to which the database instance belongs.'."\n"
+ .' request.set_VpcId("VPC ID of the database instance")'."\n"
+ .' # The ID of the region in which the database instance resides. Example: cn-hangzhou.'."\n"
+ .' request.set_EcsRegion("Region ID of the database instance")'."\n"
+ .' # request.set_Sid();'."\n"
+ .' # The account that is used to log on to the database.'."\n"
+ .' request.set_DatabaseUser("Logon account of the database")'."\n"
+ .' # The password that is used to log on to the database.'."\n"
+ .' request.set_DatabasePassword("Logon password of the database")'."\n"
+ .' # The alias of the database instance. This alias helps you identify the database instance in DMS.'."\n"
+ .' request.set_InstanceAlias("Alias of the database instance")'."\n"
+ .' # The ID of the user who assumes the DBA role of the database instance. The user must be added to DMS Enterprise by using the console or the relevant API operation in advance.'."\n"
+ .' request.set_DbaUid(-1)'."\n"
+ .' request.set_SafeRule("Name of the security rule set that is configured in DMS Enterprise")'."\n"
+ .' request.set_QueryTimeout(60)'."\n"
+ .' request.set_ExportTimeout(600)'."\n"
+ .' response = client.do_action_with_exception(request)'."\n"
+ .' print response'."\n",
+ ],
+ 'UpdateInstance' => [
+ 'summary' => 'Updates the information about a database instance and checks the connectivity of the database instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'InstanceSource',
+ 'in' => 'query',
+ 'schema' => [
+ '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 deployed on an Elastic Compute Service (ECS) instance'."\n"
+ .'* **VPC_IDC:** a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ECS_OWN',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product:** production environment'."\n"
+ .'* **dev:** development environment'."\n"
+ .'* **pre:** pre-release environment'."\n"
+ .'* **test:** test environment'."\n"
+ .'* **sit:** system integration testing (SIT) environment'."\n"
+ .'* **uat:** user acceptance testing (UAT) environment'."\n"
+ .'* **pet:** stress testing environment'."\n"
+ .'* **stag:** staging environment'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'product' => 'product',
+ 'pre' => 'pre',
+ 'dev' => 'dev',
+ 'test' => 'test',
+ ],
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'EcsInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ECS instance on which the database instance is deployed.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceSource parameter is set to ECS_OWN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-2zei9gs1t7h8l7ac****',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the VPC to which the database instance belongs.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceSource parameter is set to VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-xxx',
+ ],
+ ],
+ [
+ 'name' => 'EcsRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region in which the database instance resides.'."\n"
+ ."\n"
+ .'> This parameter is required if InstanceSource is set to RDS, ECS_OWN, and VPC_IDC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The host address that is used to connect to the database instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '192.XXX.0.56',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port that is used to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The system ID (SID) of the database instance.'."\n"
+ ."\n"
+ .'> This parameter is required if the InstanceType parameter is set to ORACLE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'XXX',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The account that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dbuser',
+ ],
+ ],
+ [
+ 'name' => 'DatabasePassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password that is used to log on to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '******',
+ ],
+ ],
+ [
+ 'name' => 'InstanceAlias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the database instance. Specify an alias that can help you identify the database instance in DMS.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'instance_test',
+ ],
+ ],
+ [
+ 'name' => 'DbaId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who assumes the database administrator (DBA) role of the database instance. You can call the [ListUsers](~~141938~~) or [GetInstance](~~141567~~) operation to query the user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '27****',
+ ],
+ ],
+ [
+ 'name' => 'SafeRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the security rule set (GroupName) for the instance. You can call the [ListStandardGroups](~~417891~~) or [GetInstance](~~141567~~) operation to query the name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'QueryTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for querying data in the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '60',
+ ],
+ ],
+ [
+ 'name' => 'ExportTimeout',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The timeout period for exporting data from the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '600',
+ ],
+ ],
+ [
+ 'name' => 'DataLinkName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database link for cross-database queries.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is required if UseDsql is set to 1.'."\n"
+ ."\n"
+ .'* The name can contain only lowercase letters and underscores (\\_).'."\n"
+ ."\n"
+ .'* The name must be unique within a tenant.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'datalink_test',
+ ],
+ ],
+ [
+ 'name' => 'DdlOnline',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the lock-free schema change feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0:** disables the lock-free schema change feature.'."\n"
+ .'* **1**: uses the online DDL of MySQL first.'."\n"
+ .'* **2**: uses the lock-free schema change feature of DMS first.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UseDsql',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the cross-database query feature for the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **0**: disables the cross-database query feature.'."\n"
+ .'* **1**: enables the cross-database query feature.'."\n"
+ ."\n"
+ .'> Supported database types: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible with Oracle), and ApsaraDB for Redis.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database instance. You can call the [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '126****',
+ ],
+ ],
+ [
+ 'name' => 'SkipTest',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the connectivity test. Valid values:'."\n"
+ ."\n"
+ .'* **true:** skips the connectivity test'."\n"
+ .'* **false:** does not skip the connectivity test'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EnableSellSitd',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '- Y：开启敏感数据保护'."\n"
+ .'- N：关闭敏感数据保护'."\n"
+ .'- 为NULL或其它：不更新敏感数据保护的状态（保持原始的开启或关闭状态）',
+ 'description' => '* **Y:** enables the sensitive data protection feature'."\n"
+ .'* **N:** disables the sensitive data protection feature'."\n"
+ .'* **NULL or other:** does not update the status of the sensitive data protection feature'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Y',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '更新分类分级模板ID，可从ListClassificationTemplates获取',
+ 'description' => 'The ID of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the template ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '更新分类分级模板类型，可从ListClassificationTemplates获取',
+ 'description' => 'The type of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the template type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INNER',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E9BEBF41-4F69-4605-A5D5-A67955173941',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true:** The request was successful.'."\n"
+ .'* **false:** The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9BEBF41-4F69-4605-A5D5-A67955173941\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E9BEBF41-4F69-4605-A5D5-A67955173941</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateInstance',
+ 'description' => 'Before you call the UpdateInstance operation, call the [GetInstance](~~141567~~) or [ListInstances](~~141936~~) operation to obtain the complete information about the instance.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SimplyAddInstance' => [
+ 'summary' => 'This operation is suitable for special scenarios and is not recommended. To register an instance with DMS, we recommend that you call the AddInstance operation first.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '201773',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rm****',
+ ],
+ ],
+ [
+ 'name' => 'InstanceRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '192.XXX.0.56',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '5432',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabasePassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Instance' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '188****',
+ ],
+ 'Host' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '192.168.XXX.XXX',
+ ],
+ 'Port' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5432',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"188****\\",\\n \\"Host\\": \\"192.168.XXX.XXX\\",\\n \\"Port\\": \\"5432\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'SimplyAddInstance',
+ ],
+ 'GetOpLog' => [
+ 'summary' => 'Queries the details of operation logs that are generated in a specified period of time.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Module',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The functional module for which you want to query operation logs. If you do not specify this parameter, operation logs for all functional modules are returned. Valid values:'."\n"
+ ."\n"
+ .'* **PERMISSION**: permissions'."\n"
+ .'* **OWNER**: data owner'."\n"
+ .'* **SQL_CONSOLE**: data query'."\n"
+ .'* **SQL_CONSOLE_EXPORT**: query result export'."\n"
+ .'* **DATA_CHANGE**: data change'."\n"
+ .'* **DATA_EXPORT**: data export'."\n"
+ .'* **SQL_REVIEW**: SQL review'."\n"
+ .'* **DT_SYNC**: database and table synchronization'."\n"
+ .'* **DT_DETAIL**: database and table details'."\n"
+ .'* **DB_TASK**: task management'."\n"
+ .'* **INSTANCE_MANAGE**: instance management'."\n"
+ .'* **USER_MANAGE**: user management'."\n"
+ .'* **SECURITY_RULE**: security rules'."\n"
+ .'* **CONFIG_MANAGE**: configuration management'."\n"
+ .'* **RESOURCE_AUTH**: resource authorization'."\n"
+ .'* **ACCESS_WHITE_IP**: access IP address whitelist'."\n"
+ .'* **NDDL**: schema design'."\n"
+ .'* **DSQL_CONSOLE**: cross-database data query'."\n"
+ .'* **DSQL_CONSOLE_EXPORT**: cross-database query result export'."\n"
+ .'* **DATA_TRACT**: data tracking'."\n"
+ .'* **DATA_QUALITY**: data quality'."\n"
+ .'* **DATALINK_MANAGE** :DBLink management'."\n"
+ .'* **DATASEC_MANAGE**: sensitive data management'."\n"
+ .'* **SELL**: sales'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SECURITY_RULE',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2022-03-23 10:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2022-03-29 10:00:00',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Valid values:'."\n"
+ ."\n"
+ .'* 30'."\n"
+ .'* 50'."\n"
+ .'* 100'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'UserNick',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'UserNick.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_name',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'DatabaseName.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dmstest@rm-bp1qb97d4b****.mysql.rds.aliyuncs.com:3306[poc_dev]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of operation logs that are returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '47D56208-DB1D-4FD3-BE32-300E43185488',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'OpLogDetails' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OpLogDetail' => [
+ 'description' => 'The details of the operation log.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the operation log.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Module' => [
+ 'description' => 'The functional module for which the operation log is queried.'."\n",
+ 'type' => 'string',
+ 'example' => 'SECURITY_RULE'."\n",
+ ],
+ 'Database' => [
+ 'description' => 'The endpoint of the database instance.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is valid only for database instances of the LocalInstance type.'."\n"
+ ."\n"
+ .'* This parameter is valid only for operations on the functional modules related to tasks.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]... \\[Test instance]'."\n",
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '22275482072787****',
+ ],
+ 'OpUserId' => [
+ 'description' => 'The ID of the user who performed the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ 'OpContent' => [
+ 'description' => 'The details of the operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT * FROM `orders` \\n LIMIT 20',
+ ],
+ 'UserNick' => [
+ 'description' => 'The display name of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ 'OrderId' => [
+ 'description' => 'The ID of the ticket or task.'."\n"
+ ."\n"
+ .'> This parameter is valid only for operations on the functional modules related to tasks and the task management module in system management.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '509****',
+ ],
+ 'OpTime' => [
+ 'description' => 'The time when the operation was performed.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-03-28 16:45:19',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"47D56208-DB1D-4FD3-BE32-300E43185488\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"OpLogDetails\\": {\\n \\"OpLogDetail\\": [\\n {\\n \\"Module\\": \\"安全规则\\",\\n \\"Database\\": \\"dmstest@rm-bp1qb97d4b****.mysql.rds.aliyuncs.com:3306【poc_dev】\\",\\n \\"UserId\\": \\"22275482072787****\\",\\n \\"OpUserId\\": 0,\\n \\"OpContent\\": \\"SELECT * FROM `orders` \\\\\\\\n LIMIT 20\\",\\n \\"UserNick\\": \\"test_name\\",\\n \\"OrderId\\": 0,\\n \\"OpTime\\": \\"2022-03-28 16:45:19\\"\\n }\\n ]\\n },\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOpLogResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>47D56208-DB1D-4FD3-BE32-300E43185488</RequestId>\\n <OpLogDetails>\\n <OpUserId>51****</OpUserId>\\n <UserId>22275482072787****</UserId>\\n <Database>[email protected]...【测试实例】</Database>\\n <OpContent>SELECT * FROM `orders` \\\\n LIMIT 20</OpContent>\\n <UserNick>test_name</UserNick>\\n <Module>安全规则</Module>\\n <OpTime>2022-03-28 16:39:44</OpTime>\\n </OpLogDetails>\\n <Success>true</Success>\\n</GetOpLogResponse>","errorExample":""}]',
+ 'title' => 'GetOpLog',
+ 'description' => 'Prerequisites: You are an administrator of Data Management (DMS) or a security administrator. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to obtain your user role from the RoleIdList parameter that is returned.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## SDK sample code'."\n"
+ ."\n"
+ .'For more information about how to call this operation by using an SDK, see [Alibaba Cloud SDK for Python](~~315437~~).'."\n"
+ ."\n"
+ .'Sample code:'."\n"
+ ."\n"
+ .' from aliyunsdkcore.client import AcsClient'."\n"
+ .' from aliyunsdkdms_enterprise.request.v20181101.GetOpLogRequest import GetOpLogRequest'."\n"
+ .' client = AcsClient('."\n"
+ .' "<your-access-key-id>",'."\n"
+ .' "<your-access-key-secret>",'."\n"
+ .' "<your-region-id>"'."\n"
+ .' )'."\n"
+ .' request = GetOpLogRequest()'."\n"
+ .' request.set_Tid("The tenant ID of your enterprise")'."\n"
+ .' request.set_StartTime("2018-11-20 00:00:00")'."\n"
+ .' request.set_EndTime("2018-11-23 00:00:00")'."\n"
+ .' request.set_PageNumber(1)'."\n"
+ .' request.set_PageSize(50)'."\n"
+ .' response = client.do_action_with_exception(request)'."\n"
+ .' print response'."\n",
+ ],
+ 'ListInstanceLoginAuditLog' => [
+ 'summary' => 'Queries the logon records of an instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query.'."\n"
+ ."\n"
+ .'> The start time supports fuzzy match. Specify the time in the YYYY-MM-DD hh:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-11-18 11:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query.'."\n"
+ ."\n"
+ .'> The end time supports fuzzy match. Specify the time in the YYYY-MM-DD hh:mm:ss format. We recommend that you use the StartTime and EndTime parameters to specify a time range that does not exceed one day. This way, the returned entries can be displayed by page to increase query efficiency.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-11-18 18:00:00',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database or instance whose logon records you want to query.'."\n"
+ ."\n"
+ .'> If SQL statements are executed at the instance level, you can set this parameter to an instance name. If SQL statements are executed at the database level, you can set this parameter to a database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_SearchName',
+ ],
+ ],
+ [
+ 'name' => 'OpUserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_OpUserName',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '20',
+ 'default' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '074CE7C9-4F9C-5B62-89BC-7B4914A3****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidPageSize',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Specified parameter PageSize is not valid.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'InstanceLoginAuditLogList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceLoginAuditLog' => [
+ 'description' => 'The logon records of the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpTime' => [
+ 'description' => 'The time when the user performed an operation on the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-18 11:13:26',
+ ],
+ 'UserName' => [
+ 'description' => 'The alias of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_UserName',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'InstanceName' => [
+ 'description' => 'The name of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306[rm-bp144d5ky4l4r****]',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '177****',
+ ],
+ 'DbUser' => [
+ 'description' => 'The database account that is used to log on to the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_User',
+ ],
+ 'RequestIp' => [
+ 'description' => 'The source IP address of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '117.36.XX.XX,100.104.XX.XX',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"074CE7C9-4F9C-5B62-89BC-7B4914A3****\\",\\n \\"ErrorCode\\": \\"InvalidPageSize\\",\\n \\"ErrorMessage\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"Success\\": true,\\n \\"InstanceLoginAuditLogList\\": {\\n \\"InstanceLoginAuditLog\\": [\\n {\\n \\"OpTime\\": \\"2021-11-18 11:13:26\\",\\n \\"UserName\\": \\"test_UserName\\",\\n \\"UserId\\": 0,\\n \\"InstanceName\\": \\"rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306【rm-bp144d5ky4l4r****】\\",\\n \\"InstanceId\\": 0,\\n \\"DbUser\\": \\"test_User\\",\\n \\"RequestIp\\": \\"117.36.XX.XX,100.104.XX.XX\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInstanceLoginAuditLogResponse>\\n <InstanceLoginAuditLogList>\\n <InstanceLoginAuditLog>\\n <InstanceName>rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306【rm-bp144d5ky4l4r****】</InstanceName>\\n <UserName>test_UserName</UserName>\\n <InstanceId>177****</InstanceId>\\n <UserId>12****</UserId>\\n <RequestIp>117.36.XX.XX, 100.104.XX.XX</RequestIp>\\n <OpTime>2021-11-18 11:13:26</OpTime>\\n <DbUser>test_User</DbUser>\\n </InstanceLoginAuditLog>\\n </InstanceLoginAuditLogList>\\n <TotalCount>1</TotalCount>\\n <RequestId>074CE7C9-4F9C-5B62-89BC-7B4914A3****</RequestId>\\n <Success>true</Success>\\n</ListInstanceLoginAuditLogResponse>","errorExample":""}]',
+ 'title' => 'ListInstanceLoginAuditLog',
+ ],
+ 'ListProxySQLExecAuditLog' => [
+ 'summary' => 'Queries the audit logs generated by the secure access proxy feature.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. The value of this parameter must be a timestamp that follows the UNIX time format.'."\n",
+ 'docRequired' => true,
+ 'example' => '1636876446000',
+ 'format' => 'int64',
+ 'required' => true,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. The value of this parameter must be a timestamp that follows the UNIX time format.'."\n",
+ 'docRequired' => true,
+ 'example' => '1636962846000',
+ 'format' => 'int64',
+ 'required' => true,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database instance.'."\n",
+ 'example' => 'test',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'OpUserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the user.'."\n",
+ 'example' => 'testNickName',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SQLType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **SELECT**'."\n"
+ .'* **INSERT**'."\n"
+ .'* **DELETE**'."\n"
+ .'* **CREATE_TABLE**'."\n"
+ ."\n"
+ .'> You can choose Operation Audit > Secure Access Proxy in the top navigation bar of the DMS console to view more types of SQL statements.'."\n",
+ 'example' => 'SELECT',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ExecState',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The execution status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **FAIL**: The execution of the SQL statement fails.'."\n"
+ .'* **CANCEL**: The execution of the SQL statement is canceled.'."\n"
+ .'* **SUCCESS**: The SQL statement is executed.'."\n",
+ 'example' => 'SUCCESS',
+ 'required' => false,
+ 'type' => 'string',
+ 'enum' => [
+ 'FAIL',
+ 'SUCCESS',
+ 'CANCEL',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Maximum values: 100.'."\n",
+ 'docRequired' => true,
+ 'example' => '100',
+ 'format' => 'int32',
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'required' => false,
+ 'type' => 'integer',
+ 'default' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'docRequired' => true,
+ 'example' => '1',
+ 'exclusiveMaximum' => false,
+ 'format' => 'int32',
+ 'minimum' => '1',
+ 'required' => false,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'example' => '14****',
+ 'format' => 'int64',
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'required' => false,
+ 'type' => 'integer',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The number of entries returned.'."\n",
+ 'example' => '1',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'example' => '50ECB006-2C35-5FCA-91B9-01987A0B****',
+ 'type' => 'string',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'example' => 'InvalidStartTime',
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'example' => 'Specified parameter StartTime is not valid.',
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'example' => 'true',
+ 'type' => 'boolean',
+ ],
+ 'ProxySQLExecAuditLogList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ProxySQLExecAuditLog' => [
+ 'description' => 'The audit information about the database instance that is provided by the secure access proxy feature.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'properties' => [
+ 'OpTime' => [
+ 'description' => 'The time at which the user executes the SQL statement on the database instance. The value of this parameter must be a timestamp that follows the UNIX time format.'."\n",
+ 'example' => '1636876446000',
+ 'type' => 'string',
+ ],
+ 'UserName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'example' => 'testNickName',
+ 'type' => 'string',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'example' => '4****',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'InstanceName' => [
+ 'description' => 'The name of the database instance.'."\n",
+ 'example' => 'pc-uf662nrg017c6****.mysql.polardb.rds.aliyuncs.com:3306【test】',
+ 'type' => 'string',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the database instance.'."\n",
+ 'example' => '4***',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'example' => 'test_db',
+ 'type' => 'string',
+ ],
+ 'SQLType' => [
+ 'description' => 'The type of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **SELECT**'."\n"
+ .'* **INSERT**'."\n"
+ .'* **DELETE**'."\n"
+ .'* **CREATE_TABLE**'."\n"
+ ."\n"
+ .'> You can choose Operation Audit > Secure Access Proxy in the top navigation bar of the DMS console to view more types of SQL statements.'."\n",
+ 'example' => 'SELECT',
+ 'type' => 'string',
+ ],
+ 'SQL' => [
+ 'description' => 'The SQL statement that was executed.'."\n",
+ 'example' => 'select 1;',
+ 'type' => 'string',
+ ],
+ 'ExecState' => [
+ 'description' => 'The execution status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **FAIL**: The execution of the SQL statement fails.'."\n"
+ .'* **CANCEL**: The execution of the SQL statement is canceled.'."\n"
+ .'* **SUCCESS**: The SQL statement is executed.'."\n",
+ 'example' => 'SUCCESS',
+ 'type' => 'string',
+ ],
+ 'AffectRows' => [
+ 'description' => 'Indicates the total number of rows returned after the SQL statement was executed. If an SELECT SQL statement is executed, the return value of this parameter indicates the total number of the queried data rows.'."\n",
+ 'example' => '1',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'ElapsedTime' => [
+ 'description' => 'The amount of time that is consumed to execute the SQL statement. Unit: milliseconds.'."\n",
+ 'example' => '1324',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'Remark' => [
+ 'description' => 'The description.'."\n",
+ 'example' => 'success',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"50ECB006-2C35-5FCA-91B9-01987A0B****\\",\\n \\"ErrorCode\\": \\"InvalidStartTime\\",\\n \\"ErrorMessage\\": \\"Specified parameter StartTime is not valid.\\",\\n \\"Success\\": true,\\n \\"ProxySQLExecAuditLogList\\": {\\n \\"ProxySQLExecAuditLog\\": [\\n {\\n \\"OpTime\\": \\"1636876446000\\",\\n \\"UserName\\": \\"testNickName\\",\\n \\"UserId\\": 0,\\n \\"InstanceName\\": \\"pc-uf662nrg017c6****.mysql.polardb.rds.aliyuncs.com:3306【test】\\",\\n \\"InstanceId\\": 0,\\n \\"SchemaName\\": \\"test_db\\",\\n \\"SQLType\\": \\"SELECT\\",\\n \\"SQL\\": \\"select 1;\\",\\n \\"ExecState\\": \\"SUCCESS\\",\\n \\"AffectRows\\": 1,\\n \\"ElapsedTime\\": 1324,\\n \\"Remark\\": \\"success\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListProxySQLExecAuditLogResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>50ECB006-2C35-5FCA-91B9-01987A0B****</RequestId>\\n <Success>true</Success>\\n <ProxySQLExecAuditLogList>\\n <OpTime>1636876446000</OpTime>\\n <UserName>testNickName</UserName>\\n <UserId>4****</UserId>\\n <InstanceName>rm-xxx:3306</InstanceName>\\n <InstanceId>4***</InstanceId>\\n <SchemaName>test_db</SchemaName>\\n <SQLType>SELECT</SQLType>\\n <SQL>select 1;</SQL>\\n <ExecState>SUCCESS</ExecState>\\n <AffectRows>1</AffectRows>\\n <ElapsedTime>1324</ElapsedTime>\\n <Remark>success</Remark>\\n </ProxySQLExecAuditLogList>\\n</ListProxySQLExecAuditLogResponse>","errorExample":""}]',
+ 'title' => 'ListProxySQLExecAuditLog',
+ ],
+ 'ListSQLExecAuditLog' => [
+ 'summary' => 'Queries the audit logs of SQL statements that are executed in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query.'."\n"
+ ."\n"
+ .'> The start time supports fuzzy match. Specify the time in the YYYY-MM-DD hh:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-11-08 11:04:00',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query.'."\n"
+ ."\n"
+ .'> The end time supports fuzzy match. Specify the time in the YYYY-MM-DD hh:mm:ss format. We recommend that you use the StartTime and EndTime parameters to specify a time range that does not exceed one day. The returned entries can be displayed by page to improve query efficiency.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-11-08 11:00:00',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database or instance based on which you want to query SQL statements.'."\n"
+ ."\n"
+ .'> If the SQL statements to be queried are at the instance level, you can set this parameter to an instance name. If the SQL statements to be queried are at the database level, you can set this parameter to a database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_SearchName',
+ ],
+ ],
+ [
+ 'name' => 'OpUserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The nickname of the user who wrote the SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_OpUserName',
+ ],
+ ],
+ [
+ 'name' => 'SqlType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **SELECT**: the SQL statement that is used to query data.'."\n"
+ .'* **INSERT**: the SQL statement that is used to insert data.'."\n"
+ .'* **DELETE**: the SQL statement that is used to delete data.'."\n"
+ .'* **CREATE_TABLE**: the SQL statement that is used to create tables.'."\n"
+ ."\n"
+ .'> To view more types of SQL statements, log on to the DMS console and click Security and Specifications. In the left-side navigation pane, click **Operation Audit**. Then, you can view all supported types of SQL statements from the **SQL type** drop-down list.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SELECT',
+ ],
+ ],
+ [
+ 'name' => 'ExecState',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The execution status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **FAIL**: The SQL statement fails to be executed.'."\n"
+ .'* **NOEXE**: The SQL statement has not been executed.'."\n"
+ .'* **RUNNING**: The SQL statement is being executed.'."\n"
+ .'* **CANCEL**: The execution of the SQL statement is canceled.'."\n"
+ .'* **SUCCESS**: The SQL statement is executed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SUCCESS',
+ 'enum' => [],
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. The value cannot exceed 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '20',
+ 'default' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '39BC9C86-95AE-58F2-9862-A7C3D896****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingStartTime',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'StartTime is mandatory for this action.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SQLExecAuditLogList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SQLExecAuditLog' => [
+ 'description' => 'The entries returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpTime' => [
+ 'description' => 'The time when the operation specified by the SQL statement was performed on the instance or database.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-08 11:04:27',
+ ],
+ 'UserName' => [
+ 'description' => 'The nickname of the user who wrote the SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_UserName',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user who wrote the SQL statement.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'InstanceName' => [
+ 'description' => 'The name of the database.'."\n"
+ ."\n"
+ .'> If the SQL statement takes effect on an instance, the name of the instance is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306[polar_qw_test]',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '185***',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'polar123',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2157****',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SQLType' => [
+ 'description' => 'The type of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **SELECT**: the SQL statement that is used to query data.'."\n"
+ .'* **INSERT**: the SQL statement that is used to insert data.'."\n"
+ .'* **DELETE**: the SQL statement that is used to delete data.'."\n"
+ .'* **CREATE_TABLE**: the SQL statement that is used to create tables.'."\n"
+ ."\n"
+ .'> To view more types of SQL statements, log on to the DMS console and click Security and Specifications. In the left-side navigation pane, click **Operation Audit**. Then, you can view all supported types of SQL statements from the **SQL type** drop-down list.'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT',
+ ],
+ 'SQL' => [
+ 'description' => 'The SQL statement that was written.'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC',
+ ],
+ 'ExecState' => [
+ 'description' => 'The execution status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **FAIL**: The SQL statement fails to be executed.'."\n"
+ .'* **NOEXE**: The SQL statement has not been executed.'."\n"
+ .'* **RUNNING**: The SQL statement is being executed.'."\n"
+ .'* **CANCEL**: The execution of the SQL statement is canceled.'."\n"
+ .'* **SUCCESS**: The SQL statement is executed.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'AffectRows' => [
+ 'description' => 'The number of rows affected by the SQL statement. For example, if you execute an SQL statement to query data, the number of retrieved rows is returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'ElapsedTime' => [
+ 'description' => 'The amount of time consumed by the execution of the SQL statement. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '18',
+ ],
+ 'Remark' => [
+ 'description' => 'The comment on the SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"39BC9C86-95AE-58F2-9862-A7C3D896****\\",\\n \\"ErrorCode\\": \\"MissingStartTime\\",\\n \\"ErrorMessage\\": \\"StartTime is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"SQLExecAuditLogList\\": {\\n \\"SQLExecAuditLog\\": [\\n {\\n \\"OpTime\\": \\"2021-11-08 11:04:27\\",\\n \\"UserName\\": \\"test_UserName\\",\\n \\"UserId\\": 0,\\n \\"InstanceName\\": \\"polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】\\",\\n \\"InstanceId\\": 0,\\n \\"SchemaName\\": \\"polar123\\",\\n \\"DbId\\": 0,\\n \\"Logic\\": false,\\n \\"SQLType\\": \\"SELECT\\",\\n \\"SQL\\": \\"SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC\\",\\n \\"ExecState\\": \\"SUCCESS\\",\\n \\"AffectRows\\": 2,\\n \\"ElapsedTime\\": 18,\\n \\"Remark\\": \\"success\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSQLExecAuditLogResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>39BC****-95AE-58F2-9862-A7C3D896****</RequestId>\\n <Success>true</Success>\\n <SQLExecAuditLogList>\\n <SQLExecAuditLog>\\n <UserName>test_UserName</UserName>\\n <InstanceId>185****</InstanceId>\\n <ElapsedTime>18</ElapsedTime>\\n <ExecState>SUCCESS</ExecState>\\n <OpTime>2021-11-08 11:04:27</OpTime>\\n <SQL>SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC</SQL>\\n <Remark/>\\n <InstanceName>polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】</InstanceName>\\n <UserId>12****</UserId>\\n <DbId>2157****</DbId>\\n <Logic>false</Logic>\\n <SQLType>SELECT</SQLType>\\n <SchemaName>polar123</SchemaName>\\n <AffectRows>2</AffectRows>\\n </SQLExecAuditLog>\\n </SQLExecAuditLogList>\\n</ListSQLExecAuditLogResponse>","errorExample":""}]',
+ 'title' => 'ListSQLExecAuditLog',
+ ],
+ 'ListWorkFlowTemplates' => [
+ 'summary' => 'Queries approval templates.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name that is used to query approval templates.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Admin',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '41067071-0243-4AAB-B3CF-4DE6D54F53B4',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'WorkFlowTemplates' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WorkFlowTemplate' => [
+ 'description' => 'The approval templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IsSystem' => [
+ 'description' => 'Indicates whether the approval template is predefined by the system. Valid values:'."\n"
+ ."\n"
+ .'* 1: The approval template is predefined by the system.'."\n"
+ .'* 0: The approval template is not predefined by the system.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WorkflowNodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WorkflowNode' => [
+ 'description' => 'The details of approval nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'description' => 'The description of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the approval node. Valid values:'."\n"
+ ."\n"
+ .'* SYS: The approval node is predefined by the system.'."\n"
+ .'* USER_LIST: The approval node is created by a user.'."\n",
+ 'type' => 'string',
+ 'example' => 'SYS',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Position' => [
+ 'description' => 'The position of the approval node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CreateUserId' => [
+ 'description' => 'The ID of the creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the approval node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the approval template.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Enabled' => [
+ 'description' => 'Indicates whether the approval template is enabled. Valid values:'."\n"
+ ."\n"
+ .'* Y: The approval template is enabled.'."\n"
+ .'* N: The approval template is disabled.'."\n",
+ 'type' => 'string',
+ 'example' => 'Y',
+ ],
+ 'TemplateName' => [
+ 'description' => 'The name of the approval template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Admin',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the approval template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'CreateUserId' => [
+ 'description' => 'The ID of the creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"41067071-0243-4AAB-B3CF-4DE6D54F53B4\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"WorkFlowTemplates\\": {\\n \\"WorkFlowTemplate\\": [\\n {\\n \\"IsSystem\\": 1,\\n \\"WorkflowNodes\\": {\\n \\"WorkflowNode\\": [\\n {\\n \\"Comment\\": \\"test\\",\\n \\"NodeType\\": \\"SYS\\",\\n \\"NodeName\\": \\"test\\",\\n \\"Position\\": 1,\\n \\"CreateUserId\\": 1234,\\n \\"TemplateId\\": 12345,\\n \\"NodeId\\": 123\\n }\\n ]\\n },\\n \\"Comment\\": \\"test\\",\\n \\"Enabled\\": \\"Y\\",\\n \\"TemplateName\\": \\"Admin\\",\\n \\"TemplateId\\": 12345,\\n \\"CreateUserId\\": 1234\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>41067071-0243-4AAB-B3CF-4DE6D54F53B4</RequestId>\\n<Success>true</Success>\\n<WorkFlowTemplates>\\n <WorkFlowTemplate>\\n <Comment>系统定义审批线，仅需管理员审批</Comment>\\n <WorkFlowNodes>\\n <WorkFlowNode>\\n <Comment>系统节点，动态计算，由管理员来完成审批</Comment>\\n <NodeName>Admin</NodeName>\\n <Position>0</Position>\\n <NodeType>SYS</NodeType>\\n <NodeId>3763</NodeId>\\n <TemplateId>6243</TemplateId>\\n </WorkFlowNode>\\n </WorkFlowNodes>\\n <TemplateName>Admin</TemplateName>\\n <Enabled>Y</Enabled>\\n <IsSystem>1</IsSystem>\\n <TemplateId>6243</TemplateId>\\n </WorkFlowTemplate>\\n <WorkFlowTemplate>\\n <Comment>系统定义审批线，先数据Owner审批，再DBA审批，最后Admin审批</Comment>\\n <WorkflowNodes>\\n <WorkFlowNode>\\n <Comment>系统节点，动态计算，由用户操作的资源对应的Owner来完成审批</Comment>\\n <NodeName>Owner</NodeName>\\n <Position>0</Position>\\n <NodeType>SYS</NodeType>\\n <NodeId>3762</NodeId>\\n <TemplateId>6244</TemplateId>\\n </WorkFlowNode>\\n <WorkFlowNode>\\n <Comment>系统节点，动态计算，由用户操作的资源对应的DBA来完成审批</Comment>\\n <NodeName>DBA</NodeName>\\n <Position>0</Position>\\n <NodeType>SYS</NodeType>\\n <NodeId>3761</NodeId>\\n <TemplateId>6244</TemplateId>\\n </WorkFlowNode>\\n <WorkFlowNode>\\n <Comment>系统节点，动态计算，由管理员来完成审批</Comment>\\n <NodeName>Admin</NodeName>\\n <Position>0</Position>\\n <NodeType>SYS</NodeType>\\n <NodeId>3763</NodeId>\\n <TemplateId>6244</TemplateId>\\n </WorkFlowNode>\\n </WorkflowNodes>\\n <TemplateName>Owner--&gt;DBA--&gt;Admin</TemplateName>\\n <Enabled>Y</Enabled>\\n <IsSystem>1</IsSystem>\\n <TemplateId>6244</TemplateId>\\n </WorkFlowTemplate>\\n</WorkFlowTemplates>","errorExample":""}]',
+ 'title' => 'ListWorkFlowTemplates',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListWorkFlowNodes' => [
+ 'summary' => 'Queries approval nodes.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name that is used to search for approval nodes.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'admin',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'CFD8FE00-36D9-4C1B-940D-65A7B73D9066',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'WorkflowNodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WorkflowNode' => [
+ 'description' => 'The details of approval nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'description' => 'The description of the approval template.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CreateUserNickName' => [
+ 'description' => 'The name of the user who creates the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the approval node. Valid values:'."\n"
+ ."\n"
+ .'* SYS: The approval node is predefined by the system.'."\n"
+ .'* USER_LIST: The approval node is created by a user.'."\n",
+ 'type' => 'string',
+ 'example' => 'SYS',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'AuditUsers' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuditUser' => [
+ 'description' => 'The details about approvers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RealName' => [
+ 'description' => 'The real name of the approver.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the approver. The ID is different from the ID of the Alibaba Cloud account of the approver.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'NickName' => [
+ 'description' => 'The nickname of the approver.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateUserId' => [
+ 'description' => 'The ID of the creator. This ID is different from the ID of the Alibaba Cloud account of the creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the approval node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFD8FE00-36D9-4C1B-940D-65A7B73D9066\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"WorkflowNodes\\": {\\n \\"WorkflowNode\\": [\\n {\\n \\"Comment\\": \\"test\\",\\n \\"CreateUserNickName\\": \\"test\\",\\n \\"NodeType\\": \\"SYS\\",\\n \\"NodeName\\": \\"test\\",\\n \\"AuditUsers\\": {\\n \\"AuditUser\\": [\\n {\\n \\"RealName\\": \\"test\\",\\n \\"UserId\\": 123,\\n \\"NickName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"CreateUserId\\": 123,\\n \\"NodeId\\": 123\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<WorkFlowNodes>\\n <WorkflowNode>\\n <Comment>系统节点，动态计算，由管理员来完成审批</Comment>\\n <NodeName>Admin</NodeName>\\n <NodeType>SYS</NodeType>\\n <NodeId>3763</NodeId>\\n <AuditUsers>\\n </AuditUsers>\\n </WorkflowNode>\\n</WorkFlowNodes>\\n<RequestId>CFD8FE00-36D9-4C1B-940D-65A7B73D9066</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListWorkFlowNodes',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SetWorkflowExtraInfo' => [
+ 'summary' => 'Configures whether the operation buttons, such as Agree, Revoke, and Sign, are displayed in the ticket approval section of the DMS console.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '174313',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms25Q07S',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ThirdpartyWorkflowUrl',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The link of approval workflow for third parties.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://xxx',
+ ],
+ ],
+ [
+ 'name' => 'ThirdpartyWorkflowComment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks of approval workflow for third parties.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'WorkflowInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the approval workflow. You can call the [GetOrderBaseInfo](~~144642~~) operation to query the ID of the approval workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '184****',
+ ],
+ ],
+ [
+ 'name' => 'RenderAgree',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the Agree button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:'."\n"
+ ."\n"
+ .'* **true** (default): The Agree button is displayed.'."\n"
+ .'* **false**: The Agree button is not displayed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'RenderReject',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the Reject button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:'."\n"
+ ."\n"
+ .'* **true** (default): The Reject button is displayed.'."\n"
+ .'* **false**: The Reject button is not displayed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'RenderAddApprovalNode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the Sign button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:'."\n"
+ ."\n"
+ .'* **true** (default): The Sign button is displayed.'."\n"
+ .'* **false**: The Sign button is not displayed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'RenderTransfer',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the Forward button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:'."\n"
+ ."\n"
+ .'* **true** (default): The Forward button is displayed.'."\n"
+ .'* **false**: The Forward button is not displayed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'RenderCancel',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the Revoke button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:'."\n"
+ ."\n"
+ .'* **true** (default): The Revoke button is displayed.'."\n"
+ .'* **false**: The Revoke button is not displayed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '8401893F-4235-55D5-B563-7CF7A7D037DE',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the call was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8401893F-4235-55D5-B563-7CF7A7D037DE\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SetWorkflowExtraInfo',
+ ],
+ 'CreateLogicDatabase' => [
+ 'summary' => 'Creates a logical database in Data Management (DMS).',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Alias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The alias of the logical database.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_logic_db',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the physical databases that compose the logical database. You can specify one or more database IDs. You can call the [ListDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listdatabases) or [SearchDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/searchdatabase) operation to query the IDs of the physical databases.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1860****',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. '."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](https://www.alibabacloud.com/help/en/data-management-service/latest/manage-dms-tenants) topic.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ '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',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'LogicDbId' => [
+ 'description' => 'The ID of the logical database.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"LogicDbId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateLogicDatabaseResponse>\\n <LogicDbId>1***</LogicDbId>\\n <RequestId>EFF67767-7D49-5833-8B83-F87C9CBDE33A</RequestId>\\n <Success>true</Success>\\n</CreateLogicDatabaseResponse>","errorExample":""}]',
+ 'title' => 'CreateLogicDatabase',
+ ],
+ 'AddLogicTableRouteConfig' => [
+ 'summary' => 'Adds a routing algorithm to a logical table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical table. You can call the [ListLogicTables](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogictables) operation to query the ID of the logical table.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '4****',
+ ],
+ ],
+ [
+ 'name' => 'RouteKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique key of the routing algorithm. '."\n"
+ ."\n"
+ .'> - You can create a custom unique key for the routing algorithm. No requirements are imposed on custom unique keys.'."\n"
+ .'> - The unique key of the routing algorithm in the same logical table must be unique.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'id-hash-mod16',
+ ],
+ ],
+ [
+ 'name' => 'RouteExpr',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The routing algorithm expression. For more information about how to configure a routing algorithm expression, see [Configure a routing algorithm](https://www.alibabacloud.com/help/en/data-management-service/latest/configure-a-routing-algorithm).',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '#id#%16',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'can not find table, tableId : 11133',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"can not find table, tableId : 11133\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddLogicTableRouteConfigResponse>\\n <RequestId>B43AD641-49C2-5299-9E06-1B37EC1B****</RequestId>\\n <Success>true</Success>\\n</AddLogicTableRouteConfigResponse>","errorExample":""}]',
+ 'title' => 'AddLogicTableRouteConfig',
+ ],
+ 'DeleteLogicDatabase' => [
+ 'summary' => 'Deletes a logical database from Data Management (DMS). This operation only deletes the specified logical database but does not delete physical databases.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LogicDbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical database. You can call the [ListLogicDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogicdatabases) or [SearchDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/searchdatabase) operation to query the ID of the logical database.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. '."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](https://www.alibabacloud.com/help/en/data-management-service/latest/manage-dms-tenants) topic.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ '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',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLogicDatabaseResponse>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <Success>true</Success>\\n</DeleteLogicDatabaseResponse>","errorExample":""}]',
+ 'title' => 'DeleteLogicDatabase',
+ ],
+ 'DeleteLogicTableRouteConfig' => [
+ 'summary' => 'Deletes a routing algorithm from a logical table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical table. You can call the [ListLogicTables](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogictables) operation to query the ID of the logical table.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1****',
+ ],
+ ],
+ [
+ 'name' => 'RouteKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique key of the routing algorithm. You can call the [ListLogicTableRouteConfig](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogictablerouteconfig) operation to query the unique key.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'id-hash-mod15',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => 'A916A004-A88C-5B39-ABDB-DE808E80****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'MissingRouteKey',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'RouteKey is mandatory for this action.',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A916A004-A88C-5B39-ABDB-DE808E80****\\",\\n \\"ErrorCode\\": \\"MissingRouteKey\\",\\n \\"ErrorMessage\\": \\"RouteKey is mandatory for this action.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLogicTableRouteConfigResponse>\\n <RequestId>A916A004-A88C-5B39-ABDB-DE808E80****</RequestId>\\n <Success>true</Success>\\n</DeleteLogicTableRouteConfigResponse>","errorExample":""}]',
+ 'title' => 'DeleteLogicTableRouteConfig',
+ ],
+ 'ListLogicDatabases' => [
+ 'summary' => 'Queries the detailed information about logical databases.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3422',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of logical databases.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '7',
+ ],
+ 'LogicDatabaseList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'LogicDatabase' => [
+ 'description' => 'The details of logical databases.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of logical databases.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the logical database.',
+ 'type' => 'string',
+ 'example' => '1***',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the logical database.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Logical database Owner ID.',
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the logical database. For more information about the valid values of this parameter, see [DbType parameter](https://www.alibabacloud.com/help/en/data-management-service/latest/dbtype-parameter).',
+ 'type' => 'string',
+ 'example' => 'polardb',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The names of the owners of the logical database.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the owner of the logical database.',
+ 'type' => 'string',
+ 'example' => 'owner_name',
+ ],
+ ],
+ ],
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. The return value is true.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the logical database.',
+ 'type' => 'string',
+ 'example' => 'logic_db',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the logical database.'."\n"
+ ."\n"
+ .'> We recommend that you do not use this parameter for business development. The format of the parameter value may be modified in later versions.',
+ 'type' => 'string',
+ 'example' => 'logic_db[logic_db_alias]',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the logical database belongs. Valid values:'."\n"
+ ."\n"
+ .'- **product**: production environment'."\n"
+ .'- **dev**: development environment'."\n"
+ .'- **pre**: staging environment'."\n"
+ .'- **test**: test environment'."\n"
+ .'- **sit**: system integration testing (SIT) environment'."\n"
+ .'- **uat**: user acceptance testing (UAT) environment'."\n"
+ .'- **pet**: stress testing environment'."\n"
+ .'- **stag**: STAG environment',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the logical database.',
+ 'type' => 'string',
+ 'example' => 'logic_db_alias',
+ ],
+ 'DatabaseIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DatabaseIds' => [
+ 'description' => 'Logical database sub-ID list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Logical database sub-ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '8068AF82-8A1A-592C-AC2E-6B75338BAB87',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 7,\\n \\"LogicDatabaseList\\": {\\n \\"LogicDatabase\\": [\\n {\\n \\"DatabaseId\\": \\"1***\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"51****\\"\\n ]\\n },\\n \\"DbType\\": \\"POLARDB\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"owner_name\\"\\n ]\\n },\\n \\"Logic\\": true,\\n \\"SchemaName\\": \\"logic_db\\",\\n \\"SearchName\\": \\"logic_db[logic_db_alias]\\",\\n \\"EnvType\\": \\"test\\",\\n \\"Alias\\": \\"logic_db_alias\\",\\n \\"DatabaseIds\\": {\\n \\"DatabaseIds\\": [\\n 0\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8068AF82-8A1A-592C-AC2E-6B75338BAB87\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListLogicDatabasesResponse>\\n <TotalCount>7</TotalCount>\\n <LogicDatabaseList>\\n <DatabaseId>1***</DatabaseId>\\n <OwnerIdList>51****</OwnerIdList>\\n <DbType>polardb</DbType>\\n <OwnerNameList>owner_name</OwnerNameList>\\n <Logic>true</Logic>\\n <SchemaName>logic_db</SchemaName>\\n <SearchName>logic_db【logic_db_alias】</SearchName>\\n <EnvType>test</EnvType>\\n <Alias>logic_db_alias</Alias>\\n </LogicDatabaseList>\\n <RequestId>8068AF82-8A1A-592C-AC2E-6B75338BAB87</RequestId>\\n <Success>true</Success>\\n</ListLogicDatabasesResponse>","errorExample":""}]',
+ 'title' => 'ListLogicDatabases',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetLogicDatabase' => [
+ 'summary' => 'Queries the details of a logical database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical database. You can call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation to obtain the ID of the logical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LogicDatabase' => [
+ 'description' => 'The details of the logical database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => '1***',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the logical database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ 'DbType' => [
+ 'description' => 'The database engine. For more information about the valid values of the DbType parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'POLARDB',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The names of the owners of the logical database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The names of the owners of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => 'owner_name',
+ ],
+ ],
+ ],
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. The return value is true.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_logic_db',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_logic_db[test_logic_alias]',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment'."\n"
+ .'* dev: development environment'."\n"
+ .'* pre: pre-release environment'."\n"
+ .'* test: test environment'."\n"
+ .'* sit: system integration testing (SIT) environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment'."\n"
+ .'* pet: stress testing environment'."\n"
+ .'* stag: staging environment'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_logic_alias',
+ ],
+ 'DatabaseIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DatabaseIds' => [
+ 'description' => 'The IDs of database shards of the logical database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the database shard of the logical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '90260530-565C-42B9-A6E8-893481FE6AB6',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The status code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"LogicDatabase\\": {\\n \\"DatabaseId\\": \\"1***\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"51****\\"\\n ]\\n },\\n \\"DbType\\": \\"POLARDB\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"owner_name\\"\\n ]\\n },\\n \\"Logic\\": true,\\n \\"SchemaName\\": \\"test_logic_db\\",\\n \\"SearchName\\": \\"test_logic_db[test_logic_alias]\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"Alias\\": \\"test_logic_alias\\",\\n \\"DatabaseIds\\": {\\n \\"DatabaseIds\\": [\\n 0\\n ]\\n }\\n },\\n \\"RequestId\\": \\"90260530-565C-42B9-A6E8-893481FE6AB6\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetLogicDatabaseResponse>\\n <LogicDatabase>\\n <SearchName>test_logic_db【test_logic_alias】</SearchName>\\n <Alias>test_logic_alias</Alias>\\n <DatabaseId>1***</DatabaseId>\\n <OwnerNameList>\\n <OwnerNames>owner_name</OwnerNames>\\n </OwnerNameList>\\n <Logic>true</Logic>\\n <DbType>polardb</DbType>\\n <SchemaName>test_logic_db</SchemaName>\\n <EnvType>dev</EnvType>\\n <OwnerIdList>\\n <OwnerIds>51****</OwnerIds>\\n </OwnerIdList>\\n </LogicDatabase>\\n <RequestId>E057F5F6-298E-5A3D-B948-0E5328D56B54</RequestId>\\n <Success>true</Success>\\n</GetLogicDatabaseResponse>","errorExample":""}]',
+ 'title' => 'GetLogicDatabase',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListLogicTables' => [
+ 'summary' => 'Queries the details of the logical tables in a logical database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for the logical tables. Prefix match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'ReturnGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return the GUID of the table.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of logical tables that meet the query conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'LogicTableList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'LogicTable' => [
+ 'description' => 'The details of the logical tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the logical database.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the logical table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TableCount' => [
+ 'description' => 'The number of logical tables.'."\n",
+ 'type' => 'string',
+ 'example' => '4',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the logical tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of a logical table.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the owners of the logical tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the owner of a logical table.'."\n",
+ 'type' => 'string',
+ 'example' => 'owner_name',
+ ],
+ ],
+ ],
+ ],
+ 'SchemaName' => [
+ 'description' => 'The logical database to which the logical table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang_test',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the table is a logical table. The value is fixed to true.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TableExpr' => [
+ 'description' => 'The expression of the logical table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test[1-4]',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the logical table.'."\n",
+ 'type' => 'string',
+ 'example' => 'IDB_L_308302.yuyang_test.test_ch',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the logical table.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F1E6484F-9DF1-4406-9BDE-0861C4629B69',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"LogicTableList\\": {\\n \\"LogicTable\\": [\\n {\\n \\"DatabaseId\\": \\"1\\",\\n \\"TableName\\": \\"test\\",\\n \\"TableCount\\": \\"4\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"1\\"\\n ]\\n },\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"owner_name\\"\\n ]\\n },\\n \\"SchemaName\\": \\"yuyang_test\\",\\n \\"Logic\\": true,\\n \\"TableExpr\\": \\"test[1-4]\\",\\n \\"TableGuid\\": \\"IDB_L_308302.yuyang_test.test_ch\\",\\n \\"TableId\\": \\"1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F1E6484F-9DF1-4406-9BDE-0861C4629B69\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<RequestId>F1E6484F-9DF1-4406-9BDE-0861C4629B69</RequestId>\\n<LogicTableList>\\n <LogicTable>\\n <Logic>true</Logic>\\n <OwnerNameList>\\n <OwnerNames>xxx</OwnerNames>\\n <OwnerNames>xxx</OwnerNames>\\n </OwnerNameList>\\n <TableExpr>t[1-4]</TableExpr>\\n <DatabaseId>267</DatabaseId>\\n <SchemaName>yuyang_test</SchemaName>\\n <TableName>t</TableName>\\n <TableGuid>IDB_L_3057.yuyang_test.t</TableGuid>\\n <TableCount>4</TableCount>\\n <OwnerIdList>\\n <OwnerIds>88653</OwnerIds>\\n <OwnerIds>104442</OwnerIds>\\n </OwnerIdList>\\n <TableId>3057</TableId>\\n </LogicTable>\\n</LogicTableList>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListLogicTables',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDBTopology' => [
+ 'summary' => 'Queries the topologies of a logical database and its physical database shards.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LogicDbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical database. You can call the [ListLogicDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogicdatabases) or [SearchDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/searchdatabase) operation to query the ID of the logical database.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '134***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '43***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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-6264E1753378',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DBTopology' => [
+ 'description' => 'The topology of the data table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'LogicDbId' => [
+ 'description' => 'The ID of the logical database.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'LogicDbName' => [
+ 'description' => 'Logical database name.',
+ 'type' => 'string',
+ 'example' => 'logic_db_test',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name of the saved search.'."\n",
+ 'type' => 'string',
+ 'example' => 'logic_db_test',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the access point.'."\n",
+ 'type' => 'string',
+ 'example' => 'logic_db_test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'polardb',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment'."\n"
+ .'* dev: development environment'."\n"
+ .'* pre: pre-release environment'."\n"
+ .'* test: test environment'."\n"
+ .'* sit: system integration testing (SIT) environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment'."\n"
+ .'* pet: stress testing environment'."\n"
+ .'* stag: staging environment'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'DBTopologyInfoList' => [
+ 'description' => 'The list of database splitting topology information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database for which the schema design is executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '423532',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the logical database.'."\n"
+ ."\n"
+ .'> If the database is a PostgreSQL database, the value of this parameter is the name of the database schema.',
+ 'type' => 'string',
+ 'example' => 'db_test@rm-xxx:3306',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog to which the database belongs.'."\n"
+ ."\n"
+ .'> If the database is a PostgreSQL database, the value of this parameter is the name of the database.',
+ 'type' => 'string',
+ 'example' => 'def',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name of the saved search.'."\n",
+ 'type' => 'string',
+ 'example' => 'db_test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'polardb',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment'."\n"
+ .'* dev: development environment'."\n"
+ .'* pre: staging environment'."\n"
+ .'* test: test environment'."\n"
+ .'* sit: SIT environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment'."\n"
+ .'* pet: stress testing environment'."\n"
+ .'* stag: STAG environment',
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance. The valid value is returned if you call the ListInstances operation. The instance ID is not the ID of the RDS instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4325325',
+ ],
+ 'RegionId' => [
+ 'description' => 'The ID of the region in which the instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'InstanceResourceId' => [
+ 'description' => 'Instance resource ID.',
+ 'type' => 'string',
+ 'example' => 'rm-xxx',
+ ],
+ '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 deployed on an Elastic Compute Service (ECS) instance'."\n"
+ .'* **VPC_IDC:** a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)'."\n",
+ 'type' => 'string',
+ 'example' => 'RDS',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E1753378\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DBTopology\\": {\\n \\"LogicDbId\\": 1234,\\n \\"LogicDbName\\": \\"logic_db_test\\",\\n \\"SearchName\\": \\"logic_db_test\\",\\n \\"Alias\\": \\"logic_db_test\\",\\n \\"DbType\\": \\"polardb\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"DBTopologyInfoList\\": [\\n {\\n \\"DbId\\": 423532,\\n \\"SchemaName\\": \\"db_test@rm-xxx:3306\\",\\n \\"CatalogName\\": \\"def\\",\\n \\"SearchName\\": \\"db_test\\",\\n \\"DbType\\": \\"polardb\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"InstanceId\\": 4325325,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceResourceId\\": \\"rm-xxx\\",\\n \\"InstanceSource\\": \\"RDS\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C5B8E84B-42B6-4374-AD5A-6264E1753378</RequestId>\\n<Success>true</Success>\\n<ErrorMessage>UnknownError</ErrorMessage>\\n<ErrorCode>UnknownError</ErrorCode>\\n<DBTopology>\\n <LogicDbId>1234</LogicDbId>\\n <LogicDbName>logic_db_test</LogicDbName>\\n <SearchName>logic_db_test</SearchName>\\n <Alias>logic_db_test</Alias>\\n <DbType>polardb</DbType>\\n <EnvType>dev</EnvType>\\n <DBTopologyInfoList>\\n <DbId>423532</DbId>\\n <SchemaName>db_test@rm-xxx:3306</SchemaName>\\n <CatalogName>def</CatalogName>\\n <SearchName>db_test</SearchName>\\n <DbType>polardb</DbType>\\n <EnvType>dev</EnvType>\\n <InstanceId>4325325</InstanceId>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceResourceId>rm-xxx</InstanceResourceId>\\n <InstanceSource>RDS</InstanceSource>\\n </DBTopologyInfoList>\\n</DBTopology>","errorExample":""}]',
+ 'title' => 'GetDBTopology',
+ ],
+ 'GetTableDBTopology' => [
+ 'summary' => 'Queries the topology of a data table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table in DMS.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the database to which the table belongs is a logical database, you can call the [ListLogicTables](~~141875~~) operation to obtain the GUID. The value of the ReturnGuid parameter must be set to true.'."\n"
+ ."\n"
+ .'* If the database to which the table belongs is a physical database, you can call the [ListTables](~~141878~~) operation to obtain the GUID. The value of the ReturnGuid parameter must be set to true.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'IDB_L_9032.db-test.yuyang_test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '853F7FD4-D922-4EFB-931C-D253EF159E06',
+ ],
+ 'DBTopology' => [
+ 'description' => 'The topology of the data table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If a logical table is queried, the name of the logical table is returned.'."\n"
+ ."\n"
+ .'* If a physical table is queried, the name of the physical table is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang_test',
+ ],
+ 'DataSourceList' => [
+ 'description' => 'The data sources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Sid' => [
+ 'description' => 'The system ID (SID) of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'def',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx.mysql.polardb.rds.aliyuncs.com',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'DatabaseList' => [
+ 'description' => 'The physical databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '489347',
+ ],
+ 'DbName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'db-test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'TableList' => [
+ 'description' => 'The physical tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the physical table.'."\n",
+ 'type' => 'string',
+ 'example' => '151977812',
+ ],
+ 'TableType' => [
+ 'description' => 'The type of the table. This is a reserved parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang_test_0000',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ ],
+ ],
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: pre-release environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: system integration testing (SIT) environment'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag**: staging environment'."\n"
+ ."\n"
+ .'> For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'pre',
+ ],
+ ],
+ ],
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ ],
+ ],
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the table in DMS.'."\n",
+ 'type' => 'string',
+ 'example' => 'IDB_L_9032.db-test.yuyang_test',
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"853F7FD4-D922-4EFB-931C-D253EF159E06\\",\\n \\"DBTopology\\": {\\n \\"TableName\\": \\"yuyang_test\\",\\n \\"DataSourceList\\": [\\n {\\n \\"Sid\\": \\"def\\",\\n \\"Host\\": \\"xxx.mysql.polardb.rds.aliyuncs.com\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"DatabaseList\\": [\\n {\\n \\"DbId\\": \\"489347\\",\\n \\"DbName\\": \\"db-test\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"TableList\\": [\\n {\\n \\"TableName\\": \\"151977812\\",\\n \\"TableType\\": \\"yuyang_test_0000\\",\\n \\"TableId\\": \\"NORMAL\\"\\n }\\n ],\\n \\"EnvType\\": \\"pre\\"\\n }\\n ],\\n \\"Port\\": 3306\\n }\\n ],\\n \\"TableGuid\\": \\"IDB_L_9032.db-test.yuyang_test\\"\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetTableDBTopologyResponse>\\n <RequestId>78F78156-2BBE-414A-8A9D-BE61CF6FA60F</RequestId>\\n <DBTopology>\\n <TableName>big_table</TableName>\\n <TableGuid>IDB_270000001.film.big_table</TableGuid>\\n <DataSourceList>\\n <DatabaseList>\\n <DbId>4000000</DbId>\\n <DbName>film</DbName>\\n <TableList>\\n <TableId>200000000</TableId>\\n <TableName>big_table</TableName>\\n <TableType>NORMAL</TableType>\\n </TableList>\\n <EnvType>product</EnvType>\\n <DbType>mysql</DbType>\\n </DatabaseList>\\n <Port>3306</Port>\\n <Host>rm-uf000000z0000002l.mysql.rds.aliyuncs.com</Host>\\n <DbType>mysql</DbType>\\n </DataSourceList>\\n </DBTopology>\\n <Success>true</Success> \\n</GetTableDBTopologyResponse>","errorExample":""}]',
+ 'title' => 'GetTableDBTopology',
+ ],
+ 'ListLogicTableRouteConfig' => [
+ 'summary' => 'Queries the routing algorithms of a logical table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical table. You can call the [ListLogicTables](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogictables) operation to query the ID of the logical table.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '7C6A0D7D-B034-59F6-854C-32425AC6****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'MissingTableId',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'TableId is mandatory for this action.',
+ ],
+ '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',
+ ],
+ 'LogicTableRouteConfigList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'LogicTableRouteConfig' => [
+ 'description' => 'The routing algorithms.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RouteKey' => [
+ 'description' => 'The unique key of the routing algorithm.',
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'RouteExpr' => [
+ 'description' => 'The routing algorithm expression.',
+ 'type' => 'string',
+ 'example' => '#id#%16\\t',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the logical table.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C6A0D7D-B034-59F6-854C-32425AC6****\\",\\n \\"ErrorCode\\": \\"MissingTableId\\",\\n \\"ErrorMessage\\": \\"TableId is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"LogicTableRouteConfigList\\": {\\n \\"LogicTableRouteConfig\\": [\\n {\\n \\"RouteKey\\": \\"1\\",\\n \\"RouteExpr\\": \\"#id#%16\\\\\\\\t\\",\\n \\"TableId\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListLogicTableRouteConfigResponse>\\n <RequestId>7C6A0D7D-B034-59F6-854C-32425AC6****</RequestId>\\n <LogicTableRouteConfigList>\\n <LogicTableRouteConfig>\\n <TableId>1****</TableId>\\n <RouteExpr>#id#%16\\t</RouteExpr>\\n <RouteKey>1</RouteKey>\\n </LogicTableRouteConfig>\\n <LogicTableRouteConfig>\\n <TableId>1****</TableId>\\n <RouteExpr>#id#%16\\t</RouteExpr>\\n <RouteKey>id-hash-mod17\\t</RouteKey>\\n </LogicTableRouteConfig>\\n <LogicTableRouteConfig>\\n <TableId>1****</TableId>\\n <RouteExpr>#id#%16\\t</RouteExpr>\\n <RouteKey>id-test</RouteKey>\\n </LogicTableRouteConfig>\\n </LogicTableRouteConfigList>\\n <Success>true</Success>\\n</ListLogicTableRouteConfigResponse>","errorExample":""}]',
+ 'title' => 'ListLogicTableRouteConfig',
+ ],
+ 'EditLogicDatabase' => [
+ 'summary' => 'Edits the information about a logical database.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Alias',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '- The alias of the logical database. If you want to change the alias, specify a new alias.'."\n"
+ .'- If you do not need to change the alias of the logical database, call the [GetLogicDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/getlogicdatabase) or [GetDBTopology](https://www.alibabacloud.com/help/en/data-management-service/latest/getdbtopology) operation to query the alias of the logical database.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_logic_db',
+ ],
+ ],
+ [
+ 'name' => 'LogicDbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical database. You can call the [ListLogicDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogicdatabases) operation to query the ID of the logical database.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '- The IDs of the physical databases that compose the logical database. If you want to change the physical databases, you can call the [ListDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listdatabases) or [SearchDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/searchdatabase) operation to query the IDs of the new physical databases that you want to specify.'."\n"
+ .'- If you do not want to change the physical databases, you can call the [GetDBTopology](https://www.alibabacloud.com/help/en/data-management-service/latest/getdbtopology) operation to query the IDs of the physical databases that compose the logical database.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1860****',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. '."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](https://www.alibabacloud.com/help/en/data-management-service/latest/manage-dms-tenants) topic.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ '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',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<EditLogicDatabaseResponse>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <Success>true</Success>\\n</EditLogicDatabaseResponse>","errorExample":""}]',
+ 'title' => 'EditLogicDatabase',
+ ],
+ 'ListDataLakeDatabase' => [
+ 'summary' => 'Queries the list of databases in the data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249748',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog. You can view the name of the data catalog in the [DLF console](https://dlf.console.aliyun.com/cn-hangzhou/metadata/catalog?spm=a2c4g.11186623.0.0.5a225658pT4Dkr).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for databases.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, no next page exists.'."\n"
+ .'* If a value of **NextToken** is returned, the value indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the call failed.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DatabaseList' => [
+ 'description' => 'The list of databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the database.'."\n",
+ '$ref' => '#/components/schemas/DLDatabase',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. Set this parameter to the value of NextToken obtained from the previous query.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gSw==',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The maximum number of entries to be returned in a request. You can use this parameter and NextToken to implement paging.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\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\\": \\"NesLoKLEdIZrKhDT7I2gSw==\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeDatabase',
+ ],
+ 'GetDataLakeDatabase' => [
+ 'summary' => 'Queries the information about the database in the data lake.',
+ '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' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE49D6',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '404',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29',
+ ],
+ 'Database' => [
+ 'description' => 'The database information.'."\n",
+ '$ref' => '#/components/schemas/DLDatabase',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5EE2B9E-2F95-57FA-B284-CB441CEE49D6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"404\\",\\n \\"ErrorMessage\\": \\"code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29\\",\\n \\"Database\\": {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataLakeDatabase',
+ ],
+ 'ListDataLakeCatalog' => [
+ 'summary' => 'Queries a list of data catalogs in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for catalogs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The ID of the request. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233F8F2',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CataLogList' => [
+ 'description' => 'The list of catalogs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The catalog.'."\n",
+ '$ref' => '#/components/schemas/DLCatalog',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233F8F2\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CataLogList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeCatalog',
+ ],
+ 'GetDataLakeCatalog' => [
+ 'summary' => 'Queries the data catalog of the data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249777',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1',
+ ],
+ 'Catalog' => [
+ 'description' => 'The information about the catalog.'."\n",
+ '$ref' => '#/components/schemas/DLCatalog',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1\\",\\n \\"Catalog\\": {\\n \\"Description\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataLakeCatalog',
+ ],
+ 'ListDataLakeTablebaseInfo' => [
+ 'summary' => 'Queries basic information about tables in the data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249769',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Rows',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Specified parameter Rows is not valid.',
+ ],
+ 'TablebaseInfoList' => [
+ 'description' => 'The list of tables in the data lake.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The basic information about the table.'."\n",
+ '$ref' => '#/components/schemas/DLTablebaseInfo',
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The number of tables that meet the conditions.'."\n",
+ 'type' => 'string',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Specified parameter Rows is not valid.\\",\\n \\"TablebaseInfoList\\": [\\n {\\n \\"Owner\\": \\"\\",\\n \\"ViewOriginalText\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": \\"100\\"\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeTablebaseInfo',
+ ],
+ 'GetDataLakeTable' => [
+ 'summary' => 'Queries basic information about tables in the data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249771',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '100g_customer',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unknown server error',
+ ],
+ 'Table' => [
+ 'description' => 'The information of the table.'."\n",
+ '$ref' => '#/components/schemas/DLTable',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataLakeTable',
+ ],
+ 'BatchCreateDataLakePartitions' => [
+ 'summary' => 'Creates multiple partitions for a table in a data lakehouse at a time.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The catalog name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'PartitionInputs',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the new partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the partition in the data lake.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/DLPartitionInput',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'IfNotExists',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore this exception if the name of the new partition is the same as that of an existing partition. Valid values:'."\n"
+ ."\n"
+ .'* true: Ignore the exception.'."\n"
+ .'* false: Do not ignore the exception.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'NeedResult',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return partition information. If the value is true, Partitions is returned.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Partitions' => [
+ 'description' => 'The details about the new partitions. This parameter is returned when the NeedResult parameter is set to true.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the partitions.'."\n",
+ '$ref' => '#/components/schemas/DLPartition',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"Partitions\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchCreateDataLakePartitions',
+ ],
+ 'UpdateDataLakeTable' => [
+ 'summary' => 'Updates the information about a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the table.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/open_struct_DLTableInput',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the updated table. If you do not need to update the table name, set the TableName and TableInput parameters to the same value.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '100g_customer',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E1753325',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Table' => [
+ 'description' => 'The information about the table.'."\n",
+ '$ref' => '#/components/schemas/DLTable',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E1753325\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateDataLakeTable',
+ ],
+ 'UpdateDataLakePartition' => [
+ 'summary' => 'Updates the partition information of a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'PartitionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the created partition.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/DLPartitionInput',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateDataLakePartition',
+ ],
+ 'UpdateDataLakeDatabase' => [
+ 'summary' => 'Updates the information about a database in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The catalog name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The storage path of the database. Supports the OSS, S3, and S3A protocols.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'oss://path/to/database',
+ ],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The key-value pairs of the database attributes.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => '{"key":"value"}',
+ 'description' => 'The parameter key and value.'."\n",
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Database' => [
+ 'description' => 'The database details.'."\n",
+ '$ref' => '#/components/schemas/DLDatabase',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Description\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateDataLakeDatabase',
+ ],
+ 'ListDataLakeTableName' => [
+ 'summary' => 'Queries a list of names of tables in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The regular expression that is used to match the table name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, it indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'TableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data table. Valid values:'."\n"
+ ."\n"
+ .'* MANAGED_TABLE'."\n"
+ .'* EXTERNAL_TABLE'."\n"
+ .'* VIRTUAL_VIEW'."\n"
+ .'* INDEX_TABLE'."\n"
+ .'* MATERIALIZED_VIEW'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MANAGED_TABLE',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E1753378',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TableNameList' => [
+ 'description' => 'The table names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The information about the token.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E1753378\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"TableNameList\\": [\\n \\"test_name\\"\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeTableName',
+ ],
+ 'ListDataLakeTable' => [
+ 'summary' => 'Queries a list of tables in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The regular expression that is used to match the names of metadata tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'TableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data table. Valid values:'."\n"
+ ."\n"
+ .'* MANAGED_TABLE'."\n"
+ .'* EXTERNAL_TABLE'."\n"
+ .'* VIRTUAL_VIEW'."\n"
+ .'* INDEX_TABLE'."\n"
+ .'* MATERIALIZED_VIEW'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MANAGED_TABLE',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, it indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '3D3FB827-E667-50DB-AD59-C83F8237FECB',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TableList' => [
+ 'description' => 'The details of the tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The queried table.'."\n",
+ '$ref' => '#/components/schemas/DLTable',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The information about the token.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D3FB827-E667-50DB-AD59-C83F8237FECB\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"TableList\\": [\\n {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeTable',
+ ],
+ 'ListDataLakePartitionName' => [
+ 'summary' => 'Queries a list of partition names of a table in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, the value indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PartitionNameList' => [
+ 'description' => 'The partition names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition name.'."\n",
+ 'type' => 'string',
+ 'example' => 'part_1',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The information about the token.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionNameList\\": [\\n \\"part_1\\"\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakePartitionName',
+ ],
+ 'ListDataLakePartitionByFilter' => [
+ 'summary' => 'Queries a list of partitions of a table in a data lake based on filter conditions.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The catalog name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The expression of the query condition. The following operators are supported:'."\n"
+ ."\n"
+ .'* Comparison operators: =, <>, ! =, <, <=,>, and >=. Example: ds>20240101.'."\n"
+ .'* Logical operators: AND, OR, and NOT. Example: ds LIKE \'20240%\'.'."\n"
+ .'* BETWEEN operator: Specifies a range. Example: ds BETWEEN 20240101 AND 20241201.'."\n"
+ .'* IN operator: Specifies a set of values. Example: ds IN (20240101, 20240102).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ds>20241201',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid value:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, no next page exists.'."\n"
+ .'* If a value of **NextToken** is returned, the value indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PartitionList' => [
+ 'description' => 'The queried partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The queried partition.'."\n",
+ '$ref' => '#/components/schemas/DLPartition',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The information about the token.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakePartitionByFilter',
+ ],
+ 'ListDataLakePartition' => [
+ 'summary' => 'Queries a list of partitions of a table in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'PartNames',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The partition names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'part_1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, it indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 0 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The call was successful.'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PartitionList' => [
+ 'description' => 'The queried partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The queried partition.'."\n",
+ '$ref' => '#/components/schemas/DLPartition',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The information about the token.'."\n",
+ 'type' => 'string',
+ 'example' => 'NesLoKLEdIZrKhDT7I2gS****',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PartitionList\\": [\\n {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"NesLoKLEdIZrKhDT7I2gS****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakePartition',
+ ],
+ 'GetDataLakePartition' => [
+ 'summary' => 'Queries the information about a partition of a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'PartitionValues',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => 'The values in a partition key column.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the partition key column.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'part_val1',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Partition' => [
+ 'description' => 'The queried partition.'."\n",
+ '$ref' => '#/components/schemas/DLPartition',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataLakePartition',
+ ],
+ 'DeleteDataLakeTable' => [
+ 'summary' => 'Deletes a table from a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '8E88933E-E3D4-5BA8-8CBF-0A1CAE666690',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAE666690\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteDataLakeTable',
+ ],
+ 'DeleteDataLakePartition' => [
+ 'summary' => 'Deletes a partition from a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'PartitionValues',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => 'The values in a partition key column.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the partition key column.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'part_val1'."\n",
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'IfExists',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore the exception if the partition that you want to delete does not exist.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The partition is deleted.'."\n"
+ .'* **false**: The partition failed to be deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteDataLakePartition',
+ ],
+ 'DeleteDataLakeDatabase' => [
+ 'summary' => 'Deletes a database from a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteDataLakeDatabase',
+ ],
+ 'CreateDataLakeTable' => [
+ 'summary' => 'Creates a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the table.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/open_struct_DLTableInput',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> You can move the pointer over the profile picture in the upper-right corner of the DMS console to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Table' => [
+ 'description' => 'The information about the table.'."\n",
+ '$ref' => '#/components/schemas/DLTable',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"ViewOriginalText\\": \\"\\",\\n \\"Owner\\": \\"\\",\\n \\"TableType\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"CreateTime\\": 0,\\n \\"StorageDescriptor\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"LastAccessTime\\": 0,\\n \\"Retention\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"ViewExpandedText\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"DbName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"PartitionKeys\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ModifierId\\": 0,\\n \\"Location\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateDataLakeTable',
+ ],
+ 'CreateDataLakePartition' => [
+ 'summary' => 'Creates a partition for a table in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'PartitionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the created partition.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/DLPartitionInput',
+ ],
+ ],
+ [
+ 'name' => 'IfNotExists',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore the exception if the name of the created partition is the same as the name of an existing partition.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'NeedResult',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return information about the created partition. If the value is true, the Partition parameter is returned. Valid values:'."\n"
+ ."\n"
+ .'* true: returns information about the created partition.'."\n"
+ .'* false: does not return information about the created partition.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Partition' => [
+ 'description' => 'The information about the partition.'."\n",
+ '$ref' => '#/components/schemas/DLPartition',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Partition\\": {\\n \\"TableName\\": \\"\\",\\n \\"Sd\\": {\\n \\"OriginalColumns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"SortCols\\": [\\n {\\n \\"Order\\": 0,\\n \\"Col\\": \\"\\"\\n }\\n ],\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedInfo\\": {\\n \\"SkewedColValues\\": [\\n [\\n \\"\\"\\n ]\\n ],\\n \\"SkewedColValueLocationMaps\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SkewedColNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"InputFormat\\": \\"\\",\\n \\"OutputFormat\\": \\"\\",\\n \\"Columns\\": [\\n {\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"IsCompressed\\": true,\\n \\"SerdeInfo\\": {\\n \\"SerializationLib\\": \\"\\",\\n \\"DeserializerClass\\": \\"\\",\\n \\"Parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"\\",\\n \\"SerdeType\\": 0,\\n \\"SerializerClass\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"BucketCols\\": [\\n \\"\\"\\n ],\\n \\"NumBuckets\\": 0,\\n \\"Location\\": \\"\\"\\n },\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CreateTime\\": 0,\\n \\"Values\\": [\\n \\"\\"\\n ],\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"LastAccessTime\\": 0\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateDataLakePartition',
+ ],
+ 'CreateDataLakeDatabase' => [
+ 'summary' => 'Creates a database in a data lakehouse.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The storage path of the database. OSS, S3, and S3A are supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'oss://path/to/database',
+ ],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The key-value pairs of the database attributes.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => '{"key":"value"}',
+ 'description' => 'The key and value.'."\n",
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F15D6E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F15D6E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateDataLakeDatabase',
+ ],
+ 'BatchUpdateDataLakePartitions' => [
+ 'summary' => 'Updates multiple partitions of a table in a data lakehouse at a time.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'PartitionInputs',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the created partition.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The partition information of the data lake.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/DLPartitionInput',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E1753378',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PartitionErrors' => [
+ 'description' => 'The error messages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The error message.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E1753378\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchUpdateDataLakePartitions',
+ ],
+ 'BatchDeleteDataLakePartitions' => [
+ 'summary' => 'Deletes multiple partitions of a table in a data lakehouse at a time.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'PartitionValuesList',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'description' => 'The values in a partition key column.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The values in a partition key column.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The value of the partition key column.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'part_val1',
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'IfExists',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore the exception if the partition that you want to delete does not exist.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E46EA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'PartitionErrors' => [
+ 'description' => 'The error messages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The error message.'."\n",
+ '$ref' => '#/components/schemas/PartitionError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B96E35F-A58E-5399-9041-09CF9A1E46EA\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": \\"true\\",\\n \\"PartitionErrors\\": [\\n {\\n \\"ErrorDetail\\": \\"\\",\\n \\"Values\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchDeleteDataLakePartitions',
+ ],
+ 'CreateDataLakeFunction' => [
+ 'summary' => 'Creates a custom function in a data lakehouse.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The details about the function.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/DLFunctionInput',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'EE214ECD-4330-503A-82F0-FFB039757DC8',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Function' => [
+ 'description' => 'The details about the function.'."\n",
+ '$ref' => '#/components/schemas/DLFunction',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE214ECD-4330-503A-82F0-FFB039757DC8\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateDataLakeFunction',
+ ],
+ 'GetDataLakeFunction' => [
+ 'summary' => 'Obtains the details about a user-defined function in a data lakehouse.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The function name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'my_funciton',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D911009F-3E95-5AFD-8CF1-73F7B4F15D6E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Function' => [
+ 'description' => 'The details about the function.'."\n",
+ '$ref' => '#/components/schemas/DLFunction',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D911009F-3E95-5AFD-8CF1-73F7B4F15D6E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataLakeFunction',
+ ],
+ 'UpdateDataLakeFunction' => [
+ 'summary' => 'Updates a user-defined function in a data lakehouse.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The catalog name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionInput',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The details about the function.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/DLFunctionInput',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The function name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'my_funciton',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C1D39814-9808-47F8-AFE0-AF167239AC9B',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Function' => [
+ 'description' => 'The details about the function.'."\n",
+ '$ref' => '#/components/schemas/DLFunction',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1D39814-9808-47F8-AFE0-AF167239AC9B\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Function\\": {\\n \\"FunctionName\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"OwnerType\\": \\"\\",\\n \\"CreatorId\\": 0,\\n \\"FunctionType\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ResourceUris\\": [\\n {\\n \\"ResourceType\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"ClassName\\": \\"\\",\\n \\"CatalogName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"ModifierId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateDataLakeFunction',
+ ],
+ 'DeleteDataLakeFunction' => [
+ 'summary' => 'Deletes a user-defined function in a data lakehouse.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data directory.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The function name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'my_funciton',
+ ],
+ ],
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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' => 'B4B07137-F6AE-4756-8474-7F92BB6C4E04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C4E04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteDataLakeFunction',
+ ],
+ 'ListDataLakeFunction' => [
+ 'summary' => 'Queries a list of functions in a data lake.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The regular expression that is used to filter the returned function names.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, it indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'FunctionList' => [
+ 'description' => 'The information about functions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the function.'."\n",
+ '$ref' => '#/components/schemas/DLFunction',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The token that determines the start point of the next query.'."\n",
+ 'type' => 'string',
+ 'example' => 'f056501ada12c1cc',
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\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\\": \\"f056501ada12c1cc\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeFunction',
+ ],
+ 'ListDataLakeFunctionName' => [
+ 'summary' => 'Gets a list of data lake function names.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249778',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DataRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the data lake resides.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hive',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'FunctionNamePattern',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The regular expression that is used to filter the returned function names.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '.*',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
+ ."\n"
+ .'* If **NextToken** is empty, there is no next page.'."\n"
+ .'* If a value of **NextToken** is returned, it indicates the token that is used for the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'f056501ada12c1cc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F1C78D32-1AFD-58AD-9DD2-C8A0896969DD',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'FunctionNameList' => [
+ 'description' => 'The information about the list of function names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of function names.'."\n",
+ 'type' => 'string',
+ 'example' => 'my_funciton',
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'The token that determines the start point of the next query.'."\n",
+ 'type' => 'string',
+ 'example' => 'f056501ada12c1cc'."\n",
+ ],
+ 'MaxResults' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1C78D32-1AFD-58AD-9DD2-C8A0896969DD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"FunctionNameList\\": [\\n \\"my_funciton\\"\\n ],\\n \\"NextToken\\": \\"f056501ada12c1cc\\\\n\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ 'title' => 'ListDataLakeFunctionName',
+ ],
+ 'SearchDatabase' => [
+ 'summary' => 'Queries the details of the databases.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '12589',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms1KPGDT',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for databases.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'testdb',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment type of the database. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'SearchRange',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The query range based on permissions. Valid values:'."\n"
+ ."\n"
+ .'* **HAS_PERMSSION**: searches for databases on which the current user has permissions.'."\n"
+ .'* **OWNER**: searches for databases owned by the current user.'."\n"
+ .'* **MY_FOCUS**: searches for databases that the current user follows.'."\n"
+ .'* **UNKNOWN**: searches for all databases.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'HAS_PERMSSION',
+ ],
+ ],
+ [
+ 'name' => 'SearchTarget',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category of the database. Valid values:'."\n"
+ ."\n"
+ .'* **DB**: single database or logical database.'."\n"
+ .'* **SINGLE_DB**: single database.'."\n"
+ .'* **LOGIC_DB**: logical database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SINGLE_DB',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MYSQL',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6',
+ ],
+ 'SearchDatabaseList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SearchDatabase' => [
+ 'description' => 'The information about the databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '2528****',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint of the instance in which the database resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-xxxx.mysql.rds.aliyuncs.com',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the user who assumes the database administrator (DBA) role.'."\n",
+ 'type' => 'string',
+ 'example' => '10****',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DatalinkName' => [
+ 'description' => 'The name of the data link for cross-database queries.'."\n",
+ 'type' => 'string',
+ 'example' => 'datalink_name',
+ ],
+ 'Port' => [
+ 'description' => 'The port of the instance in which the database resides.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The environment type of the database. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Sid' => [
+ 'description' => 'The system ID (SID) of the instance in which the database resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'testSid',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding method of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the database owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the database owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'user1',
+ ],
+ ],
+ ],
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_rds',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog to which the database belongs.'."\n"
+ ."\n"
+ .'> If the type of the database engine is PostgreSQL, the name of the database is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"SearchDatabaseList\\": {\\n \\"SearchDatabase\\": [\\n {\\n \\"DatabaseId\\": \\"2528****\\",\\n \\"Host\\": \\"rm-xxxx.mysql.rds.aliyuncs.com\\",\\n \\"DbaId\\": \\"10****\\",\\n \\"SchemaName\\": \\"test\\",\\n \\"Logic\\": false,\\n \\"DatalinkName\\": \\"datalink_name\\",\\n \\"Port\\": 3306,\\n \\"EnvType\\": \\"test\\",\\n \\"Sid\\": \\"testSid\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"1\\"\\n ]\\n },\\n \\"Encoding\\": \\"utf8\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"user1\\"\\n ]\\n },\\n \\"SearchName\\": \\"[email protected]:3306\\",\\n \\"Alias\\": \\"test_rds\\",\\n \\"CatalogName\\": \\"dmstest\\"\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SearchDatabaseResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>\\n <SearchDatabaseList>\\n <DatabaseId>2528****</DatabaseId>\\n <Host>rm-xxxx.mysql.rds.aliyuncs.com</Host>\\n <DbaId>10****</DbaId>\\n <SchemaName>test</SchemaName>\\n <Logic>false</Logic>\\n <DatalinkName>datalink_name</DatalinkName>\\n <Port>3306</Port>\\n <EnvType>test</EnvType>\\n <Sid>testSid</Sid>\\n <OwnerIdList>1</OwnerIdList>\\n <Encoding>utf8</Encoding>\\n <DbType>mysql</DbType>\\n <OwnerNameList>user1</OwnerNameList>\\n <SearchName>[email protected]:3306</SearchName>\\n <Alias>test_rds</Alias>\\n </SearchDatabaseList>\\n <Success>true</Success>\\n</SearchDatabaseResponse>","errorExample":""}]',
+ 'title' => 'SearchDatabase',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SearchTable' => [
+ 'summary' => 'Queries detailed information about tables.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to query tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ 'minimum' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ 'maximum' => '100',
+ 'minimum' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment to which databases belong. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'PRODUCT',
+ ],
+ ],
+ [
+ 'name' => 'SearchRange',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The scope of tables that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* **HAS_PERMSSION**: the tables on which the current account has permissions.'."\n"
+ .'* **OWNER**: the tables owned by the current account.'."\n"
+ .'* **MY_FOCUS**: the tables that the current account follows.'."\n"
+ .'* **UNKNOWN**: all tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'OWNER',
+ ],
+ ],
+ [
+ 'name' => 'SearchTarget',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of table that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* **TABLE**: physical and logical tables'."\n"
+ .'* **SINGLE_TABLE**: physical tables'."\n"
+ .'* **LOGIC_TABLE**: logical tables'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'LOGIC_TABLE',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of database. Valid values:'."\n"
+ ."\n"
+ .'* **MySQL**'."\n"
+ .'* **SQLServer**'."\n"
+ .'* **PostgreSQL**'."\n"
+ .'* **Oracle**'."\n"
+ .'* **DRDS**'."\n"
+ .'* **OceanBase**'."\n"
+ .'* **Mongo**'."\n"
+ .'* **Redis**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'ReturnGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return the GUID of each table.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchTableList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SearchTable' => [
+ 'description' => 'The details of the tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableId' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DatabaseId' => [
+ 'description' => 'The ID of the database to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8',
+ ],
+ 'DBSearchName' => [
+ 'description' => 'The name that is used to search for the database to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. Valid values:'."\n"
+ ."\n"
+ .'* **MySQL**'."\n"
+ .'* **SQLServer**'."\n"
+ .'* **PostgreSQL**'."\n"
+ .'* **Oracle**'."\n"
+ .'* **DRDS**'."\n"
+ .'* **OceanBase**'."\n"
+ .'* **Mongo**'."\n"
+ .'* **Redis**'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_table',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'IDB_L_9032.db-test.yuyang_test',
+ ],
+ 'TableSchemaName' => [
+ 'description' => 'The name of the database to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'DbName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the table owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the table owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'user',
+ ],
+ ],
+ ],
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the table is a logical table. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The table is a logical table.'."\n"
+ .'* **false**: The table is not a logical table.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the table owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the table owner.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'Engine' => [
+ 'description' => 'The engine of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'innodb',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries that are returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1489257F-1B5D-4B5B-89EF-923C12CEEBD1',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SearchTableList\\": {\\n \\"SearchTable\\": [\\n {\\n \\"TableId\\": \\"1\\",\\n \\"Description\\": \\"test\\",\\n \\"DatabaseId\\": \\"1\\",\\n \\"Encoding\\": \\"utf8\\",\\n \\"DBSearchName\\": \\"test\\",\\n \\"EnvType\\": \\"test\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"TableGuid\\": \\"IDB_L_9032.db-test.yuyang_test\\",\\n \\"TableSchemaName\\": \\"[email protected]:3306\\",\\n \\"DbName\\": \\"test\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"user\\"\\n ]\\n },\\n \\"Logic\\": false,\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"1\\"\\n ]\\n },\\n \\"Engine\\": \\"innodb\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1489257F-1B5D-4B5B-89EF-923C12CEEBD1\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SearchTableList>\\n <SearchTable>\\n <TableGuid>IDB_L_9032.db-test.yuyang_test</TableGuid>\\n <Logic>false</Logic>\\n <TableSchemaName>xxx_0000</TableSchemaName>\\n <OwnerNameList>\\n <OwnerNames>xxx</OwnerNames>\\n <OwnerNames>xxx</OwnerNames>\\n <OwnerNames>xxx</OwnerNames>\\n </OwnerNameList>\\n <DBSearchName>[email protected]:3306【xxx线下库】</DBSearchName>\\n <DatabaseId>117567</DatabaseId>\\n <Encoding>utf8mb4</Encoding>\\n <TableName>test_aaaa</TableName>\\n <OwnerIdList>\\n <OwnerIds>88653</OwnerIds>\\n <OwnerIds>88656</OwnerIds>\\n <OwnerIds>104442</OwnerIds>\\n </OwnerIdList>\\n <EnvType>dev</EnvType>\\n <Engine>InnoDB</Engine>\\n <TableId>18396767</TableId>\\n </SearchTable>\\n</SearchTableList>\\n<TotalCount>1</TotalCount>\\n<RequestId>1489257F-1B5D-4B5B-89EF-923C12CEEBD1</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'SearchTable',
+ 'description' => 'You can call this operation only for database instances that are managed in Security Collaboration mode.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDatabases' => [
+ 'summary' => 'Queries the databases in a database instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. The valid value is returned if you call the ListInstances operation. The instance ID is not the ID of the RDS instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12***',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The number of databases that belong to an instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5541CDA6-F674-435C-81BD-40C2FB926CE3',
+ ],
+ 'DatabaseList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Database' => [
+ 'description' => 'The details of the databases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint of the instance to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx.xxx.xxx.xxx',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'DbaName' => [
+ 'description' => 'The nickname of the Database administrator (DBA) to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'dba_user',
+ ],
+ 'State' => [
+ 'description' => 'The state of the database. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The database is normal.'."\n"
+ .'* DISABLE: The database is disabled.'."\n"
+ .'* OFFLINE: The database is unpublished.'."\n"
+ .'* NOT_EXIST: The database does not exist.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the DBA.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Port' => [
+ 'description' => 'The connection port of the instance to which the database belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'Sid' => [
+ 'description' => 'The system ID (SID) of the instance to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf-8',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the database owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the database owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'owner_name',
+ ],
+ ],
+ ],
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used for searching the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"5541CDA6-F674-435C-81BD-40C2FB926CE3\\",\\n \\"DatabaseList\\": {\\n \\"Database\\": [\\n {\\n \\"DatabaseId\\": \\"1\\",\\n \\"Host\\": \\"xxx.xxx.xxx.xxx\\",\\n \\"CatalogName\\": \\"1\\",\\n \\"DbaName\\": \\"dba_user\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"DbaId\\": \\"1\\",\\n \\"SchemaName\\": \\"test\\",\\n \\"InstanceId\\": \\"1\\",\\n \\"Port\\": 3306,\\n \\"EnvType\\": \\"dev\\",\\n \\"Sid\\": \\"test\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"1\\"\\n ]\\n },\\n \\"Encoding\\": \\"utf-8\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"owner_name\\"\\n ]\\n },\\n \\"SearchName\\": \\"[email protected]:3306\\"\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<RequestId>5541CDA6-F674-435C-81BD-40C2FB926CE3</RequestId>\\n<Success>true</Success>\\n<DatabaseList>\\n <Database>\\n <Encoding>utf8</Encoding>\\n <Host>pc-xxx.rwlb.rds.aliyuncs.com</Host>\\n <InstanceId>24710</InstanceId>\\n <DbType>polardb</DbType>\\n <EnvType>product</EnvType>\\n <OwnerIdList>\\n <OwnerIds>88653</OwnerIds>\\n </OwnerIdList>\\n <DbaId>104442</DbaId>\\n <OwnerNameList>\\n <OwnerNames>dmstest</OwnerNames>\\n </OwnerNameList>\\n <Port>3306</Port>\\n <DatabaseId>116366</DatabaseId>\\n <State>NORMAL</State>\\n <SearchName>[email protected]:3306【xxx_test】</SearchName>\\n <DbaName>xxx[子账号]</DbaName>\\n <SchemaName>xxx_test</SchemaName>\\n </Database>\\n</DatabaseList>","errorExample":""}]',
+ 'title' => 'ListDatabases',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTables' => [
+ 'summary' => 'Queries the tables in a database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms1KPGDT',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical database. You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the ID of the physical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1860****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'SearchName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name used to search for tables. Fuzzy search is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'ReturnGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return the GUID of a table. Valid values:'."\n"
+ ."\n"
+ .'* **true**: returns the GUID of a table.'."\n"
+ .'* **false**: does not return the GUID of a table.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of tables that meet the query conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'B16FB618-5E96-4FFD-BB0D-490C890A4030',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TableList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Table' => [
+ 'description' => 'The details of the tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the physical database.'."\n",
+ 'type' => 'string',
+ 'example' => '1860****',
+ ],
+ 'TableName' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'example' => 'consumption_records',
+ ],
+ 'StoreCapacity' => [
+ 'description' => 'The storage space that is occupied by the table. This is a statistical value and does not indicate the accurate storage space. Unit: MB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1024',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The ID list of the table owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the table owner.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ 'Description' => [
+ 'description' => 'The description of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nickname list of the table owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the table owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'owner_name',
+ ],
+ ],
+ ],
+ ],
+ 'TableSchemaName' => [
+ 'description' => 'The database in which the table resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'qntest',
+ ],
+ 'TableType' => [
+ 'description' => 'The type of the table. Default value: NORMAL.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the table in DMS.'."\n",
+ 'type' => 'string',
+ 'example' => 'IDB_44743****.qntest.consumption_records',
+ ],
+ 'Engine' => [
+ 'description' => 'The engine of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'InnoDB',
+ ],
+ 'NumRows' => [
+ 'description' => 'The number of rows in the table. This is a statistical value and does not indicate the actual number of rows.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10085',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => '44743****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"B16FB618-5E96-4FFD-BB0D-490C890A4030\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"TableList\\": {\\n \\"Table\\": [\\n {\\n \\"DatabaseId\\": \\"1860****\\",\\n \\"TableName\\": \\"consumption_records\\",\\n \\"StoreCapacity\\": 1024,\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"51****\\"\\n ]\\n },\\n \\"Description\\": \\"test\\",\\n \\"Encoding\\": \\"utf8\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"owner_name\\"\\n ]\\n },\\n \\"TableSchemaName\\": \\"qntest\\",\\n \\"TableType\\": \\"NORMAL\\",\\n \\"TableGuid\\": \\"IDB_44743****.qntest.consumption_records\\",\\n \\"Engine\\": \\"InnoDB\\",\\n \\"NumRows\\": 10085,\\n \\"TableId\\": \\"44743****\\"\\n }\\n ]\\n },\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListTablesResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>B16FB618-5E96-4FFD-BB0D-490C890A4030</RequestId>\\n <TableList>\\n <DatabaseId>1860****</DatabaseId>\\n <TableName>consumption_records</TableName>\\n <StoreCapacity>1024</StoreCapacity>\\n <OwnerIdList>51****</OwnerIdList>\\n <Description>test</Description>\\n <Encoding>utf8</Encoding>\\n <OwnerNameList>owner_name</OwnerNameList>\\n <TableSchemaName>qntest</TableSchemaName>\\n <TableType>NORMAL</TableType>\\n <TableGuid>IDB_44743****.qntest.consumption_records</TableGuid>\\n <Engine>InnoDB</Engine>\\n <NumRows>10085</NumRows>\\n <TableId>44743****</TableId>\\n </TableList>\\n <Success>true</Success>\\n</ListTablesResponse>","errorExample":""}]',
+ 'title' => 'ListTables',
+ 'description' => 'You can call this operation only for database instances whose control mode is Security Collaboration.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTableColumns' => [
+ 'summary' => 'Queries the details about fields in a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of a physical database: You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the physical database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '100g_customer',
+ ],
+ ],
+ [
+ 'name' => 'TableSchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dbo',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ColumnList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Column' => [
+ 'description' => 'The details about fields in the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnId' => [
+ 'description' => 'The ID of the field.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'varchar',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'column desc',
+ ],
+ 'AutoIncrement' => [
+ 'description' => 'Indicates whether the field is an auto-increment field. Valid values:'."\n"
+ ."\n"
+ .'* true: The field is an auto-increment field.'."\n"
+ .'* false: The field is not an auto-increment field.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The type of the masking algorithm that is used for the field. Valid values:'."\n"
+ ."\n"
+ .'* null: No masking algorithm is used.'."\n"
+ .'* DEFAULT: A full masking algorithm is used.'."\n"
+ .'* FIX_POS: The fixed position is masked.'."\n"
+ .'* FIX_CHAR: The fixed characters are replaced.'."\n",
+ 'type' => 'string',
+ 'example' => 'NULL',
+ ],
+ 'DataPrecision' => [
+ 'description' => 'The number of valid digits for the column.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'aaa',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The field name.'."\n",
+ 'type' => 'string',
+ 'example' => 'c1',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The security level of the field. Valid values:'."\n"
+ ."\n"
+ .'* INNER: The field is an internal field but not sensitive.'."\n"
+ .'* SENSITIVE: The field is sensitive.'."\n"
+ .'* CONFIDENTIAL: The field is a confidential column.'."\n",
+ 'type' => 'string',
+ 'example' => 'INNER',
+ ],
+ 'DataScale' => [
+ 'description' => 'The number of decimal places of the field data.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'DataLength' => [
+ 'description' => 'The length of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '32',
+ ],
+ 'Sensitive' => [
+ 'description' => 'Indicates whether the field is a sensitive column. Valid values:'."\n"
+ ."\n"
+ .'* true: The field is a sensitive field.'."\n"
+ .'* false: The field is not a sensitive field.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Nullable' => [
+ 'description' => 'Indicates whether the field can be empty. Valid values:'."\n"
+ ."\n"
+ .'* true: The field can be empty.'."\n"
+ .'* false: The field cannot be empty.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ColumnList\\": {\\n \\"Column\\": [\\n {\\n \\"ColumnId\\": \\"12345\\",\\n \\"ColumnType\\": \\"varchar\\",\\n \\"Description\\": \\"column desc\\",\\n \\"AutoIncrement\\": false,\\n \\"FunctionType\\": \\"NULL\\",\\n \\"DataPrecision\\": 0,\\n \\"DefaultValue\\": \\"aaa\\",\\n \\"ColumnName\\": \\"c1\\",\\n \\"SecurityLevel\\": \\"INNER\\",\\n \\"DataScale\\": 0,\\n \\"DataLength\\": 32,\\n \\"Sensitive\\": false,\\n \\"Nullable\\": true\\n }\\n ]\\n },\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ListTableColumns',
+ ],
+ 'ListColumns' => [
+ 'summary' => 'Returns the column information of a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the table. You can call the [ListTables](~~141878~~) operation to obtain the table ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '39281****',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0AD9AC55-5873-474A-9F33-4285806A3619',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ColumnList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Column' => [
+ 'description' => 'The details about columns.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about fields in the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnType' => [
+ 'description' => 'The data type of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'varchar',
+ ],
+ 'AutoIncrement' => [
+ 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n"
+ ."\n"
+ .'* true: The column is an auto-increment column.'."\n"
+ .'* false: The column is not an auto-increment column.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ColumnId' => [
+ 'description' => 'The ID of the column.'."\n",
+ 'type' => 'string',
+ 'example' => '62589****',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'def_value',
+ ],
+ 'Sensitive' => [
+ 'description' => 'Indicates whether the column is a sensitive column. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The column is a sensitive column.'."\n"
+ .'* **false**: The column is not a sensitive column.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The security level of the column. Valid values:'."\n"
+ ."\n"
+ .'* INNER: The column is an internal column but not sensitive.'."\n"
+ .'* SENSITIVE: The column is a sensitive column.'."\n"
+ .'* CONFIDENTIAL: The column is a confidential column.'."\n"
+ ."\n"
+ .'> For more information, see [Sensitivity levels of fields](~~66091~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'INNER',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DataPrecision' => [
+ 'description' => 'The number of valid digits for the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'DataScale' => [
+ 'description' => 'The number of decimal places for the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The type of the masking algorithm that is used for the field. Valid values:'."\n"
+ ."\n"
+ .'* null: No masking algorithm is used.'."\n"
+ .'* DEFAULT: A full masking algorithm is used.'."\n"
+ .'* FIX_POS: The fixed position is masked.'."\n"
+ .'* FIX_CHAR: The fixed characters are replaced.'."\n",
+ 'type' => 'string',
+ 'example' => 'DEFAULT',
+ ],
+ 'Nullable' => [
+ 'description' => 'Indicates whether the column can be empty. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The column can be empty.'."\n"
+ .'* **false**: The column cannot be empty.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DataLength' => [
+ 'description' => 'The length of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AD9AC55-5873-474A-9F33-4285806A3619\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ColumnList\\": {\\n \\"Column\\": [\\n {\\n \\"ColumnType\\": \\"varchar\\",\\n \\"AutoIncrement\\": false,\\n \\"ColumnId\\": \\"62589****\\",\\n \\"DefaultValue\\": \\"def_value\\",\\n \\"Sensitive\\": false,\\n \\"ColumnName\\": \\"name\\",\\n \\"SecurityLevel\\": \\"INNER\\",\\n \\"Description\\": \\"test\\",\\n \\"DataPrecision\\": 0,\\n \\"DataScale\\": 0,\\n \\"FunctionType\\": \\"DEFAULT\\",\\n \\"Nullable\\": false,\\n \\"DataLength\\": 4\\n }\\n ]\\n },\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListColumnsResponse>\\n <RequestId>0AD9AC55-5873-474A-9F33-4285806A3619</RequestId>\\n <ColumnList>\\n <ColumnId>62589****</ColumnId>\\n <ColumnName>name</ColumnName>\\n <Description/>\\n <ColumnType>varchar(4)</ColumnType>\\n <AutoIncrement>false</AutoIncrement>\\n <SecurityLevel>INNER</SecurityLevel>\\n <DataLength>4</DataLength>\\n <Sensitive>false</Sensitive>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <Success>true</Success>\\n</ListColumnsResponse>","errorExample":""}]',
+ 'title' => 'ListColumns',
+ 'description' => 'You can call this operation only for database instances whose control mode is Security Collaboration.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListIndexes' => [
+ 'summary' => 'Queries the indexes of a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the table is a logical table.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1F4DE2F1-5B47-462A-A973-E02EB7AF386B',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'IndexList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Index' => [
+ 'description' => 'The details of indexes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexName' => [
+ 'description' => 'The name of the index.'."\n",
+ 'type' => 'string',
+ 'example' => 'idx_test',
+ ],
+ 'IndexType' => [
+ 'description' => 'The type of the index. Valid values:'."\n"
+ ."\n"
+ .'* Primary'."\n"
+ .'* Unique'."\n"
+ .'* Normal'."\n"
+ .'* FullText'."\n"
+ .'* Spatial'."\n",
+ 'type' => 'string',
+ 'example' => 'Primary',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'IndexId' => [
+ 'description' => 'The ID of the index.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'IndexComment' => [
+ 'description' => 'The description of the index.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1F4DE2F1-5B47-462A-A973-E02EB7AF386B\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"IndexList\\": {\\n \\"Index\\": [\\n {\\n \\"IndexName\\": \\"idx_test\\",\\n \\"IndexType\\": \\"Primary\\",\\n \\"TableId\\": \\"1\\",\\n \\"IndexId\\": \\"1\\",\\n \\"IndexComment\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1F4DE2F1-5B47-462A-A973-E02EB7AF386B</RequestId>\\n<IndexList>\\n <Index>\\n <IndexComment/>\\n <IndexType>Primary</IndexType>\\n <IndexName>PRIMARY</IndexName>\\n <IndexId>49331416</IndexId>\\n <TableId>18396274</TableId>\\n </Index>\\n</IndexList>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListIndexes',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDatabase' => [
+ 'summary' => 'Queries details of a specific database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms1KPGDT',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'Host',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The endpoint that is used to connect to the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '192.168.XX.XX',
+ ],
+ ],
+ [
+ 'name' => 'Port',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The port that is used to connect to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3306',
+ ],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => [
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_sid',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '3CDB8601-AD74-4A47-8114-08E08CD6****',
+ ],
+ 'Database' => [
+ 'description' => 'The details of the database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '984****',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint that is used to connect to the database.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.XX.XX',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'def',
+ ],
+ 'DbaName' => [
+ 'description' => 'The nickname of the DBA.'."\n",
+ 'type' => 'string',
+ 'example' => 'dba_name',
+ ],
+ 'State' => [
+ 'description' => 'The status of the database. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The database is running as expected.'."\n"
+ .'* **DISABLE**: The database is disabled.'."\n"
+ .'* **OFFLINE**: The database is unpublished.'."\n"
+ .'* **NOT_EXIST**: The database does not exist.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the database administrator (DBA).'."\n",
+ 'type' => 'string',
+ 'example' => '27****',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '149****',
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: staging environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: SIT environment'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag**: STAG environment'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'Sid' => [
+ 'description' => 'The SID of the database.'."\n"
+ ."\n"
+ .'> The value of the parameter is returned only for Oracle databases.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_sid',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '27****',
+ ],
+ ],
+ ],
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8mb4',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The names of the owners of the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ 'SearchName' => [
+ 'description' => 'The keyword that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'InstanceAlias' => [
+ 'description' => 'The alias of the instance.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'An unknown error occurred.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CDB8601-AD74-4A47-8114-08E08CD6****\\",\\n \\"Database\\": {\\n \\"DatabaseId\\": \\"984****\\",\\n \\"Host\\": \\"192.168.XX.XX\\",\\n \\"CatalogName\\": \\"def\\",\\n \\"DbaName\\": \\"dba_name\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"DbaId\\": \\"27****\\",\\n \\"SchemaName\\": \\"mysql\\",\\n \\"InstanceId\\": \\"149****\\",\\n \\"Port\\": 3306,\\n \\"EnvType\\": \\"product\\",\\n \\"Sid\\": \\"test_sid\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"27****\\"\\n ]\\n },\\n \\"Encoding\\": \\"utf8mb4\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"test\\"\\n ]\\n },\\n \\"SearchName\\": \\"[email protected]:3306\\",\\n \\"InstanceAlias\\": \\"test\\"\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"An unknown error occurred.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDatabaseResponse>\\n<RequestId>2EF65A2C-FCDC-5E14-A8B5-8D28F33A****</RequestId>\\n<Database>\\n <SearchName>[email protected]:3306【bw-mysql-el8】</SearchName>\\n <InstanceId>149****</InstanceId>\\n <Port>3306</Port>\\n <Encoding>utf8mb4</Encoding>\\n <Host>192.168.XX.XX</Host>\\n <DatabaseId>984****</DatabaseId>\\n <DbType>mysql</DbType>\\n <EnvType>product</EnvType>\\n <DbaName>dba_name</DbaName>\\n <DbaId>27****</DbaId>\\n <State>NORMAL</State>\\n <CatalogName>def</CatalogName>\\n <OwnerNameList>\\n <OwnerNames>test</OwnerNames>\\n </OwnerNameList>\\n <SchemaName>mysql</SchemaName>\\n <OwnerIdList>\\n <OwnerIds>27****</OwnerIds>\\n </OwnerIdList>\\n</Database>\\n<Success>true</Success>\\n</GetDatabaseResponse>","errorExample":""}]',
+ 'title' => 'GetDatabase',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetPhysicalDatabase' => [
+ 'summary' => 'Queries the details of a physical database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical database. You can call the [SearchDatabase](~~141876~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '43153',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'Database' => [
+ 'description' => 'The information about the physical database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseId' => [
+ 'description' => 'The ID of the physical database.'."\n",
+ 'type' => 'string',
+ 'example' => '43125312',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint that is used to connect to the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-xxxab3r272.mysql.rds.aliyuncs.com',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the catalog to which the database belongs.'."\n"
+ ."\n"
+ .'> : If the database is a PostgreSQL database, the name of the database is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'def',
+ ],
+ 'DbaName' => [
+ 'description' => 'The nickname of the database administrator (DBA) in the destination database.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ 'State' => [
+ 'description' => 'The state of the database. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The database is normal.'."\n"
+ .'* **DISABLE**: The database is disabled.'."\n"
+ .'* **OFFLINE**: The database is unpublished.'."\n"
+ .'* **NOT_EXIST**: The database does not exist.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'DbaId' => [
+ 'description' => 'The user ID of the DBA in the destination database.'."\n",
+ 'type' => 'string',
+ 'example' => '43253',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n"
+ ."\n"
+ .'> : If the database is a PostgreSQL database, the name of the mode is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID of the destination database.'."\n",
+ 'type' => 'string',
+ 'example' => '43215325',
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'Sid' => [
+ 'description' => 'The system ID (SID) of the database.'."\n"
+ ."\n"
+ .'> : The value of the parameter is returned only for Oracle databases.'."\n",
+ 'type' => 'string',
+ 'example' => 'def',
+ ],
+ 'OwnerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerIds' => [
+ 'description' => 'The user IDs of the database owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user ID of the database owner.'."\n",
+ 'type' => 'string',
+ 'example' => '43215325',
+ ],
+ ],
+ ],
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8mb4',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'OwnerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OwnerNames' => [
+ 'description' => 'The nicknames of the database owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the database owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ ],
+ ],
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used for searching the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'InstanceAlias' => [
+ 'description' => 'The alias of the database instance.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"Database\\": {\\n \\"DatabaseId\\": \\"43125312\\",\\n \\"Host\\": \\"rm-xxxab3r272.mysql.rds.aliyuncs.com\\",\\n \\"CatalogName\\": \\"def\\",\\n \\"DbaName\\": \\"dmstest\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"DbaId\\": \\"43253\\",\\n \\"SchemaName\\": \\"dmstest\\",\\n \\"InstanceId\\": \\"43215325\\",\\n \\"Port\\": 3306,\\n \\"EnvType\\": \\"product\\",\\n \\"Sid\\": \\"def\\",\\n \\"OwnerIdList\\": {\\n \\"OwnerIds\\": [\\n \\"43215325\\"\\n ]\\n },\\n \\"Encoding\\": \\"utf8mb4\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"OwnerNameList\\": {\\n \\"OwnerNames\\": [\\n \\"dmstest\\"\\n ]\\n },\\n \\"SearchName\\": \\"[email protected]:3306\\",\\n \\"InstanceAlias\\": \\"test\\"\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetPhysicalDatabaseResponse>\\n <RequestId>4EE2B004-9131-44B7-B6EE-6151B6329F68</RequestId>\\n <Database>\\n <SearchName>[email protected]:3306</SearchName>\\n <InstanceId>1400000</InstanceId>\\n <Port>3306</Port>\\n <Encoding>utf8</Encoding>\\n <Host>rm-uf64e.mysql.rds.aliyuncs.com</Host>\\n <DatabaseId>7000000</DatabaseId>\\n <DbType>mysql</DbType>\\n <EnvType>dev</EnvType>\\n <DbaName>enlun00</DbaName>\\n <DbaId>260000</DbaId>\\n <State>NORMAL</State>\\n <CatalogName>def</CatalogName>\\n <OwnerNameList>\\n <OwnerNames>enlun</OwnerNames>\\n </OwnerNameList>\\n <SchemaName>film</SchemaName>\\n <OwnerIdList>\\n <OwnerIds>26000</OwnerIds>\\n </OwnerIdList>\\n </Database>\\n <Success>true</Success>\\n</GetPhysicalDatabaseResponse>","errorExample":""}]',
+ 'title' => 'GetPhysicalDatabase',
+ ],
+ 'GetTableTopology' => [
+ 'summary' => 'Queries the topology of a table.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table in Data Management (DMS).'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - You can call the [ListLogicTables](~~141875~~) operation with ReturnGuid set to true to query the GUIDs of logical tables in a specific logical database.'."\n"
+ .'> - You can call the [ListTables](~~141878~~) operation with ReturnGuid set to true to query the GUIDs of tables in a specific physical database.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'IDB_L_308302.yuyang_test.test_ch',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the [Tenant information](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F5ED6A40-F344-4C7D-A8F0-5685CA584CA7',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TableTopology' => [
+ 'description' => 'The topology information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableGuid' => [
+ 'description' => 'The GUID of the table in DMS.'."\n",
+ 'type' => 'string',
+ 'example' => 'IDB_L_308302.yuyang_test.test_ch',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_ch',
+ ],
+ 'TableTopologyInfoList' => [
+ 'description' => 'Information of the topology of the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Information of the topology of the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableNameList' => [
+ 'description' => 'The names of tables.'."\n"
+ ."\n"
+ .'> The table names are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => 'test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005',
+ ],
+ 'TableNameExpr' => [
+ 'description' => 'The expression of the names of logical tables.'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'**Description** This parameter is not returned for physical tables.',
+ 'type' => 'string',
+ 'example' => 'test_ch_[0000-0005]',
+ ],
+ 'TableCount' => [
+ 'description' => 'The number of tables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the physical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43215',
+ ],
+ 'DbSearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n"
+ .'> We recommend that you do not use this parameter for business development. The format of the parameter value may be modified in later versions.',
+ 'type' => 'string',
+ 'example' => 'yuyang_test@localhost:3306'."\n"
+ .'[yuyang_test_dev]',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance to which the physical database belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4325325',
+ ],
+ 'RegionId' => [
+ 'description' => 'The region ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'InstanceResourceId' => [
+ 'description' => 'The ID of the resource related to the instance. The resource corresponds with the database instance type returned in the InstanceSource parameter.'."\n"
+ ."\n"
+ .'* **RDS**:The ID of the ApsaraDB RDS instance.'."\n"
+ .'* **ECS_OWN**: The ID of the Elastic Compute Service (ECS) instance.'."\n"
+ .'* **PUBLIC_OWN**: This parameter is left empty for self-managed database instances that are connected over the Internet.'."\n"
+ .'* **VPC_ID**:The ID of the virtual private cloud (VPC).'."\n"
+ .'* **GATEWAY**: The ID of the database gateway.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-xxx',
+ ],
+ 'InstanceSource' => [
+ 'description' => 'The type of the database instance. Valid values:'."\n"
+ ."\n"
+ .'* **RDS**: an ApsaraDB RDS instance.'."\n"
+ .'* **ECS_OWN**: a self-managed database that is deployed on an ECS instance'."\n"
+ .'* **PUBLIC_OWN**: a self-managed database instance that is connected over the Internet.'."\n"
+ .'* **VPC_ID**: a self-managed database instance in a VPC that is connected over Express Connect circuits.'."\n"
+ .'* **GATEWAY**: a database instance connected by using a database gateway.'."\n",
+ 'type' => 'string',
+ 'example' => 'RDS',
+ ],
+ 'DbName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang_test',
+ ],
+ 'DbType' => [
+ 'description' => 'The database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ ],
+ ],
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the table is a logical table. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5ED6A40-F344-4C7D-A8F0-5685CA584CA7\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"TableTopology\\": {\\n \\"TableGuid\\": \\"IDB_L_308302.yuyang_test.test_ch\\",\\n \\"TableName\\": \\"test_ch\\",\\n \\"TableTopologyInfoList\\": [\\n {\\n \\"TableNameList\\": \\"test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005\\",\\n \\"TableNameExpr\\": \\"test_ch_[0000-0005]\\",\\n \\"TableCount\\": 6,\\n \\"DbId\\": 43215,\\n \\"DbSearchName\\": \\"yuyang_test@localhost:3306[yuyang_test_dev]\\",\\n \\"InstanceId\\": 4325325,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceResourceId\\": \\"rm-xxx\\",\\n \\"InstanceSource\\": \\"RDS\\",\\n \\"DbName\\": \\"yuyang_test\\",\\n \\"DbType\\": \\"mysql\\"\\n }\\n ],\\n \\"Logic\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTableTopologyResponse>\\n <RequestId>7A7F0E34-8E21-4CF7-93C8-27212B122145</RequestId>\\n <TableTopology>\\n <TableName>big_table</TableName>\\n <TableGuid>IDB_279000000.film.big_table</TableGuid>\\n <Logic>false</Logic>\\n <TableTopologyInfoList>\\n <DbSearchName>[email protected]:3306【nissi go】</DbSearchName>\\n <InstanceSource>RDS</InstanceSource>\\n <InstanceResourceId>rm-uf00000000240000l</InstanceResourceId>\\n <InstanceId>1000000</InstanceId>\\n <TableNameList>big_table</TableNameList>\\n <TableCount>1</TableCount>\\n <DbId>4000000</DbId>\\n <DbName>film</DbName>\\n <RegionId>cn-shanghai</RegionId>\\n <DbType>mysql</DbType>\\n </TableTopologyInfoList>\\n </TableTopology>\\n <Success>true</Success> \\n</GetTableTopologyResponse>","errorExample":""}]',
+ 'title' => 'GetTableTopology',
+ ],
+ 'GetMetaTableDetailInfo' => [
+ 'summary' => 'Queries the details of columns and indexes in a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms1KPGDT',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the Manage DMS tenants topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table in Data Management (DMS).'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* You can call the [ListLogicTables](~~141875~~) operation with ReturnGuid set to true to query the GUIDs of logical tables in a specific logical database.'."\n"
+ ."\n"
+ .'* You can call the [ListTables](~~141878~~) operation with ReturnGuid set to true to query the GUIDs of tables in a specific physical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'IDB_L_9032.db-test.yuyang_test',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E881CB2F-DE42-42E5-90EB-8B3173DCB9B9',
+ ],
+ 'DetailInfo' => [
+ 'description' => 'The details of the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexList' => [
+ 'description' => 'The list of indexes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexColumns' => [
+ 'description' => 'The index column.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The fields in the index.'."\n",
+ 'type' => 'string',
+ 'example' => 'id',
+ ],
+ ],
+ 'IndexName' => [
+ 'description' => 'The name of the index.'."\n",
+ 'type' => 'string',
+ 'example' => 'PRIMARY',
+ ],
+ 'Unique' => [
+ 'description' => 'Indicates whether the index is unique. Valid values:'."\n"
+ ."\n"
+ .'* true: The index is unique.'."\n"
+ .'* false: The index is not unique.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'IndexType' => [
+ 'description' => 'The type of the index. Examples: Primary, Unique, and Normal.'."\n",
+ 'type' => 'string',
+ 'example' => 'Primary',
+ ],
+ 'IndexId' => [
+ 'description' => 'The ID of the index.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ 'ColumnList' => [
+ 'description' => 'The columns in the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'id',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DataScale' => [
+ 'description' => 'The scale of the column.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'DataPrecision' => [
+ 'description' => 'The precision of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the column. Examples: Bigint, Int, and Varchar.'."\n",
+ 'type' => 'string',
+ 'example' => 'bigint(20) unsigned',
+ ],
+ 'AutoIncrement' => [
+ 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n"
+ ."\n"
+ .'* true: The column is an auto-increment column.'."\n"
+ .'* false: The column is not an auto-increment column.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Position' => [
+ 'description' => 'The position of the field in the table.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Nullable' => [
+ 'description' => 'Indicates whether the column is nullable. Valid values:'."\n"
+ ."\n"
+ .'* true: The column is nullable.'."\n"
+ .'* false: The column is not nullable.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ColumnId' => [
+ 'description' => 'The ID of the column.'."\n",
+ 'type' => 'string',
+ 'example' => '191234849',
+ ],
+ 'DataLength' => [
+ 'description' => 'The length of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E881CB2F-DE42-42E5-90EB-8B3173DCB9B9\\",\\n \\"DetailInfo\\": {\\n \\"IndexList\\": [\\n {\\n \\"IndexColumns\\": [\\n \\"id\\"\\n ],\\n \\"IndexName\\": \\"PRIMARY\\",\\n \\"Unique\\": false,\\n \\"IndexType\\": \\"Primary\\",\\n \\"IndexId\\": \\"123\\"\\n }\\n ],\\n \\"ColumnList\\": [\\n {\\n \\"ColumnName\\": \\"id\\",\\n \\"Description\\": \\"test\\",\\n \\"DataScale\\": 0,\\n \\"DataPrecision\\": 0,\\n \\"ColumnType\\": \\"bigint(20) unsigned\\",\\n \\"AutoIncrement\\": true,\\n \\"Position\\": \\"1\\",\\n \\"Nullable\\": false,\\n \\"ColumnId\\": \\"191234849\\",\\n \\"DataLength\\": 0\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E881CB2F-DE42-42E5-90EB-8B3173DCB9B9</RequestId>\\n<DetailInfo>\\n <ColumnList>\\n <ColumnId>191234849</ColumnId>\\n <ColumnName>id</ColumnName>\\n <Description>test</Description>\\n <ColumnType>bigint(20) unsigned</ColumnType>\\n <Position>1</Position>\\n <AutoIncrement>true</AutoIncrement>\\n <DataScale>0</DataScale>\\n <DataPrecision>20</DataPrecision>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <ColumnList>\\n <ColumnId>191234850</ColumnId>\\n <ColumnName>gmt_create</ColumnName>\\n <Description>test</Description>\\n <ColumnType>datetime</ColumnType>\\n <Position>2</Position>\\n <AutoIncrement>false</AutoIncrement>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <ColumnList>\\n <ColumnId>191234851</ColumnId>\\n <ColumnName>gmt_modified</ColumnName>\\n <Description>test</Description>\\n <ColumnType>datetime</ColumnType>\\n <Position>3</Position>\\n <AutoIncrement>false</AutoIncrement>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <IndexList>\\n <IndexName>PRIMARY</IndexName>\\n <IndexId>33008763</IndexId>\\n <IndexColumns>id</IndexColumns>\\n <Unique>false</Unique>\\n <IndexType>Primary</IndexType>\\n </IndexList>\\n</DetailInfo>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetMetaTableDetailInfo',
+ 'description' => 'You can call this operation only for database instances whose control mode is Security Collaboration.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetMetaTableColumn' => [
+ 'summary' => 'Queries the details of columns in a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The globally unique identifier (GUID) of the table in Data Management (DMS).'."\n"
+ ."\n"
+ .'* If the database to which the table belongs is a logical database, you can call the [ListLogicTables](~~141875~~) operation to obtain the value of this parameter.'."\n"
+ .'* If the database to which the table belongs is a physical database, you can call the [ListTables](~~141878~~) operation to obtain the value of this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'IDB_40753****.qntest2.activity_setting',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '087DFBA1-378B-5D25-B13B-31F6409F****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingTableGuid',
+ ],
+ 'ColumnList' => [
+ 'description' => 'The details about fields in the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnType' => [
+ 'description' => 'The data type of the column.'."\n"
+ ."\n"
+ .'> The return value of a column is not unique, such as **bigint** or **int**.'."\n",
+ 'type' => 'string',
+ 'example' => 'bigint(1)',
+ ],
+ 'AutoIncrement' => [
+ 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The column is an auto-increment column.'."\n"
+ .'* **false**: The column is not an auto-increment column.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ColumnId' => [
+ 'description' => 'The ID of the column.'."\n",
+ 'type' => 'string',
+ 'example' => '63513****',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'has_promotion',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The sensitivity level of the column. Valid values:'."\n"
+ ."\n"
+ .'* **INNER**: The column is not sensitive.'."\n"
+ .'* **SENSITIVE**: The column is sensitive.'."\n"
+ .'* **CONFIDENTIAL**: The column is confidential.'."\n"
+ ."\n"
+ .'> For more information, see [Sensitivity levels of columns](~~66091~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'INNER',
+ ],
+ 'PrimaryKey' => [
+ 'description' => 'Indicates whether the field is the primary key. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The field is the primary key.'."\n"
+ .'* **false**: The field is not the primary key.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'Whether discounts are provided'."\n",
+ ],
+ 'DataPrecision' => [
+ 'description' => 'The precision of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '19',
+ ],
+ 'DataScale' => [
+ 'description' => 'The number of decimal places for the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Position' => [
+ 'description' => 'The position of the field in the table.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Nullable' => [
+ 'description' => 'Indicates whether the field can be empty. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The field can be empty.'."\n"
+ .'* **false**: The field cannot be empty.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DataLength' => [
+ 'description' => 'The length of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'TableGuid is mandatory for this action.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"087DFBA1-378B-5D25-B13B-31F6409F****\\",\\n \\"ErrorCode\\": \\"MissingTableGuid\\",\\n \\"ColumnList\\": [\\n {\\n \\"ColumnType\\": \\"bigint(1)\\",\\n \\"AutoIncrement\\": false,\\n \\"ColumnId\\": \\"63513****\\",\\n \\"ColumnName\\": \\"has_promotion\\",\\n \\"SecurityLevel\\": \\"INNER\\",\\n \\"PrimaryKey\\": \\"true\\",\\n \\"Description\\": \\"是否有优惠活动\\",\\n \\"DataPrecision\\": 19,\\n \\"DataScale\\": 0,\\n \\"Position\\": 1,\\n \\"Nullable\\": false,\\n \\"DataLength\\": 0\\n }\\n ],\\n \\"ErrorMessage\\": \\"TableGuid is mandatory for this action.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableColumnResponse>\\n <RequestId>087DFBA1-378B-5D25-B13B-31F6409F****</RequestId>\\n <ColumnList>\\n <ColumnId>63513****</ColumnId>\\n <ColumnName>has_promotion</ColumnName>\\n <Description>是否有优惠活动</Description>\\n <ColumnType>bigint(1)</ColumnType>\\n <Position>1</Position>\\n <AutoIncrement>false</AutoIncrement>\\n <SecurityLevel>INNER</SecurityLevel>\\n <DataScale>0</DataScale>\\n <DataPrecision>19</DataPrecision>\\n <PrimaryKey>true</PrimaryKey>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <ColumnList>\\n <ColumnId>63513****</ColumnId>\\n <ColumnName>consumption_limit</ColumnName>\\n <Description>消费额限制</Description>\\n <ColumnType>int(11)</ColumnType>\\n <Position>2</Position>\\n <AutoIncrement>false</AutoIncrement>\\n <SecurityLevel>INNER</SecurityLevel>\\n <DataScale>0</DataScale>\\n <DataPrecision>10</DataPrecision>\\n <PrimaryKey>false</PrimaryKey>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <ColumnList>\\n <ColumnId>63513****</ColumnId>\\n <ColumnName>quota</ColumnName>\\n <Description>发放优惠券额度</Description>\\n <ColumnType>int(11)</ColumnType>\\n <Position>3</Position>\\n <AutoIncrement>false</AutoIncrement>\\n <SecurityLevel>INNER</SecurityLevel>\\n <DataScale>0</DataScale>\\n <DataPrecision>10</DataPrecision>\\n <PrimaryKey>false</PrimaryKey>\\n <Nullable>false</Nullable>\\n </ColumnList>\\n <Success>true</Success>\\n</GetMetaTableColumnResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableColumn',
+ 'description' => 'You can call this operation only for database instances whose control mode is Security Collaboration.'."\n",
+ ],
+ 'SyncInstanceMeta' => [
+ 'summary' => 'Synchronizes the metadata of all databases in a database instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the Manage DMS tenants topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12***',
+ ],
+ ],
+ [
+ 'name' => 'IgnoreTable',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip synchronization for the metadata of table dictionaries. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A99CD576-1E18-4E86-931E-C3CCE56DC030',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'Details about the topology of the data table.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A99CD576-1E18-4E86-931E-C3CCE56DC030\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SyncInstanceMetaResponse>\\n <RequestId>A99CD576-1E18-4E86-931E-C3CCE56DC030</RequestId>\\n <Success>true</Success>\\n</SyncInstanceMetaResponse>","errorExample":""}]',
+ 'title' => 'SyncInstanceMeta',
+ 'description' => 'You can call this operation only for database instances whose control mode is Security Collaboration.'."\n",
+ ],
+ 'SyncDatabaseMeta' => [
+ 'summary' => 'Synchronizes the metadata of a database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A99CD576-1E18-4E86-931E-C3CCE56DC030',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A99CD576-1E18-4E86-931E-C3CCE56DC030\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SyncDatabaseMeta',
+ ],
+ 'GetTableKnowledgeInfo' => [
+ 'summary' => 'Gets metadata knowledge for a specified GUID.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249769',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableSchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dbo',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical database. You can call the [SearchDatabase](~~141876~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '325',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Table' => [
+ 'description' => 'The information about the table.'."\n",
+ 'example' => 'bill_orders',
+ '$ref' => '#/components/schemas/TableKnowledgeInfo',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Table\\": {\\n \\"TableName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"AssetDescription\\": \\"\\",\\n \\"Summary\\": \\"\\",\\n \\"ColumnList\\": [\\n {\\n \\"ColumnName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"ColumnType\\": \\"\\",\\n \\"Position\\": 0,\\n \\"AssetDescription\\": \\"\\",\\n \\"AssetModifiedGmt\\": \\"\\"\\n }\\n ],\\n \\"AssetModifiedGmt\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetTableKnowledgeInfo',
+ 'description' => 'This API can be called only for database instances that are enabled for security hosting.'."\n",
+ ],
+ 'EditMetaKnowledgeAsset' => [
+ 'summary' => 'Edits the metadata business knowledge for specified GUIDs.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249769',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms90TD19',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableSchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dbo',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. This parameter is used when the edited content is a field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'AssetDescription',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Business knowledge content edited by users.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical database. You can call the [SearchDatabase](~~141876~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1930****',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '',
+ 'description' => 'Request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\"\\n}","type":"json"}]',
+ 'title' => 'EditMetaKnowledgeAsset',
+ 'description' => 'Edits the business knowledge of the metadata represented by the specified GUID.'."\n",
+ ],
+ 'CreateOrder' => [
+ 'summary' => 'Creates a ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms25Q07S',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the ticket to be created.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'PluginParam',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The ticket creation parameter. The value is a JSON string. The value of this parameter differs based on the type of the ticket. For more information, see the **PluginParam parameter** section in this topic.'."\n",
+ 'type' => 'object',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{PluginParam_test}',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of the stakeholders that are involved in the ticket. Separate multiple IDs with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'user1,user2',
+ ],
+ ],
+ [
+ 'name' => 'PluginType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the ticket. For more information, see [PluginType parameter](~~429109~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATA_EXPORT',
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of an attachment that is returned after the attachment is uploaded. You can call the [GetUserUploadFileJob](~~206069~~) operation to query the key of the attachment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_AttachmentKey',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateOrderResult' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OrderIds' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"CreateOrderResult\\": {\\n \\"OrderIds\\": [\\n 0\\n ]\\n },\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateOrderResponse>\\n <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6****</RequestId>\\n <CreateOrderResult>\\n <OrderIds>12***</OrderIds>\\n </CreateOrderResult>\\n <Success>true</Success>\\n</CreateOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateOrder',
+ 'description' => 'To facilitate ticket creation, you can call the following dedicated operations to create some types of tickets:'."\n"
+ ."\n"
+ .'* [CreateDataCorrectOrder](~~208388~~): creates a regular data change ticket.'."\n"
+ .'* [CreateDataCronClearOrder](~~208385~~): creates a ticket to clear historical data.'."\n"
+ .'* [CreateDataImportOrder](~~208387~~): creates a data import ticket.'."\n"
+ .'* [CreateFreeLockCorrectOrder](~~208386~~): creates a lock-free change ticket.'."\n",
+ 'requestParamsDescription' => '## PluginParam parameter'."\n"
+ ."\n"
+ .'```'."\n"
+ ."\n"
+ .'# Change a schema design.'."\n"
+ .' {'."\n"
+ .' "title": "test", // The name of the ticket.'."\n"
+ .' "description": "test", // The description of the ticket.'."\n"
+ .' "dbId": 11****, // The database to which changes are made.'."\n"
+ .' "logic": false, // Specifies whether the database is a logical database.'."\n"
+ .' "relatedIds": [], // The IDs of the stakeholders that are involved in the ticket.'."\n"
+ .' }'."\n"
+ ."\n"
+ .'# Export data.'."\n"
+ .' {'."\n"
+ .' "classify": "Reason", // The purpose of the ticket.'."\n"
+ .' "dbId": 17****, // The ID of the database from which data is exported.'."\n"
+ .' "exeSQL": "select 1", // The SQL statement that is executed to export data.'."\n"
+ .' "logic": false, // Specifies whether the database is a logical database.'."\n"
+ .' "ignoreAffectRows": false, // Specifies whether to ignore the affected rows.'."\n"
+ .' "affectRows": 1, // The estimated number of affected rows.'."\n"
+ .' "ignoreAffectRowsReason": "" // The reason for ignoring the affected rows.'."\n"
+ .' }'."\n"
+ ."\n"
+ .'If you need to create more types of tickets, submit a ticket for consultation. '."\n"
+ .'```'."\n",
+ ],
+ 'GetApprovalDetail' => [
+ 'summary' => 'Queries the approval details of a ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'WorkflowInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the approval process. You can call the [GetOrderBaseInfo](~~144642~~) operation to obtain the ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '184****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '66DE630B-ECA1-52A3-9198-602066F9****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingWorkflowInstanceId',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'WorkflowInstanceId is mandatory for this action.',
+ ],
+ 'ApprovalDetail' => [
+ 'description' => 'The approval details of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkflowNodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WorkflowNode' => [
+ 'description' => 'The details of approval nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OperateTime' => [
+ 'description' => 'The time when the ticket was submitted.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-10-15 13:47:54',
+ ],
+ 'OperatorId' => [
+ 'description' => 'The ID of the user who submitted the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'DBA',
+ ],
+ 'AuditUserIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuditUserIds' => [
+ 'description' => 'The IDs of the approvers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the approver.'."\n",
+ 'type' => 'string',
+ 'example' => '10****',
+ ],
+ ],
+ ],
+ ],
+ 'OperateComment' => [
+ 'description' => 'The remarks of the approval.'."\n",
+ 'type' => 'string',
+ 'example' => 'Reason: Approved'."\n",
+ ],
+ 'WorkflowInsCode' => [
+ 'description' => 'The approval status of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **START**: The ticket was submitted.'."\n"
+ .'* **ERROR**: An error occurred.'."\n"
+ .'* **AUDITING**: The ticket is being reviewed.'."\n"
+ .'* **REJECT**: The ticket was rejected.'."\n"
+ .'* **CANCEL**: The ticket was revoked.'."\n"
+ .'* **APPROVED**: The ticket was approved.'."\n",
+ 'type' => 'string',
+ 'example' => 'APPROVED',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Description' => [
+ 'description' => 'The description of the approval process.'."\n",
+ 'type' => 'string',
+ 'example' => '\\[Instance permissions] Application\\<br/>Permission type: ⌈Logon⌋\\<br/>Application period: 30.0 days\\<br/>Background description: \\[Instance permissions] logon test\\<br/>\\<br/>\\[Application list]\\<br/>\\<span style=\'color:red\'>product\\</span> rm-bp144d5ky4l4rli0417\\*\\*\\*\\*.mysql.rds.aliyuncs.com:3306 - PRODUCT\\<br/>'."\n",
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the approval process was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-10-29 14:17:25',
+ ],
+ 'CurrentHandlers' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CurrentHandler' => [
+ 'description' => 'The information about the approver.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'NickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'nickName',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'OrderType' => [
+ 'description' => 'The type of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **NDDL**: a schema design ticket'."\n"
+ .'* **DATA_TRACK**: a data tracking ticket'."\n"
+ .'* **TABLE_SYNC**: a table synchronization ticket'."\n"
+ .'* **PERM_APPLY**: a permission application ticket'."\n"
+ .'* **DATA_EXPORT**: a data export ticket'."\n"
+ .'* **DATA_CORRECT**: a data change ticket'."\n"
+ .'* **OWNER_APPLY**: an owner role application ticket'."\n"
+ .'* **SENSITIVITY**: a column sensitivity level change ticket'."\n",
+ 'type' => 'string',
+ 'example' => 'PERM_APPLY',
+ ],
+ 'Title' => [
+ 'description' => 'The title of the approval process.'."\n",
+ 'type' => 'string',
+ 'example' => 'Permission application ticket - 384\\*\\*\\*\\*'."\n",
+ ],
+ 'AuditId' => [
+ 'description' => 'The ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '184****',
+ ],
+ 'OrderId' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '384****',
+ ],
+ 'WorkflowInsCode' => [
+ 'description' => 'The approval status of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **AUDITING**: The ticket is being reviewed.'."\n"
+ .'* **REJECT**: The ticket was rejected.'."\n"
+ .'* **CANCEL**: The ticket was revoked.'."\n"
+ .'* **APPROVED**: The ticket was approved.'."\n"
+ ."\n"
+ .'> An approval process contains multiple approval nodes, and this parameter is returned for each approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'APPROVED',
+ ],
+ 'ReasonList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Reasons' => [
+ 'description' => 'The reasons for the approval.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The reason for the approval.'."\n",
+ 'type' => 'string',
+ 'example' => 'According to security rules, permission applications need to be approved.'."\n",
+ ],
+ ],
+ ],
+ ],
+ 'TemplateId' => [
+ 'title' => '工作流模板ID',
+ 'description' => 'The ID of the workflow template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ThirdpartyWorkflowUrl' => [
+ 'description' => 'The third-party approval flow link.',
+ 'type' => 'string',
+ 'example' => 'https://xxx',
+ ],
+ 'ThirdpartyWorkflowComment' => [
+ 'description' => 'Third-party approval flow remarks.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"66DE630B-ECA1-52A3-9198-602066F9****\\",\\n \\"ErrorCode\\": \\"MissingWorkflowInstanceId\\",\\n \\"ErrorMessage\\": \\"WorkflowInstanceId is mandatory for this action.\\",\\n \\"ApprovalDetail\\": {\\n \\"WorkflowNodes\\": {\\n \\"WorkflowNode\\": [\\n {\\n \\"OperateTime\\": \\"2019-10-15 13:47:54\\",\\n \\"OperatorId\\": 0,\\n \\"NodeName\\": \\"DBA\\",\\n \\"AuditUserIdList\\": {\\n \\"AuditUserIds\\": [\\n \\"10****\\"\\n ]\\n },\\n \\"OperateComment\\": \\"理由：同意\\",\\n \\"WorkflowInsCode\\": \\"APPROVED\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"【实例权限】申请<br/>权限类型：「登录」<br/>申请期限：30.0 days<br/>背景描述：【实例权限】test登录<br/><br/>【申请列表】<br/><span style=\'color:red\'>product</span> rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT<br/>\\",\\n \\"CreateTime\\": \\"2021-10-29 14:17:25\\",\\n \\"CurrentHandlers\\": {\\n \\"CurrentHandler\\": [\\n {\\n \\"NickName\\": \\"nickName\\",\\n \\"Id\\": 1\\n }\\n ]\\n },\\n \\"OrderType\\": \\"PERM_APPLY\\",\\n \\"Title\\": \\"权限申请工单-384****\\",\\n \\"AuditId\\": 0,\\n \\"OrderId\\": 0,\\n \\"WorkflowInsCode\\": \\"APPROVED\\",\\n \\"ReasonList\\": {\\n \\"Reasons\\": [\\n \\"根据安全规则，权限申请需要审批\\"\\n ]\\n },\\n \\"TemplateId\\": 1234,\\n \\"ThirdpartyWorkflowUrl\\": \\"https://xxx\\",\\n \\"ThirdpartyWorkflowComment\\": \\"test\\"\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetApprovalDetailResponse>\\n <RequestId>66DE630B-ECA1-52A3-9198-602066F9****</RequestId>\\n <ErrorCode>MissingWorkflowInstanceId</ErrorCode>\\n <ErrorMessage>WorkflowInstanceId is mandatory for this action.</ErrorMessage>\\n <ApprovalDetail>\\n <WorkflowNodes>\\n <OperateTime>2019-10-15 13:47:54</OperateTime>\\n <NodeName>DBA</NodeName>\\n <AuditUserIdList>10****</AuditUserIdList>\\n <OperateComment>理由：同意</OperateComment>\\n <WorkflowInsCode>APPROVED</WorkflowInsCode>\\n </WorkflowNodes>\\n <Description>【实例权限】申请&lt;br/&gt;权限类型：「登录」&lt;br/&gt;申请期限：30.0 days&lt;br/&gt;背景描述：【实例权限】test登录&lt;br/&gt;&lt;br/&gt;【申请列表】&lt;br/&gt;&lt;span style=\'color:red\'&gt;product&lt;/span&gt; rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT&lt;br/&gt;</Description>\\n <CreateTime>2021-10-29 14:17:25</CreateTime>\\n <CurrentHandlers>\\n <NickName>nickName</NickName>\\n <Id>1</Id>\\n </CurrentHandlers>\\n <OrderType>PERM_APPLY</OrderType>\\n <Title>权限申请工单-384****</Title>\\n <WorkflowInsCode>APPROVED</WorkflowInsCode>\\n <ReasonList>根据安全规则，权限申请需要审批</ReasonList>\\n <TemplateId>1234</TemplateId>\\n </ApprovalDetail>\\n <Success>true</Success>\\n</GetApprovalDetailResponse>","errorExample":""}]',
+ 'title' => 'GetApprovalDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListOrders' => [
+ 'summary' => 'Queries tickets.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3000',
+ ],
+ ],
+ [
+ 'name' => 'PluginType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the tickets that you want to query. For more information, see [PluginType parameter](~~429109~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DC_COMMON',
+ ],
+ ],
+ [
+ 'name' => 'OrderResultType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The scope of the tickets that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* **AS_ADMIN**: all tickets.'."\n"
+ .'* **AS_COMMITTER**: the tickets that are submitted by the current user.'."\n"
+ .'* **AS_HANDLER**: the tickets to be processed by the current user.'."\n"
+ .'* **AS_OWNER**: the tickets that are processed by the current user.'."\n"
+ .'* **AS_Related**: the tickets that are related to the current user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AS_ADMIN',
+ ],
+ ],
+ [
+ 'name' => 'SearchDateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time condition based on which you want to query tickets. Valid values:'."\n"
+ ."\n"
+ .'* **CREATE_TIME**: the time when a ticket was created.'."\n"
+ .'* **MODIFY_TIME**: the time when a ticket was last modified.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CREATE_TIME',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2022-04-08 11:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2022-04-09 11:00:00',
+ ],
+ ],
+ [
+ 'name' => 'SearchContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to query tickets.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'OrderStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the tickets that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* **ALL**: queries the tickets of all statuses.'."\n"
+ .'* **FINISHED**: queries the tickets that are completed.'."\n"
+ .'* **RUNNING**: queries the tickets that are being processed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ALL',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Orders' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Order' => [
+ 'description' => 'The details about the tickets.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'description' => 'The remarks of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'LastModifyTime' => [
+ 'description' => 'The time when the ticket was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-04-08 11:27:45',
+ ],
+ 'StatusCode' => [
+ 'description' => 'The status code of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **fail**: The ticket fails to be executed.'."\n"
+ .'* **toaudit**: The ticket is waiting for approval.'."\n"
+ .'* **cancel**: The ticket is cancelled.'."\n"
+ .'* **processing**: The ticket is being executed.'."\n"
+ .'* **approved**: The ticket is approved.'."\n"
+ .'* **reject**: The ticket is rejected.'."\n"
+ .'* **success**: The ticket is executed.'."\n"
+ .'* **closed**: The ticket is closed.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the ticket was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-04-08 11:15:46',
+ ],
+ 'Committer' => [
+ 'description' => 'The user who submitted the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CommitterId' => [
+ 'description' => 'The ID of the user who submitted the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The status description of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'changed successfully',
+ ],
+ 'PluginType' => [
+ 'description' => 'The type of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'DC_COMMON',
+ ],
+ 'OrderId' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries that are returned.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Orders\\": {\\n \\"Order\\": [\\n {\\n \\"Comment\\": \\"test\\",\\n \\"LastModifyTime\\": \\"2022-04-08 11:27:45\\",\\n \\"StatusCode\\": \\"success\\",\\n \\"CreateTime\\": \\"2022-04-08 11:15:46\\",\\n \\"Committer\\": \\"test\\",\\n \\"CommitterId\\": 0,\\n \\"StatusDesc\\": \\"变更成功\\",\\n \\"PluginType\\": \\"DC_COMMON\\",\\n \\"OrderId\\": 0\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListOrdersResponse>\\n <Orders>\\n <Comment>test</Comment>\\n <LastModifyTime>2022-04-08 11:27:45</LastModifyTime>\\n <StatusCode>success</StatusCode>\\n <CreateTime>2022-04-08 11:15:46</CreateTime>\\n <Committer>test</Committer>\\n <StatusDesc>变更成功</StatusDesc>\\n <PluginType>DC_COMMON</PluginType>\\n </Orders>\\n <TotalCount>1</TotalCount>\\n <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</ListOrdersResponse>","errorExample":""}]',
+ 'title' => 'ListOrders',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetOrderBaseInfo' => [
+ 'summary' => 'Queries the basic information about a ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderBaseInfo' => [
+ 'description' => 'The basic information about the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RelatedUserNickList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'UserNicks' => [
+ 'description' => 'The nicknames of the operators that are related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the operator that is related to the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'nickname',
+ ],
+ ],
+ ],
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the ticket was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-10-10 00:00:00',
+ ],
+ 'Committer' => [
+ 'description' => 'The applicant.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'WorkflowInstanceId' => [
+ 'description' => 'The ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CommitterId' => [
+ 'description' => 'The ID of the applicant. Note: The ID is different from the Alibaba Cloud account ID of the applicant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'LastModifyTime' => [
+ 'description' => 'The time when the ticket was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-10-10 00:00:00',
+ ],
+ 'StatusCode' => [
+ 'description' => 'The status code of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **new**: The ticket is created.'."\n"
+ .'* **toaudit**: The ticket is being reviewed.'."\n"
+ .'* **Approved**: The ticket is approved.'."\n"
+ .'* **reject**: The ticket is rejected.'."\n"
+ .'* **processing**: The ticket is being executed.'."\n"
+ .'* **success**: The ticket is executed.'."\n"
+ .'* **closed**: The ticket is closed.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'RelatedUserList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'UserIds' => [
+ 'description' => 'The IDs of the operators that are related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the operator that is related to the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'WorkflowStatusDesc' => [
+ 'description' => 'The description of the approval process.'."\n",
+ 'type' => 'string',
+ 'example' => 'approved',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the status.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'PluginType' => [
+ 'description' => 'The type of the ticket. For more information about the value of this parameter, see the request parameters of the [CreateOrder](~~465865~~) operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'DC_COMMON',
+ ],
+ 'OrderId' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'AttachmentKey' => [
+ 'description' => 'The Key of the ticket attachment. This information is returned only when an attachment is uploaded when a ticket is created.',
+ 'type' => 'string',
+ 'example' => 'upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png',
+ ],
+ 'OriginAttachmentName' => [
+ 'description' => 'The original file name of the ticket attachment. This information is returned only when an attachment is uploaded when a ticket is created.',
+ 'type' => 'string',
+ 'example' => '18072d8a9bce876e3073bc655c2865f.png',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7133DF67-5B25-460F-8285-C4CC93472C2F',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderBaseInfo\\": {\\n \\"RelatedUserNickList\\": {\\n \\"UserNicks\\": [\\n \\"nickname\\"\\n ]\\n },\\n \\"Comment\\": \\"test\\",\\n \\"CreateTime\\": \\"2019-10-10 00:00:00\\",\\n \\"Committer\\": \\"xxx\\",\\n \\"WorkflowInstanceId\\": 1,\\n \\"CommitterId\\": 1,\\n \\"LastModifyTime\\": \\"2019-10-10 00:00:00\\",\\n \\"StatusCode\\": \\"success\\",\\n \\"RelatedUserList\\": {\\n \\"UserIds\\": [\\n \\"1\\"\\n ]\\n },\\n \\"WorkflowStatusDesc\\": \\"approved\\",\\n \\"StatusDesc\\": \\"success\\",\\n \\"PluginType\\": \\"DC_COMMON\\",\\n \\"OrderId\\": 12345,\\n \\"AttachmentKey\\": \\"upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png\\",\\n \\"OriginAttachmentName\\": \\"18072d8a9bce876e3073bc655c2865f.png\\"\\n },\\n \\"RequestId\\": \\"7133DF67-5B25-460F-8285-C4CC93472C2F\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<OrderBaseInfo>\\n <Comment>test</Comment>\\n <CreateTime>2019-10-10 00:00:00</CreateTime>\\n <LastModifyTime>2019-10-10 00:00:00</LastModifyTime>\\n <OrderId>12345</OrderId>\\n <CommitterId>1</CommitterId>\\n <PluginType>DC_COMMON</PluginType>\\n <StatusCode>success</StatusCode>\\n <RelatedUserNickList>\\n <UserNicks>a,b,c</UserNicks>\\n </RelatedUserNickList>\\n <StatusDesc>success</StatusDesc>\\n <WorkflowStatusDesc>approved</WorkflowStatusDesc>\\n <WorkflowInstanceId>1</WorkflowInstanceId>\\n <Committer>xxx</Committer>\\n <RelatedUserList>\\n <UserIds>1,2,3</UserIds>\\n </RelatedUserList>\\n</OrderBaseInfo>\\n<RequestId>7133DF67-5B25-460F-8285-C4CC93472C2F</RequestId>\\n<ErrorCode>UnknownError</ErrorCode>\\n<ErrorMessage>UnknownError</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetOrderBaseInfo',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SubmitOrderApproval' => [
+ 'summary' => 'Submits a ticket for approval.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '12592',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms25Q07S',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to call the API operation.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SubmitOrderApproval',
+ ],
+ 'ApproveOrder' => [
+ 'summary' => 'Reviews a ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '12542',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms25Q07S',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'WorkflowInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the approval process. You can call the [GetOrderBaseInfo](~~144642~~) operation to obtain the ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ApprovalType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The action that you want to perform on the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **AGREE**'."\n"
+ .'* **CANCEL**'."\n"
+ .'* **REJECT**'."\n"
+ .'* **TRANSFER**'."\n"
+ .'* **ADD_APPROVAL_NODE**'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'REJECT' => 'REJECT',
+ 'ADD_APPROVAL_NODE' => 'ADD_APPROVAL_NODE',
+ 'TRANSFER' => 'TRANSFER',
+ 'CANCEL' => 'CANCEL',
+ 'AGREE' => 'AGREE',
+ ],
+ 'example' => 'agree',
+ 'enum' => [
+ 'AGREE',
+ 'CANCEL',
+ 'REJECT',
+ 'TRANSFER',
+ 'ADD_APPROVAL_NODE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'NewApprover',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user to which the ticket is transferred. If ApprovalType is set to TRANSFER, you need to specify this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12***',
+ ],
+ ],
+ [
+ 'name' => 'OldApprover',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user that transfers the ticket to another user. The default value is the ID of the current user. If the current user is an administrator or a database administrator (DBA), the user can change the value of this parameter to the ID of another user.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '23***',
+ ],
+ ],
+ [
+ 'name' => 'ApprovalNodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'If ApprovalType is set to ADD_APPROVAL_NODE, you need to specify this parameter. The ID of the user that is added as the new approval node. This node must be a user-defined approval node. You can call the ListUserDefineWorkFlowNodes operation to obtain the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ApprovalNodePos',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The position of the new approval node. You must specify this parameter if ApprovalType is set to ADD_APPROVAL_NODE. Valid values:'."\n"
+ ."\n"
+ .'* **PRE_ADD_APPROVAL_NODE**: before the current approval node.'."\n"
+ .'* **POST_ADD_APPROVAL_NODE**: after the current approval node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'POST_ADD_APPROVAL_NODE',
+ 'enum' => [
+ 'POST_ADD_APPROVAL_NODE',
+ 'PRE_ADD_APPROVAL_NODE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NewApproverList',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> You can specify this parameter if ApprovalType is set to TRANSFER. You need to only specify one of NewApproverList and NewApprover.'."\n"
+ ."\n"
+ .'The IDs of the users to whom the ticket is transferred. Separate multiple IDs with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '154***,155***,156***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account that actually calls the API.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ApproveOrderResponse>\\n <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>\\n <Success>true</Success>\\n</ApproveOrderResponse>","errorExample":""}]',
+ 'title' => 'ApproveOrder',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CloseOrder' => [
+ 'summary' => 'Closes a ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1343',
+ ],
+ ],
+ [
+ 'name' => 'CloseReason',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The reason why the ticket is closed.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'close reason',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CloseOrder',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetOrderAttachmentFile' => [
+ 'summary' => 'Queries the download URL of the attachment of a ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned. Take note of the following rules:'."\n"
+ ."\n"
+ .'* The **ErrorCode** parameter is not returned if the request is successful.'."\n"
+ .'* The **ErrorCode** parameter is returned if the request fails. For more information, see the **Error codes** section of this topic.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'FileUrl' => [
+ 'description' => 'The download URL of the attachment.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://dmsxxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"FileUrl\\": \\"https://dmsxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOrderAttachmentFileResponse>\\n <RequestId>FE8EE2F1-4880-46BC-A704-5CF63EAF9A04</RequestId>\\n <Success>true</Success>\\n <FileUrl>https://dmsxxx</FileUrl>\\n</GetOrderAttachmentFileResponse>","errorExample":""}]',
+ 'title' => 'GetOrderAttachmentFile',
+ ],
+ 'PreviewWorkflow' => [
+ 'summary' => 'Previews the approval process of a ticket before the ticket is submitted.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1069****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '23****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'WorkflowDetail' => [
+ 'description' => 'The details of the workflow.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WfCateName' => [
+ 'description' => 'The name of the approval template.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the approval template.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'WorkflowNodeList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'WorkflowNode' => [
+ 'description' => 'The approval nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeName' => [
+ 'description' => 'The name of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Owner',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the approval node.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* USER_LIST: The approval node is created by a user.'."\n"
+ .'* UNKNOWN: The source of the approval node is unknown.'."\n"
+ .'* SYS: The approval node is predefined by the system.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'USER_LIST' => '',
+ 'UNKNOWN' => '',
+ 'SYS' => '',
+ ],
+ 'example' => 'SYS',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the approval node.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'AuditUserList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuditUser' => [
+ 'description' => 'The approvers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The ID of the approver.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '16***',
+ ],
+ 'NickName' => [
+ 'description' => 'The nickname of the approver.'."\n",
+ 'type' => 'string',
+ 'example' => 'Owner',
+ ],
+ 'RealName' => [
+ 'description' => 'The name of the approver.'."\n",
+ 'type' => 'string',
+ 'example' => 'db_test',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"WorkflowDetail\\": {\\n \\"WfCateName\\": \\"Owner与DBA\\",\\n \\"Comment\\": \\"系统定义审批线，先数据Owner审批，再DBA审批。\\",\\n \\"WorkflowNodeList\\": {\\n \\"WorkflowNode\\": [\\n {\\n \\"NodeName\\": \\"Owner\\",\\n \\"NodeType\\": \\"SYS\\",\\n \\"Comment\\": \\"系统节点，动态计算，由用户操作的资源对应的Owner来完成审批。\\",\\n \\"AuditUserList\\": {\\n \\"AuditUser\\": [\\n {\\n \\"UserId\\": 0,\\n \\"NickName\\": \\"Owner\\",\\n \\"RealName\\": \\"db_test\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'PreviewWorkflow',
+ ],
+ 'GetOwnerApplyOrderDetail' => [
+ 'summary' => 'Queries the details of the Database-OWNER, Table-OWNER, and Instance-OWNER tickets.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '730000',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'CB784055-E8CB-4461-AB0B-483A1DA32BB5',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'OwnerApplyOrderDetail' => [
+ 'description' => 'The details of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplyType' => [
+ 'description' => 'The type of the submitted ticket. Valid values:'."\n"
+ ."\n"
+ .'* **INSTANCE**: the ticket that applies for the permissions to be an instance owner'."\n"
+ .'* **DB**: the ticket that applies for the permissions to be a database owner'."\n"
+ .'* **TABLE**: the ticket that applies for the permissions to be a table owner'."\n",
+ 'type' => 'string',
+ 'example' => 'DB',
+ ],
+ 'Resources' => [
+ 'description' => 'The details of the requested resource.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The instance is a logical database.'."\n"
+ .'* **false**: The instance is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TargetId' => [
+ 'description' => 'The ID of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'ResourceDetail' => [
+ 'description' => 'The details of the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchName' => [
+ 'description' => 'The search name of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'yuyang【test】',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'MYSQL',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the instance belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'PRODUCT',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n"
+ ."\n"
+ .'> : This parameter is returned when you submit a Database-OWNER ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the original owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '132453',
+ ],
+ ],
+ 'OwnerNickNames' => [
+ 'description' => 'The nicknames of the owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_user',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CB784055-E8CB-4461-AB0B-483A1DA32BB5\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"OwnerApplyOrderDetail\\": {\\n \\"ApplyType\\": \\"DB\\",\\n \\"Resources\\": [\\n {\\n \\"Logic\\": true,\\n \\"TargetId\\": \\"12345\\",\\n \\"ResourceDetail\\": {\\n \\"SearchName\\": \\"yuyang[test]\\",\\n \\"DbType\\": \\"MYSQL\\",\\n \\"EnvType\\": \\"PRODUCT\\",\\n \\"TableName\\": \\"test\\",\\n \\"OwnerIds\\": [\\n 132453\\n ],\\n \\"OwnerNickNames\\": [\\n \\"test_user\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetOwnerApplyOrderDetailResponse>\\n <OwnerApplyOrderDetail>\\n <ApplyType>DB</ApplyType>\\n <Resources>\\n <ResourceDetail>\\n <SearchName>[email protected]:3432</SearchName>\\n <OwnerNickNames>gctest</OwnerNickNames>\\n <EnvType>PRODUCT</EnvType>\\n <DbType>ADB_POSTGRESQL</DbType>\\n <OwnerIds>128000</OwnerIds>\\n </ResourceDetail>\\n <Logic>false</Logic>\\n <TargetId>116000</TargetId>\\n </Resources>\\n </OwnerApplyOrderDetail>\\n <RequestId>6976762B-AEA4-4EF0-9C42-46EC5477D780</RequestId>\\n <Success>true</Success>\\n</GetOwnerApplyOrderDetailResponse>","errorExample":""}]',
+ 'title' => 'GetOwnerApplyOrderDetail',
+ ],
+ 'GetPermApplyOrderDetail' => [
+ 'summary' => 'Queries the details of a ticket that applies for permissions.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~465867~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '730000',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of response information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'A4C4499E-5AC2-4318-9FCF-03E426781A04',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PermApplyOrderDetail' => [
+ 'description' => 'The details of the permission application ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Resources' => [
+ 'description' => 'The list of resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DatabaseInfo' => [
+ 'description' => 'The information about the database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@xxxx:3306【test】',
+ ],
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ ],
+ 'OwnerNickNames' => [
+ 'description' => 'The nicknames of the owners of the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the owner of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_user',
+ ],
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the instance belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ ],
+ ],
+ 'TableInfo' => [
+ 'description' => 'The information about the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_tb',
+ ],
+ ],
+ ],
+ 'ColumnInfo' => [
+ 'description' => 'The information about the column.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_tb',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_col',
+ ],
+ ],
+ ],
+ 'InstanceInfo' => [
+ 'description' => 'The information about the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxxx:3306',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the instance belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxxx',
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3306',
+ ],
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ ],
+ 'OwnerNickName' => [
+ 'description' => 'The nicknames of the owners of the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the owner of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_owner',
+ ],
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the database administrator (DBA) of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'DbaNickName' => [
+ 'description' => 'The nickname of the DBA of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_dba',
+ ],
+ ],
+ ],
+ 'RowInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'Logic' => [
+ 'type' => 'boolean',
+ ],
+ 'SchemaName' => [
+ 'type' => 'string',
+ ],
+ 'TableName' => [
+ 'type' => 'string',
+ ],
+ 'ColumnName' => [
+ 'type' => 'string',
+ ],
+ 'MatchMode' => [
+ 'type' => 'string',
+ ],
+ 'RowGroupId' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ 'RowValueInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RowValue' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permissions that you apply for. Valid values:'."\n"
+ ."\n"
+ .'* **1**: the permissions to query information.'."\n"
+ .'* **2**: the permissions to export information.'."\n"
+ .'* **3**: the permissions to query and export information.'."\n"
+ .'* **4**: the permissions to modify information.'."\n"
+ .'* **5**: the permissions to query and modify information.'."\n"
+ .'* **6**: the permissions to export and modify information.'."\n"
+ .'* **7**: the permissions to query, export, and modify information.'."\n"
+ .'* **8**: the permissions to log on to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '7',
+ ],
+ 'Seconds' => [
+ 'description' => 'The validity duration of the permissions. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3600',
+ ],
+ 'ApplyType' => [
+ 'description' => 'The type of objects on which you apply for permissions. Valid values:'."\n"
+ ."\n"
+ .'* **DB**: database'."\n"
+ .'* **TAB**: table'."\n"
+ .'* **COL**: column'."\n"
+ .'* **INSTANT**: instance'."\n",
+ 'type' => 'string',
+ 'example' => 'DB',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A4C4499E-5AC2-4318-9FCF-03E426781A04\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"PermApplyOrderDetail\\": {\\n \\"Resources\\": [\\n {\\n \\"DatabaseInfo\\": {\\n \\"DbId\\": 12345,\\n \\"Logic\\": false,\\n \\"DbType\\": \\"MySQL\\",\\n \\"SearchName\\": \\"test@xxxx:3306[test]\\",\\n \\"OwnerIds\\": [\\n 12345\\n ],\\n \\"OwnerNickNames\\": [\\n \\"test_user\\"\\n ],\\n \\"EnvType\\": \\"product\\"\\n },\\n \\"TableInfo\\": {\\n \\"TableName\\": \\"test_tb\\"\\n },\\n \\"ColumnInfo\\": {\\n \\"TableName\\": \\"test_tb\\",\\n \\"ColumnName\\": \\"test_col\\"\\n },\\n \\"InstanceInfo\\": {\\n \\"InstanceId\\": \\"12345\\",\\n \\"SearchName\\": \\"xxxx:3306\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"EnvType\\": \\"product\\",\\n \\"Host\\": \\"xxxx\\",\\n \\"Port\\": 3306,\\n \\"OwnerIds\\": [\\n 12345\\n ],\\n \\"OwnerNickName\\": [\\n \\"test_owner\\"\\n ],\\n \\"DbaId\\": 0,\\n \\"DbaNickName\\": \\"test_dba\\"\\n },\\n \\"RowInfo\\": {\\n \\"DbId\\": 69256456,\\n \\"Logic\\": false,\\n \\"SchemaName\\": \\"testdb003\\",\\n \\"TableName\\": \\"ods_qr_dms_vehicleorder_df\\",\\n \\"ColumnName\\": \\"xrxs_xid\\",\\n \\"MatchMode\\": \\"EQ\\",\\n \\"RowGroupId\\": 123434\\n },\\n \\"RowValueInfo\\": {\\n \\"RowValue\\": \\"test_value\\"\\n }\\n }\\n ],\\n \\"PermType\\": 7,\\n \\"Seconds\\": 3600,\\n \\"ApplyType\\": \\"DB\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPermApplyOrderDetailResponse>\\n <PermApplyOrderDetail>\\n <ApplyType>DB</ApplyType>\\n <PermType>1</PermType>\\n <Seconds>2592000</Seconds>\\n <Resources>\\n <DatabaseInfo>\\n <SearchName>[email protected]:3306</SearchName>\\n <OwnerNickNames>gctest</OwnerNickNames>\\n <DbId>1250000</DbId>\\n <Logic>false</Logic>\\n <EnvType>dev</EnvType>\\n <DbType>mysql</DbType>\\n <OwnerIds>120000</OwnerIds>\\n </DatabaseInfo>\\n <ColumnInfo/>\\n <TableInfo/>\\n <InstanceInfo/>\\n </Resources>\\n </PermApplyOrderDetail>\\n <RequestId>806FBC5B-2AED-401C-9E00-0B91C1DB2F1A</RequestId>\\n <Success>true</Success>\\n</GetPermApplyOrderDetailResponse>","errorExample":""}]',
+ 'title' => 'GetPermApplyOrderDetail',
+ 'description' => 'You can call this operation to query the information about tickets that apply for permissions on databases, tables, and sensitive columns.'."\n",
+ ],
+ 'CreateStructSyncOrder' => [
+ 'summary' => 'Creates a schema synchronization ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the stakeholders.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of a stakeholder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '432435',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => [
+ 'description' => 'The information about the base database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabases](~~141876~~) operation to query the ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '4324532',
+ ],
+ 'DbSearchName' => [
+ 'description' => 'The name that is used to search for the database. You can call the [SearchDatabases](~~141876~~) operation to query the name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'VersionId' => [
+ 'description' => 'The version number of the schema. The default value is the latest schema version number. For more information, see [Manage schema versions](~~202275~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'e179bbb8163dcdcfacda24858bedb4d8006ae2b8',
+ ],
+ ],
+ 'required' => true,
+ ],
+ 'Target' => [
+ 'description' => 'The information about the database to which you want to synchronize the schema of a table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabases](~~141876~~) operation to query the ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '432432',
+ ],
+ 'DbSearchName' => [
+ 'description' => 'The name that is used to search for the database. You can call the [SearchDatabases](~~141876~~) operation to query the name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'VersionId' => [
+ 'description' => 'The version number. By default, this parameter is left empty.'."\n"
+ ."\n"
+ .'> If you specify the schema version number of the destination database, Data Management (DMS) only compares the schemas of the two databases.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'e179bbb8163dcdcfacda24858bedb4d8006ae2b8',
+ ],
+ ],
+ 'required' => true,
+ ],
+ 'IgnoreError' => [
+ 'description' => 'Specifies whether to skip an error that occurs in executing an SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **true**: continues to execute subsequent SQL statements if an error occurs in executing an SQL statement.'."\n"
+ .'* **false**: stops executing subsequent SQL statements if an error occurs in executing an SQL statement.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'TableInfoList' => [
+ 'description' => 'The information about the table of which you want to synchronize the schema.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table of which you want to synchronize the schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceTableName' => [
+ 'description' => 'The name of the source table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_tbl',
+ ],
+ 'TargetTableName' => [
+ 'description' => 'The name of the destination table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_tbl',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of an attachment that is returned after the attachment is uploaded. You can call the [GetUserUploadFileJob](~~206069~~) operation to query the key of the attachment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The result of creating the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4325353',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateStructSyncOrderResponse>\\n <CreateOrderResult>2000000</CreateOrderResult>\\n <RequestId>0DF19315-DCAF-4376-8006-1CEB0BBC6B13</RequestId>\\n <Success>true</Success>\\n</CreateStructSyncOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateStructSyncOrder',
+ ],
+ 'GetStructSyncOrderDetail' => [
+ 'summary' => 'Queries the details of a schema synchronization ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '43****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StructSyncOrderDetail' => [
+ 'description' => 'The details of the schema synchronization ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceDatabaseInfo' => [
+ 'description' => 'The information about the source database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the source database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432532',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'TargetDatabaseInfo' => [
+ 'description' => 'The information about the destination database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the destination database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432543',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs. For more information, see [Change the environment type of an instance](~~163309~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'SourceType' => [
+ 'description' => 'The schema version of the source database. Valid values:'."\n"
+ ."\n"
+ .'* **DATASOURCE**: the default latest version of the system'."\n"
+ .'* **VERSION**: a previous schema version that you manually specify'."\n",
+ 'type' => 'string',
+ 'example' => 'VERSION',
+ ],
+ 'SourceVersionInfo' => [
+ 'description' => 'The version information about the source instance.'."\n"
+ ."\n"
+ .'> This parameter is displayed only when the value of the **SourceType** parameter is **VERSION**.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'VersionId' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'string',
+ 'example' => 'e179bbb8163dcdcfacda24858bedb4d8006ae2b8',
+ ],
+ ],
+ ],
+ 'TargetType' => [
+ 'description' => 'The schema version of the destination database. Valid values:'."\n"
+ ."\n"
+ .'* **DATASOURCE**: the default latest version of the system'."\n"
+ .'* **VERSION**: a previous schema version that you manually specify'."\n",
+ 'type' => 'string',
+ 'example' => 'DATASOURCE',
+ ],
+ 'TargetVersionInfo' => [
+ 'description' => 'The version information about the destination instance.'."\n"
+ ."\n"
+ .'> This parameter is displayed only when the value of the **SourceType** parameter is **VERSION**.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'VersionId' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'string',
+ 'example' => 'e179bbb8163dcdcfacda24858bedb4d8006ae2b8',
+ ],
+ ],
+ ],
+ 'TableInfoList' => [
+ 'description' => 'The information about the table whose schema you want to synchronize.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table whose schema you want to synchronize.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceTableName' => [
+ 'description' => 'The name of the table whose schema you want to synchronize.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_tbl',
+ ],
+ 'TargetTableName' => [
+ 'description' => 'The name of the table to which you want to synchronize the schema of a table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_tbl',
+ ],
+ ],
+ ],
+ ],
+ 'IgnoreError' => [
+ 'description' => 'Indicates whether to skip errors. Valid values:'."\n"
+ ."\n"
+ .'* **true**: skips the error and continues to execute SQL statements.'."\n"
+ .'* **false**: stops executing SQL statements.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StructSyncOrderDetail\\": {\\n \\"SourceDatabaseInfo\\": {\\n \\"DbId\\": 432532,\\n \\"SearchName\\": \\"test\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"Logic\\": false\\n },\\n \\"TargetDatabaseInfo\\": {\\n \\"DbId\\": 432543,\\n \\"SearchName\\": \\"test\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"Logic\\": false\\n },\\n \\"SourceType\\": \\"VERSION\\",\\n \\"SourceVersionInfo\\": {\\n \\"VersionId\\": \\"e179bbb8163dcdcfacda24858bedb4d8006ae2b8\\"\\n },\\n \\"TargetType\\": \\"DATASOURCE\\",\\n \\"TargetVersionInfo\\": {\\n \\"VersionId\\": \\"e179bbb8163dcdcfacda24858bedb4d8006ae2b8\\"\\n },\\n \\"TableInfoList\\": [\\n {\\n \\"SourceTableName\\": \\"test_tbl\\",\\n \\"TargetTableName\\": \\"test_tbl\\"\\n }\\n ],\\n \\"IgnoreError\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetStructSyncOrderDetailResponse>\\n <RequestId>CA4E966B-1A57-4230-B0BB-CBB9CAF2CEDC</RequestId>\\n <StructSyncOrderDetail>\\n <SourceDatabaseInfo>\\n <SearchName>[email protected]:3306</SearchName>\\n <DbId>800000</DbId>\\n <Logic>false</Logic>\\n <EnvType>dev</EnvType>\\n <DbType>mysql</DbType>\\n </SourceDatabaseInfo>\\n <SourceType>DATASOURCE</SourceType>\\n <TargetType>DATASOURCE</TargetType>\\n <IgnoreError>false</IgnoreError>\\n <TargetDatabaseInfo>\\n <SearchName>[email protected]:3306</SearchName>\\n <DbId>700000</DbId>\\n <Logic>false</Logic>\\n <EnvType>dev</EnvType>\\n <DbType>mysql</DbType>\\n </TargetDatabaseInfo>\\n <TableInfoList>\\n <SourceTableName>*</SourceTableName>\\n <TargetTableName>*</TargetTableName>\\n </TableInfoList>\\n </StructSyncOrderDetail>\\n <Success>true</Success>\\n</GetStructSyncOrderDetailResponse>","errorExample":""}]',
+ 'title' => 'GetStructSyncOrderDetail',
+ ],
+ 'GetStructSyncJobDetail' => [
+ 'summary' => 'Queries the information of a schema synchronization task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4324321',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '48602B78-0DDF-414C-8688-70CAB6070115',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StructSyncJobDetail' => [
+ 'description' => 'The details of the schema synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobStatus' => [
+ 'description' => 'The status of the task. Valid values:'."\n"
+ ."\n"
+ .'* **NEW**: The task was created.'."\n"
+ .'* **COMPARING**: The schemas of tables were being compared.'."\n"
+ .'* **COMPARE_BREAK**: The schema comparison was interrupted.'."\n"
+ .'* **COMPARE_FINISH**: The comparison was finished.'."\n"
+ .'* **NOT_SCRIPTS**: The comparison was finished but no executable script was available.'."\n"
+ .'* **SUBMITED_DBTASK**: The task was submitted.'."\n"
+ .'* **DBTASK_SUCCESS**: The task was complete.'."\n"
+ .'* **SUBMITED_WORKFLOW**: The ticket was submitted.'."\n"
+ .'* **WORKFLOW_SUCCESS**: The ticket was approved.'."\n",
+ 'type' => 'string',
+ 'example' => 'DBTASK_SUCCESS',
+ ],
+ 'Message' => [
+ 'description' => 'The description of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TableAnalyzed' => [
+ 'description' => 'The number of tables that have been analyzed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'TableCount' => [
+ 'description' => 'The total number of tables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'SqlCount' => [
+ 'description' => 'The total number of SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'ExecuteCount' => [
+ 'description' => 'The number of SQL statements that have been executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'SecurityRule' => [
+ 'description' => 'The type of security rule. Valid values:'."\n"
+ ."\n"
+ .'* **CANNOT_SYNC**: Synchronization cannot be performed.'."\n"
+ .'* **WITH_APPROVE**: The schema synchronization can be performed after the ticket is approved. You can call the [SubmitStructSyncOrderApproval](~~206166~~) operation to submit the ticket for approval.'."\n"
+ .'* **WITHOUT_APPROVE**: The schema synchronization can be performed without approval.'."\n",
+ 'type' => 'string',
+ 'example' => 'WITHOUT_APPROVE',
+ ],
+ 'DBTaskGroupId' => [
+ 'description' => 'The ID of the SQL task group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"48602B78-0DDF-414C-8688-70CAB6070115\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StructSyncJobDetail\\": {\\n \\"JobStatus\\": \\"DBTASK_SUCCESS\\",\\n \\"Message\\": \\"test\\",\\n \\"TableAnalyzed\\": 2,\\n \\"TableCount\\": 2,\\n \\"SqlCount\\": 1,\\n \\"ExecuteCount\\": 1,\\n \\"SecurityRule\\": \\"WITHOUT_APPROVE\\",\\n \\"DBTaskGroupId\\": 12345\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetStructSyncJobDetailResponse>\\n <RequestId>C29D0A5F-BB9B-4CB9-A6B7-19B5433983CA</RequestId>\\n <StructSyncJobDetail>\\n <JobStatus>COMPARE_FINISH</JobStatus>\\n <Message>结构对比完成, 预览SQL已经生成</Message>\\n <TableAnalyzed>6</TableAnalyzed>\\n <TableCount>6</TableCount>\\n <SecurityRule>WITH_APPROVE</SecurityRule>\\n <DBTaskGroupId>3000000</DBTaskGroupId>\\n </StructSyncJobDetail>\\n <Success>true</Success>\\n</GetStructSyncJobDetailResponse>","errorExample":""}]',
+ 'title' => 'GetStructSyncJobDetail',
+ ],
+ 'GetStructSyncJobAnalyzeResult' => [
+ 'summary' => 'Queries the analysis result of a schema synchronization task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1342355',
+ ],
+ ],
+ [
+ 'name' => 'CompareType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the comparison. Valid values:'."\n"
+ ."\n"
+ .'* **CREATE_TABLE**: compares the created tables.'."\n"
+ .'* **ALTER_TABLE**: compares the modified tables.'."\n"
+ .'* **EQUAL_TABLE**: compares the identical tables.'."\n"
+ .'* **PASS_TABLE**: compares the tables that are skipped during schema synchronization.'."\n"
+ .'* **NOT_COMPARE**: does not compare tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CREATE_TABLE',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1810E635-A2D7-428B-BAA9-85DAEB9B1A77',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StructSyncJobAnalyzeResult' => [
+ 'description' => 'The analysis result of the schema synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SummaryList' => [
+ 'description' => 'The statistics on the analysis results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The statistics on an analysis result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CompareType' => [
+ 'description' => 'The type of the comparison. Valid values:'."\n"
+ ."\n"
+ .'* **CREATE_TABLE**: compares the created tables.'."\n"
+ .'* **ALTER_TABLE**: compares the modified tables.'."\n"
+ .'* **EQUAL_TABLE**: compares the identical tables.'."\n"
+ .'* **PASS_TABLE**: compares the tables that are skipped during schema synchronization.'."\n"
+ .'* **NOT_COMPARE**: does not compare tables.'."\n",
+ 'type' => 'string',
+ 'example' => 'CREATE_TABLE',
+ ],
+ 'Count' => [
+ 'description' => 'The number of tables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'ResultList' => [
+ 'description' => 'The details of the analysis results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of an analysis result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceTableName' => [
+ 'description' => 'The name of the source table.'."\n",
+ 'type' => 'string',
+ 'example' => 'helloz_bak',
+ ],
+ 'TargetTableName' => [
+ 'description' => 'The name of the destination table.'."\n",
+ 'type' => 'string',
+ 'example' => 'helloz_bak',
+ ],
+ 'Script' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => '/\\* origin table\\[helloz_bak] exist, target table\\[helloz_bak] not exist \\*/\\n/\\* generate \\[helloz_bak] create table sql \\*/\\ncreate table \\`helloz_bak\\`(\\n\\t\\`id\\` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT \'Primary key\',\\n\\t\\`gmt_create\\` datetime NOT NULL COMMENT \'Creation time\',\\n\\t\\`gmt_modified\\` datetime NOT NULL COMMENT \'Modification time\',\\n\\t\\`num\\` int(11) NOT NULL COMMENT \'Number\',\\n\\t\\`addr\\` varchar(50) CHARACTER SET utf8 COLLATE utf8\\_general_ci NOT NULL COMMENT \'Address\',\\n\\tPRIMARY KEY (\\`id\\`)\\n)\\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8\\_general_ci\\nCOMMENT=\'test\'\\n\\n;'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1810E635-A2D7-428B-BAA9-85DAEB9B1A77\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StructSyncJobAnalyzeResult\\": {\\n \\"SummaryList\\": [\\n {\\n \\"CompareType\\": \\"CREATE_TABLE\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"ResultList\\": [\\n {\\n \\"SourceTableName\\": \\"helloz_bak\\",\\n \\"TargetTableName\\": \\"helloz_bak\\",\\n \\"Script\\": \\"/* origin table[helloz_bak] exist, target table[helloz_bak] not exist */\\\\\\\\n/* generate [helloz_bak] create table sql */\\\\\\\\ncreate table `helloz_bak`(\\\\\\\\n\\\\\\\\t`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\\\\\\\n\\\\\\\\t`gmt_create` datetime NOT NULL COMMENT \'创建时间\',\\\\\\\\n\\\\\\\\t`gmt_modified` datetime NOT NULL COMMENT \'修改时间\',\\\\\\\\n\\\\\\\\t`num` int(11) NOT NULL COMMENT \'编号\',\\\\\\\\n\\\\\\\\t`addr` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT \'地址\',\\\\\\\\n\\\\\\\\tPRIMARY KEY (`id`)\\\\\\\\n)\\\\\\\\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci\\\\\\\\nCOMMENT=\'test\'\\\\\\\\n\\\\\\\\n;\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetStructSyncJobAnalyzeResultResponse>\\n <StructSyncJobAnalyzeResult>\\n <ResultList>\\n <SourceTableName>data_modify</SourceTableName>\\n <Script>/* origin table[data_modify] exist, target table[data_modify] not exist */\\n /* generate [data_modify] create table sql */\\n create table `data_modify` (\\n `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\n `name` varchar(256) NOT NULL COMMENT \'姓名\',\\n `phone` varchar(32) DEFAULT NULL COMMENT \'电话\',\\n `sex` varchar(32) DEFAULT NULL COMMENT \'性别\',\\n `email` varchar(256) DEFAULT NULL COMMENT \'邮箱\',\\n `user_desc` varchar(1024) DEFAULT NULL COMMENT \'备注\',\\n PRIMARY KEY (`id`)\\n ) DEFAULT CHARSET=utf8 COMMENT=\'数据修改测试表\';</Script>\\n <TargetTableName>data_modify</TargetTableName>\\n </ResultList>\\n <ResultList>\\n <SourceTableName>task_data</SourceTableName>\\n <Script>/* origin table[task_data] exist, target table[task_data] not exist */\\n /* generate [task_data] create table sql */\\n create table `task_data` (\\n `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\n `gmt_create` datetime NOT NULL COMMENT \'创建时间\',\\n `gmt_modified` datetime NOT NULL COMMENT \'修改时间\',\\n `content` text COMMENT \'测试数据\',\\n PRIMARY KEY (`id`)\\n ) DEFAULT CHARSET=utf8mb4 COMMENT=\'任务编排测试表\';</Script>\\n <TargetTableName>task_data</TargetTableName>\\n </ResultList>\\n <SummaryList>\\n <CompareType>CREATE_TABLE</CompareType>\\n <Count>2</Count>\\n </SummaryList>\\n <SummaryList>\\n <CompareType>EQUAL_TABLE</CompareType>\\n <Count>1</Count>\\n </SummaryList>\\n </StructSyncJobAnalyzeResult>\\n <RequestId>472C5F33-198B-4A41-BF83-B2322636B583</RequestId>\\n <Success>true</Success>\\n</GetStructSyncJobAnalyzeResultResponse>","errorExample":""}]',
+ 'title' => 'GetStructSyncJobAnalyzeResult',
+ ],
+ 'GetStructSyncExecSqlDetail' => [
+ 'summary' => 'Queries the SQL statements that are involved in a schema synchronization ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '342153',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1810E635-A2D7-428B-BAA9-85DAEB9B1A77',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StructSyncExecSqlDetail' => [
+ 'description' => 'The details of the SQL statements.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalSqlCount' => [
+ 'description' => 'The total number of SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'ExecSql' => [
+ 'description' => 'The SQL statements that are executed.'."\n",
+ 'type' => 'string',
+ 'example' => '/\\* origin table\\[helloz_bak] exist, target table\\[helloz_bak] not exist \\*/\\n/\\* generate \\[helloz_bak] create table sql \\*/\\ncreate table \\`helloz_bak\\`(\\n\\t\\`id\\` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT \'Primary key\',\\n\\t\\`gmt_create\\` datetime NOT NULL COMMENT \'Creation time\',\\n\\t\\`gmt_modified\\` datetime NOT NULL COMMENT \'Modification time\',\\n\\t\\`num\\` int(11) NOT NULL COMMENT \'Number\',\\n\\t\\`addr\\` varchar(50) CHARACTER SET utf8 COLLATE utf8\\_general_ci NOT NULL COMMENT \'Address\',\\n\\tPRIMARY KEY (\\`id\\`)\\n)\\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8\\_general_ci\\nCOMMENT=\'test\'\\n\\n;'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1810E635-A2D7-428B-BAA9-85DAEB9B1A77\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StructSyncExecSqlDetail\\": {\\n \\"TotalSqlCount\\": 1,\\n \\"ExecSql\\": \\"/* origin table[helloz_bak] exist, target table[helloz_bak] not exist */\\\\\\\\n/* generate [helloz_bak] create table sql */\\\\\\\\ncreate table `helloz_bak`(\\\\\\\\n\\\\\\\\t`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\\\\\\\n\\\\\\\\t`gmt_create` datetime NOT NULL COMMENT \'创建时间\',\\\\\\\\n\\\\\\\\t`gmt_modified` datetime NOT NULL COMMENT \'修改时间\',\\\\\\\\n\\\\\\\\t`num` int(11) NOT NULL COMMENT \'编号\',\\\\\\\\n\\\\\\\\t`addr` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT \'地址\',\\\\\\\\n\\\\\\\\tPRIMARY KEY (`id`)\\\\\\\\n)\\\\\\\\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci\\\\\\\\nCOMMENT=\'test\'\\\\\\\\n\\\\\\\\n;\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetStructSyncExecSqlDetailResponse>\\n <StructSyncExecSqlDetail>\\n <ExecSql>/****** 目标库: [email protected]:3306 ******/\\n \\n /* origin table[data_modify] exist, target table[data_modify] not exist */\\n /* generate [data_modify] create table sql */\\n create table `data_modify` (\\n `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\n `name` varchar(256) NOT NULL COMMENT \'姓名\',\\n `phone` varchar(32) DEFAULT NULL COMMENT \'电话\',\\n `sex` varchar(32) DEFAULT NULL COMMENT \'性别\',\\n `email` varchar(256) DEFAULT NULL COMMENT \'邮箱\',\\n `user_desc` varchar(1024) DEFAULT NULL COMMENT \'备注\',\\n PRIMARY KEY (`id`)\\n ) DEFAULT CHARSET=utf8 COMMENT=\'数据修改测试表\';\\n \\n /* origin table[task_data] exist, target table[task_data] not exist */\\n /* generate [task_data] create table sql */\\n create table `task_data` (\\n `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT \'主键\',\\n `gmt_create` datetime NOT NULL COMMENT \'创建时间\',\\n `gmt_modified` datetime NOT NULL COMMENT \'修改时间\',\\n `content` text COMMENT \'测试数据\',\\n PRIMARY KEY (`id`)\\n ) DEFAULT CHARSET=utf8mb4 COMMENT=\'任务编排测试表\';\\n \\n \\n \\n </ExecSql>\\n <TotalSqlCount>2</TotalSqlCount>\\n </StructSyncExecSqlDetail>\\n <RequestId>1E4E71DA-9346-4254-B19D-BC5FF6BF34EC</RequestId>\\n <Success>true</Success>\\n</GetStructSyncExecSqlDetailResponse>","errorExample":""}]',
+ 'title' => 'GetStructSyncExecSqlDetail',
+ ],
+ 'SubmitStructSyncOrderApproval' => [
+ 'summary' => 'Submits a schema synchronization ticket for approval.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '4324535',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471D',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'WorkflowInstanceId' => [
+ 'description' => 'The ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432523',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471D\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"WorkflowInstanceId\\": 432523\\n}","errorExample":""},{"type":"xml","example":"<SubmitStructSyncOrderApprovalResponse>\\n <RequestId>72768811-B970-4733-85BE-A8659613BF23</RequestId>\\n <WorkflowInstanceId>1000000</WorkflowInstanceId>\\n <Success>true</Success>\\n</SubmitStructSyncOrderApprovalResponse>","errorExample":""}]',
+ 'title' => 'SubmitStructSyncOrderApproval',
+ ],
+ 'ExecuteStructSync' => [
+ 'summary' => 'Executes a schema synchronization task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '112345',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecuteStructSyncResponse>\\n <RequestId>4E1D2B4D-3E53-4ABC-999D-1D2520B3471A</RequestId>\\n <Success>true</Success>\\n</ExecuteStructSyncResponse>","errorExample":""}]',
+ 'title' => 'ExecuteStructSync',
+ 'description' => 'If the security rules of an instance indicate that a ticket must be approved before you perform schema synchronization, you can call the [SubmitStructSyncOrderApproval](~~206166~~) operation to submit the ticket for approval.'."\n"
+ ."\n"
+ .'> You can call the [GetStructSyncJobDetail](~~206160~~) operation to query whether you need to submit a ticket for approval.'."\n",
+ ],
+ 'CreateDataCorrectOrder' => [
+ 'summary' => 'Creates a ticket for changing data in Data Management (DMS).',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '16826',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders of the data change. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user ID of the stakeholder. All the specified stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBA) are not allowed to view the ticket details.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the data change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'EstimateAffectRows' => [
+ 'description' => 'The estimated number of data rows that may be affected by the data change.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ 'ExecSQL' => [
+ 'description' => 'The SQL statements for data change.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* This parameter is required if you set **SqlType** to **TEXT**.'."\n"
+ ."\n"
+ .'* The size of the SQL statement cannot exceed 15 MB.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'update base_user set id = 1 where id = 1;',
+ ],
+ 'SqlType' => [
+ 'description' => 'The format of the SQL statements used to change data. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**'."\n"
+ .'* **ATTACHMENT**'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ 'ATTACHMENT',
+ ],
+ ],
+ 'AttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to change data. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of AttachmentKey.'."\n"
+ ."\n"
+ .'> This parameter is required if you set **SqlType** to **ATTACHMENT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test.sql',
+ ],
+ 'RollbackSQL' => [
+ 'description' => 'The SQL statements for rolling back the data change.'."\n"
+ ."\n"
+ .'> This parameter is required if you set **RollbackSqlType** to **TEXT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'update base_user set id = 1 where id = 1;',
+ ],
+ 'RollbackAttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to roll back the data change. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of AttachmentKey.'."\n"
+ ."\n"
+ .'> This parameter is required if you set **RollbackSqlType** to **ATTACHMENT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_rollback.sql',
+ ],
+ 'RollbackSqlType' => [
+ 'description' => 'The format of the SQL statements used to roll back the data change. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**'."\n"
+ .'* **ATTACHMENT**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ 'ATTACHMENT',
+ ],
+ ],
+ 'DbItemList' => [
+ 'description' => 'The databases whose data you want to change.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the databases.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1860****',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID. You can call the ListInstances or GetInstance operation to query the instance ID.'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> The instance change feature is supported only by ApsaraDB RDS for MySQL instances, PolarDB for MySQL clusters, and AnalyticDB for MySQL clusters.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1860****',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'ExecMode' => [
+ 'description' => 'The mode in which the data change ticket is executed after the ticket is approved. Valid values:'."\n"
+ ."\n"
+ .'* **COMMITOR**: The ticket is executed by the user who submits the ticket.'."\n"
+ .'* **AUTO**: The ticket is automatically executed after the ticket is approved.'."\n"
+ .'* **LAST_AUDITOR**: The ticket is executed by the last approver of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'COMMITOR',
+ 'default' => 'COMMITOR',
+ 'enum' => [
+ 'COMMITOR',
+ 'AUTO',
+ 'LAST_AUDITOR',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment that provides more instructions for the ticket. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of the AttachmentKey parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to call the API operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The IDs of the tickets.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '142****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateDataCorrectOrderResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <Success>true</Success>\\n <CreateOrderResult>142****</CreateOrderResult>\\n</CreateDataCorrectOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateDataCorrectOrder',
+ 'description' => 'For more information about the Normal Data Modify feature, see [Change regular data](~~58419~~).'."\n",
+ ],
+ 'CreateDataCronClearOrder' => [
+ 'summary' => 'Creates a ticket for clearing historical data.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the data change. This reduces unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders of this operation. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '243253',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the data change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'DbItemList' => [
+ 'description' => 'The databases for which you want to clear historical data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabases](~~141876~~) operation to query the ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1234',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'CronFormat' => [
+ 'description' => 'The crontab expression that you can use to run the task at a specified time. For more information, see [Crontab expression](~~206581~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '0 0 2 * * ?',
+ ],
+ 'CronClearItemList' => [
+ 'description' => 'The tables for which you want to clear historical data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table. You can call the [ListTables](~~141878~~) operation to query the name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 't1',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'gmt_create',
+ ],
+ 'RemainDays' => [
+ 'description' => 'The retention period of the historical data. Unit: days. For example, if you set the parameter to 7, DMS deletes the data that is retained for more than seven days.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '7',
+ ],
+ 'TimeUnit' => [
+ 'description' => 'The type of time granularity. If the ColumnName parameter specifies a field of a time type, this parameter is required. Valid values:'."\n"
+ ."\n"
+ .'* **MILLISECONDS**: milliseconds'."\n"
+ .'* **SECONDS**: seconds'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MILLISECONDS',
+ 'default' => 'MILLISECONDS',
+ 'enum' => [
+ 'MILLISECONDS',
+ 'SECONDS',
+ ],
+ ],
+ 'FilterSQL' => [
+ 'description' => 'The filter conditions.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'where 1 = 1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'specifyDuration' => [
+ 'description' => 'Specifies whether to specify an end time for the task. Valid values:'."\n"
+ ."\n"
+ .'* **true**: specifies an end time for the task. The task is automatically suspended after this end time.'."\n"
+ .'* **false**: does not specify an end time for the task. The task is stopped after the historical data is cleared.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'true',
+ ],
+ 'DurationHour' => [
+ 'description' => 'The amount of time taken to run the task. Unit: hours.'."\n"
+ ."\n"
+ .'> If the **specifyDuration** parameter is set to **true**, this parameter is required.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '4',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment for the ticket. The attachment provides more instructions for this operation.'."\n"
+ ."\n"
+ .'You can call the [GetUserUploadFileJob](~~206069~~) operation to query the key of the attachment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachement.txt',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> The ID of the tenant is displayed when you move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the [View information about the current tenant](~~181330~~) section of the Manage DMS tenants topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123454324',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1341532',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 1341532\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateDataCronClearOrderResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <Success>true</Success>\\n <CreateOrderResult>1341532</CreateOrderResult>\\n</CreateDataCronClearOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateDataCronClearOrder',
+ 'description' => 'For more information about the historical data cleaning, see [Clear historical data](~~162507~~).'."\n"
+ ."\n"
+ .'This operation can be used only for MySQL databases.'."\n",
+ ],
+ 'CreateDataImportOrder' => [
+ 'summary' => 'Creates a ticket for importing data to Data Management (DMS).',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsUOM2CE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the data import. This parameter is used to help reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders of the data import. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the data import.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'AttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to import data. You can call the [GetUserUploadFileJob](~~206069~~) operation to the attachment key from the value of the AttachmentKey parameter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'order_text',
+ ],
+ 'DbItemList' => [
+ 'description' => 'The database to which you want to import data. You can specify only one database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To obtain the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To obtain the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1860****',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n"
+ ."\n"
+ .'> If you set this parameter to **true**, the database that you specify must be a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'FileType' => [
+ 'description' => 'The format of the file for the data import. Valid values:'."\n"
+ ."\n"
+ .'* **SQL**: an SQL file'."\n"
+ .'* **CSV**: a CSV file'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CSV',
+ 'enum' => [
+ 'SQL',
+ 'CSV',
+ 'JSON',
+ ],
+ ],
+ 'FileEncoding' => [
+ 'description' => 'The encoding algorithm to be used by the destination database. Valid values:'."\n"
+ ."\n"
+ .'* **AUTO**: automatic identification'."\n"
+ .'* **UTF-8**: UTF-8 encoding'."\n"
+ .'* **GBK**: GBK encoding'."\n"
+ .'* **ISO-8859-1**: ISO-8859-1 encoding'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AUTO',
+ ],
+ 'TableName' => [
+ 'description' => 'The destination table to which you want to import the data in the CSV format.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **FileType** parameter to **CSV**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Table_text',
+ ],
+ 'InsertType' => [
+ 'description' => 'The mode in which the data in the CSV format is to be written to the destination table. Valid values:'."\n"
+ ."\n"
+ .'* **INSERT**: The database checks the primary key when data is written. If a duplicate primary key value exists, an error message is returned.'."\n"
+ .'* **INSERT_IGNORE**: If the imported data contains data records that are the same as those in the destination table, the new data records are ignored.'."\n"
+ .'* **REPLACE_INTO**: If the imported data contains a row that has the same value for the primary key or unique index as one row in the destination table, the database deletes the existing row and inserts the new row into the destination table.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **FileType** parameter to **CSV**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INSERT',
+ 'default' => 'INSERT',
+ 'enum' => [
+ 'INSERT',
+ 'INSERT_IGNORE',
+ 'REPLACE_INTO',
+ ],
+ ],
+ 'CsvFirstRowIsColumnDef' => [
+ 'description' => 'The type of the CSV file. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The first row in the CSV file contains field names.'."\n"
+ .'* **false**: The first row in the CSV file contains data.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **FileType** parameter to **CSV**.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'IgnoreError' => [
+ 'description' => 'Specifies whether to skip an error that occurs. Valid values:'."\n"
+ ."\n"
+ .'* **true**: skips the error and continues to execute SQL statements.'."\n"
+ .'* **false**: stops executing SQL statements.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ 'ImportMode' => [
+ 'description' => 'The import mode. Valid values:'."\n"
+ ."\n"
+ .'* **FAST_MODE**: In the Execute step, the uploaded file is read and SQL statements are executed to import data to the specified destination database. Compared with the security mode, this mode can be used to import data in a less secure but more efficient manner.'."\n"
+ .'* **SAFE_MODE**: In the Precheck step, the uploaded file is parsed, and SQL statements or CSV file data is cached. In the Execute step, the cached SQL statements are read and executed to import data, or the cached CSV file data is read and imported to the specified destination database. This mode can be used to import data in a more secure but less efficient manner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FAST_MODE',
+ 'default' => 'SAFE_MODE',
+ 'enum' => [
+ 'SAFE_MODE',
+ 'FAST_MODE',
+ ],
+ ],
+ 'RollbackSQL' => [
+ 'description' => 'The SQL statements used to roll back the data import.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **RollbackSqlType** parameter to **TEXT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'empty',
+ ],
+ 'RollbackAttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to roll back the data import. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of the AttachmentKey parameter.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **RollbackSqlType** parameter to **ATTACHMENT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rollback.sql',
+ ],
+ 'RollbackSqlType' => [
+ 'description' => 'The format of the SQL statements used to roll back the data import. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**: text'."\n"
+ .'* **ATTACHMENT**: attachment'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ 'ATTACHMENT',
+ ],
+ ],
+ 'ExecMode' => [
+ 'type' => 'string',
+ 'default' => 'COMMITOR',
+ 'enum' => [
+ 'COMMITOR',
+ 'AUTO',
+ 'LAST_AUDITOR',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment that provides more instructions for the ticket. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of the AttachmentKey parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateDataImportOrderResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <Success>true</Success>\\n <CreateOrderResult>1****</CreateOrderResult>\\n</CreateDataImportOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateDataImportOrder',
+ 'description' => 'For more information about the Large Data Import feature, see [Import data](~~161439~~).'."\n",
+ ],
+ 'CreateFreeLockCorrectOrder' => [
+ 'summary' => 'Creates a lock-free change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms1AAQ1Q',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders of the data change. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the data change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'ExecSQL' => [
+ 'description' => 'The SQL statements that you want to execute to change data.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'delete from base_user where 1 = 1;',
+ ],
+ 'SqlType' => [
+ 'description' => 'The format of the SQL statements used to change data. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**: text'."\n"
+ .'* **ATTACHMENT**: attachment. This value is not supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'TEXT',
+ 'default' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ ],
+ ],
+ 'AttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to change data. This parameter is not supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test.sql',
+ ],
+ 'RollbackSQL' => [
+ 'description' => 'The SQL statements used to roll back the data change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'empty',
+ ],
+ 'RollbackAttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to roll back the data change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_rollback.sql',
+ ],
+ 'RollbackSqlType' => [
+ 'description' => 'The format of the SQL statements used to roll back the data change. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**: text'."\n"
+ .'* **ATTACHMENT**: attachment. This value is not supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ 'ATTACHMENT',
+ ],
+ ],
+ 'DbItemList' => [
+ 'description' => 'The databases in which you want to change data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To obtain the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To obtain the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1860****',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'ExecMode' => [
+ 'description' => 'The execution mode of the ticket after the ticket is approved. Valid values:'."\n"
+ ."\n"
+ .'* **COMMITOR**: The data change is performed by the user who submits the ticket.'."\n"
+ .'* **AUTO**: The data change is automatically performed after the ticket is approved.'."\n"
+ .'* **LAST_AUDITOR**: The data change is performed by the last approver of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'COMMITOR',
+ 'default' => 'COMMITOR',
+ 'enum' => [
+ 'COMMITOR',
+ 'AUTO',
+ 'LAST_AUDITOR',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment that provides more instructions for the ticket. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of the AttachmentKey parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '134****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateFreeLockCorrectOrderResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <ErrorCode>UnknownError</ErrorCode>\\n <CreateOrderResult>1340000</CreateOrderResult>\\n</CreateFreeLockCorrectOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateFreeLockCorrectOrder',
+ 'description' => 'For more information about the lock-free change feature, see [Overview](~~207847~~).'."\n"
+ ."\n"
+ .'This operation can be used only for instances that are managed in Stable Change or Security Collaboration mode. For more information, see [Change data without the need to lock tables](~~96145~~) and [Change schemas without locking tables](~~98373~~).'."\n",
+ ],
+ 'ModifyDataCorrectExecSQL' => [
+ 'summary' => 'Modifies the SQL script that is submitted by using a data change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data change ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4328****',
+ ],
+ ],
+ [
+ 'name' => 'ExecSQL',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new SQL script.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'update tb set id = 1 where id = 1;',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4****',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ '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"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Specified parameter OrderId is not valid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidOrderId',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"Specified parameter OrderId is not valid.\\",\\n \\"ErrorCode\\": \\"InvalidOrderId\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDataCorrectExecSQLResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52****</RequestId>\\n <Success>true</Success>\\n</ModifyDataCorrectExecSQLResponse>","errorExample":""}]',
+ 'title' => 'ModifyDataCorrectExecSQL',
+ ],
+ 'PauseDataCorrectSQLJob' => [
+ 'summary' => 'Pauses a SQL task for data change.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data change ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the data change ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '43253',
+ ],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the pause operation. Valid values:'."\n"
+ ."\n"
+ .'* ALL: pauses all SQL tasks.'."\n"
+ .'* SINGLE: pauses a single SQL task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SINGLE',
+ 'enum' => [
+ 'ALL',
+ 'SINGLE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL task. You can call the [GetDataCorrectTaskDetail](~~208481~~) or [ListDBTaskSQLJob](~~207049~~) operation to obtain the value of this parameter.'."\n"
+ ."\n"
+ .'> If Type is set to SINGLE, you must pass in the value of JobId to confirm the ID of the SQL task that you want to pause.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '43253',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4325',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '335C5BC8-490C-56EF-BDDE-94A4B53FEB72',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"335C5BC8-490C-56EF-BDDE-94A4B53FEB72\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<PauseDataCorrectSQLJobResponse>\\n <RequestId>335C5BC8-490C-56EF-BDDE-94A4B53FEB72</RequestId>\\n <Success>true</Success>\\n</PauseDataCorrectSQLJobResponse>","errorExample":""}]',
+ 'title' => 'PauseDataCorrectSQLJob',
+ 'description' => 'You can call this operation only for database instances that are managed in Security Collaboration mode.'."\n",
+ ],
+ 'GetDataCorrectTaskDetail' => [
+ 'summary' => 'Queries the information about a data change, lock-free data change, or data import task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [CreateDataCorrectOrder](~~208388~~), [CreateDataImportOrder](~~208387~~), or [CreateFreeLockCorrectOrder](~~208386~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '12435523',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '14325432',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DataCorrectTaskDetail' => [
+ 'description' => 'The details of the data change task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DBTaskGroupId' => [
+ 'description' => 'The ID of the SQL task group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234235',
+ ],
+ 'jobStatus' => [
+ 'description' => 'The state of the SQL task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The SQL task was initialized.'."\n"
+ .'* **PENDING**: The SQL task waited to be run.'."\n"
+ .'* **BE_SCHEDULED**: The SQL task waited to be scheduled.'."\n"
+ .'* **FAIL**: The SQL task failed.'."\n"
+ .'* **SUCCESS**: The SQL task was successful.'."\n"
+ .'* **PAUSE**: The SQL task was paused.'."\n"
+ .'* **DELETE**: The SQL task was deleted.'."\n"
+ .'* **RUNNING**: The SQL task was being run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'ActualAffectRows' => [
+ 'description' => 'The number of rows affected by the SQL statement.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the task was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-03-05 15:08:55',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DataCorrectTaskDetail\\": {\\n \\"DBTaskGroupId\\": 1234235,\\n \\"jobStatus\\": \\"SUCCESS\\",\\n \\"ActualAffectRows\\": 1,\\n \\"CreateTime\\": \\"2021-03-05 15:08:55\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773</RequestId>\\n<Success>true</Success>\\n<DataCorrectTaskDetail>\\n <DBTaskGroupId>1234235</DBTaskGroupId>\\n <jobStatus>SUCCESS</jobStatus>\\n <ActualAffectRows>1</ActualAffectRows>\\n <CreateTime>2021-03-05 15:08:55</CreateTime>\\n</DataCorrectTaskDetail>","errorExample":""}]',
+ 'title' => 'GetDataCorrectTaskDetail',
+ ],
+ 'GetDataCronClearTaskDetailList' => [
+ 'summary' => 'Queries the details of a historical data cleansing ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can query the ticket ID from the response parameters of the [CreateDataCronClearOrder](~~208385~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '432532',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The object of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C1D39814-9808-47F8-AFE0-AF167239AC9B',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DataCronClearTaskDetailList' => [
+ 'description' => 'The historical data cleansing tasks'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The execution details of each task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DBTaskGroupId' => [
+ 'description' => 'The ID of the SQL task group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432523',
+ ],
+ 'jobStatus' => [
+ 'description' => 'The state of the SQL task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The SQL task was initialized.'."\n"
+ .'* **PENDING**: The SQL task waited to be run.'."\n"
+ .'* **BE_SCHEDULED**: The SQL task waited to be scheduled.'."\n"
+ .'* **FAIL**: The SQL task failed.'."\n"
+ .'* **SUCCESS**: The SQL task was successful.'."\n"
+ .'* **PAUSE**: The SQL task was paused.'."\n"
+ .'* **DELETE**: The SQL task was deleted.'."\n"
+ .'* **RUNNING**: The SQL task was being run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'ActualAffectRows' => [
+ 'description' => 'The number of rows affected by the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the SQL task was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-01-14 10:00:00',
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of SQL tasks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C1D39814-9808-47F8-AFE0-AF167239AC9B\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DataCronClearTaskDetailList\\": [\\n {\\n \\"DBTaskGroupId\\": 432523,\\n \\"jobStatus\\": \\"SUCCESS\\",\\n \\"ActualAffectRows\\": 1,\\n \\"CreateTime\\": \\"2021-01-14 10:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<GetDataCronClearTaskDetailListResponse>\\n <RequestId>C1D39814-9808-47F8-AFE0-AF167239AC9B</RequestId>\\n <Success>true</Success>\\n <DataCronClearTaskDetailList>\\n <DBTaskGroupId>432523</DBTaskGroupId>\\n <jobStatus>SUCCESS</jobStatus>\\n <ActualAffectRows>1</ActualAffectRows>\\n <CreateTime>2021-01-14 10:00:00</CreateTime>\\n </DataCronClearTaskDetailList>\\n <TotalCount>1</TotalCount>\\n</GetDataCronClearTaskDetailListResponse>","errorExample":""}]',
+ 'title' => 'GetDataCronClearTaskDetailList',
+ ],
+ 'GetDataCorrectRollbackFile' => [
+ 'summary' => 'Queries the download URL of the rollback attachment submitted along with a data change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '3CDB8601-AD74-4A47-8114-08E08CD6****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'FileUrl' => [
+ 'description' => 'The download URL of the attachment.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://dmsxxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CDB8601-AD74-4A47-8114-08E08CD6****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"FileUrl\\": \\"https://dmsxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDataCorrectRollbackFileResponse>\\n <RequestId>3CDB8601-AD74-4A47-8114-08E08CD6****</RequestId>\\n <Success>true</Success>\\n <FileUrl>https://dmsxxx</FileUrl>\\n</GetDataCorrectRollbackFileResponse>","errorExample":""}]',
+ 'title' => 'GetDataCorrectRollbackFile',
+ ],
+ 'GetDataCorrectBackupFiles' => [
+ 'summary' => 'Obtains the download URL of the backup file for the specified ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '16679',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '4200000',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'ActionDetail',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters that are required to perform the operation. You do not need to specify this parameter.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4AFF4109-FEFB-44E8-96A3-923B1FA8C46E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DataCorrectBackupFiles' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'FileUrl' => [
+ 'description' => 'The download URL of the backup file for the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'https://xxx.oss-cn-hangzhou.aliyuncs.com/xxx.zip',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AFF4109-FEFB-44E8-96A3-923B1FA8C46E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DataCorrectBackupFiles\\": {\\n \\"FileUrl\\": [\\n \\"https://xxx.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataCorrectBackupFilesResponse>\\n <DataCorrectBackupFiles>\\n <FileUrl>https://xxx.oss-cn-hangzhou.aliyuncs.com/xxx.zip</FileUrl>\\n </DataCorrectBackupFiles>\\n <RequestId>4AFF4109-FEFB-44E8-96A3-923B1FA8C46E</RequestId>\\n <Success>true</Success>\\n</GetDataCorrectBackupFilesResponse>","errorExample":""}]',
+ 'title' => 'GetDataCorrectBackupFiles',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataCorrectOrderDetail' => [
+ 'summary' => 'Queries the information about a data change ticket in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '12557',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ 'FEATUREdms1AAQ1Q',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '420****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'DataCorrectOrderDetail' => [
+ 'description' => 'The information about the data change ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PreCheckDetail' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TaskCheckDO' => [
+ 'description' => 'The precheck details of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserTip' => [
+ 'description' => 'The message that appears when a check step is executed.'."\n",
+ 'type' => 'string',
+ 'example' => 'tip messsage',
+ ],
+ 'CheckStatus' => [
+ 'description' => 'The state of the precheck. Valid values:'."\n"
+ ."\n"
+ .'* **WAITING**: The ticket is pending precheck.'."\n"
+ .'* **RUNNING**: The ticket is being prechecked.'."\n"
+ .'* **SUCCESS**: The ticket passes the precheck.'."\n"
+ .'* **FAIL**: The ticket fails the precheck.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'CheckStep' => [
+ 'description' => 'The check step of the precheck. Valid values:'."\n"
+ ."\n"
+ .'* **SQL_PARSE**: The system checks the syntax of the SQL statement.'."\n"
+ .'* **SQL_TYPE_CHECK**: The system checks the type of the SQL statement.'."\n"
+ .'* **PERMISSION_CHECK**: The system checks the permissions required for the data change.'."\n"
+ .'* **ROW_CHECK**: The system checks the number of affected rows.'."\n",
+ 'type' => 'string',
+ 'example' => 'PERMISSION_CHECK',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'OrderDetail' => [
+ 'description' => 'The details of the ticket.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RbSQL' => [
+ 'description' => 'The SQL statements used to roll back the data change.',
+ 'type' => 'string',
+ 'example' => 'empty',
+ ],
+ 'RbAttachmentName' => [
+ 'description' => 'The name of the attachment that contains the SQL statements used to roll back the data change.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Classify' => [
+ 'description' => 'The category of the reason for the data change.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ExeSQL' => [
+ 'description' => 'The executed SQL statements.',
+ 'type' => 'string',
+ 'example' => 'update t1 set name = \'xxx\' where id <= 100',
+ ],
+ 'EstimateAffectRows' => [
+ 'description' => 'The estimated number of affected rows.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'RbSQLType' => [
+ 'description' => 'The format of the SQL statements used to roll back the data change. Valid values:'."\n"
+ ."\n"
+ .'- **TEXT**: text'."\n"
+ .'- **ATTACHMENT**: attachment',
+ 'type' => 'string',
+ 'example' => 'text',
+ ],
+ 'ActualAffectRows' => [
+ 'description' => 'The number of affected rows that is obtained by the precheck.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'IgnoreAffectRows' => [
+ 'description' => 'Indicates whether the precheck result is ignored. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The precheck result is ignored.'."\n"
+ .'- **false**: The precheck result is not ignored.',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'AttachmentName' => [
+ 'description' => 'The name of the attachment that contains the SQL statements used to change data.',
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'SqlType' => [
+ 'description' => 'The format of the SQL statements used to change data. Valid values:'."\n"
+ ."\n"
+ .'- **TEXT**: text'."\n"
+ .'- **ATTACHMENT**: attachment',
+ 'type' => 'string',
+ 'example' => 'text',
+ ],
+ 'IgnoreAffectRowsReason' => [
+ 'description' => 'The reason why the precheck result is ignored.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'DatabaseList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Database' => [
+ 'description' => 'The information about the database in which data is changed.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1860****',
+ ],
+ 'DbType' => [
+ 'description' => 'The engine of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true.**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx@xxx:3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment.'."\n"
+ .'* dev: development environment.'."\n"
+ .'* pre: pre-release environment.'."\n"
+ .'* test: test environment.'."\n"
+ .'* sit: system integration testing (SIT) environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment.'."\n"
+ .'* pet: stress testing environment.'."\n"
+ .'* stag: staging environment.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Status' => [
+ 'description' => 'The specific state of the data change ticket. Valid values:'."\n"
+ ."\n"
+ .'> The state of the ticket is not exactly equivalent to the status code for the ticket. To query the status code of the ticket, you can call the [GetOrderBaseInfo](~~465868~~) operation and check the value of StatusCode in the response.'."\n"
+ ."\n"
+ .'* **new**: The ticket is created.'."\n"
+ .'* **precheck**: The ticket is in the pre-check phase.'."\n"
+ .'* **precheckFailed**: The ticket failed to pass the precheck.'."\n"
+ .'* **precheck_success**: The ticket passes the precheck and waits to be submitted for approval.'."\n"
+ .'* **toaudit**: The ticket is being reviewed.'."\n"
+ .'* **Approved**: The ticket is approved.'."\n"
+ .'* **reject**: The ticket is rejected.'."\n"
+ .'* **waiting**: The task is submitted and waits to be scheduled.'."\n"
+ .'* **processing**: The task is being executed.'."\n"
+ .'* **Success**: The task is successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'approved',
+ ],
+ 'ExecMode' => [
+ 'description' => 'The execution mode of the ticket after the ticket is approved. Valid values:'."\n"
+ ."\n"
+ .'- **COMMITOR**: The data change is performed by the user who submits the ticket.'."\n"
+ .'- **AUTO**: The data change is automatically performed after the ticket is approved.'."\n"
+ .'- **LAST_AUDITOR**: The data change is performed by the last approver of the ticket.',
+ 'type' => 'string',
+ 'example' => 'COMMITOR',
+ ],
+ 'ConfigDetail' => [
+ 'description' => 'The configurations of the ticket. This parameter is used to store the configuration information specific to a data change ticket type.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DetailType' => [
+ 'description' => 'The type of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* COMMON: regular data change.'."\n"
+ .'* CHUNK_DML: lock-free data change.'."\n"
+ .'* BIG_FILE: large data import.'."\n"
+ .'* CRON_CLEAR_DATA: historical data cleanup.'."\n"
+ .'* PROCEDURE: programmable object change.'."\n",
+ 'type' => 'string',
+ 'example' => 'BIG_FILE',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the file to be imported. This parameter is valid if the value of DetailType is BIG_FILE. Valid values:'."\n"
+ ."\n"
+ .'* **SQL**: an SQL file.'."\n"
+ .'* **CSV**: a CSV file.'."\n"
+ .'* **EXCEL**: an Excel file.'."\n"
+ .'* **JSON**: a JSON file, which is supported only by MongoDB databases.'."\n",
+ 'type' => 'string',
+ 'example' => 'CSV',
+ ],
+ 'CsvTableName' => [
+ 'description' => 'The name of the table to which data is to be imported. This parameter is valid only if the value of DetailType is BIG_FILE. If the value of FileType is SQL, this parameter is empty.'."\n",
+ 'type' => 'string',
+ 'example' => 'tb_import_tb_name',
+ ],
+ 'FileEncoding' => [
+ 'description' => 'The encoding method of the file. This parameter may be empty, which indicates the value of AUTO. Valid values:'."\n"
+ ."\n"
+ .'* **AUTO**: automatic identification.'."\n"
+ .'* **UTF-8**: UTF-8 encoding.'."\n"
+ .'* **GBK**: GBK encoding.'."\n"
+ .'* **ISO-8859-1**: ISO-8859-1 encoding.'."\n",
+ 'type' => 'string',
+ 'example' => 'UTF-8',
+ ],
+ 'Cron' => [
+ 'description' => 'Indicates whether the task is a scheduled task for historical data cleanup. This parameter is a reserved parameter and is valid only if the value of DetailType is CRON_CLEAR_DATA.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'CronCallTimes' => [
+ 'description' => 'The number of times the scheduled task is run. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CronFormat' => [
+ 'description' => 'The CRON expression of the scheduled task. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.'."\n",
+ 'type' => 'string',
+ 'example' => '0 0 2 * * ?',
+ ],
+ 'Duration' => [
+ 'description' => 'The execution duration of the scheduled task. Unit: hour. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA. If the value is greater than 0, an execution duration is set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CronStatus' => [
+ 'description' => 'The state of the scheduled task. If this parameter is empty, the task is not run. Valid values:'."\n"
+ ."\n"
+ .'* PAUSE: The task is suspended.'."\n"
+ .'* WAITING: The task is waiting to be run.'."\n"
+ .'* SUCCESS: The task is run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'CronLastCallStartTime' => [
+ 'description' => 'The time when the task was last run.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-04-19 02:00:00.0',
+ ],
+ 'CronNextCallTime' => [
+ 'description' => 'The time when the task is run next time. This parameter is returned only if the value of CronStatus is SUCCESS.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-04-19 02:00:00'."\n",
+ ],
+ 'CurrentTaskId' => [
+ 'description' => 'The ID of the current data change task. This is a reserved parameter and can be ignored.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '13***',
+ ],
+ 'ImportExtConfig' => [
+ 'description' => 'The additional configuration information about data import. This parameter is valid if the value of DetailType is BIG_FILE.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InsertType' => [
+ 'description' => 'The mode in which data is to be imported to the destination table. Valid values:'."\n"
+ ."\n"
+ .'* **INSERT**: The database checks the primary key during data insertion. If the primary key is duplicated, an error is reported.'."\n"
+ .'* **INSERT_IGNORE**: If the imported data contains data records that are the same as those in the destination table, the new data records are ignored.'."\n"
+ .'* **REPLACE_INTO**: If the imported data contains a row that has the same value for the primary key or unique index as an existing row in the destination table, the system deletes the existing row and inserts the new row into the destination table.'."\n"
+ ."\n"
+ .'> This parameter is valid if the value of FileType is CSV or EXCEL.'."\n",
+ 'type' => 'string',
+ 'example' => 'INSERT',
+ ],
+ 'CsvFirstRowIsColumnDef' => [
+ 'description' => 'Indicates whether the first row of the CSV file contains field names. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The first row in the CSV file contains field names.'."\n"
+ .'* **false**: The first row in the CSV file contains data.'."\n"
+ ."\n"
+ .'> This parameter is valid if the value of **FileType** is **CSV** or **EXCEL**.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'IgnoreError' => [
+ 'description' => 'Indicates whether an error that occurs is ignored. Valid values:'."\n"
+ ."\n"
+ .'* **true**: If an error occurs when SQL statements are being executed, DMS skips the current SQL statement and continues to execute subsequent SQL statements.'."\n"
+ .'* **false**: If an error occurs when SQL statements are being executed, DMS stops executing subsequent SQL statements.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ImportMode' => [
+ 'description' => 'The import mode. Valid values:'."\n"
+ ."\n"
+ .'* **FAST_MODE**: fast mode. In the Execute step, the uploaded file is read and SQL statements are executed to import data to the specified destination database. Compared with the security mode, this mode can be used to import data in a less secure but more efficient manner.'."\n"
+ .'* **SAFE_MODE**: security mode. In the Precheck step, the uploaded file is parsed, and SQL statements or CSV file data is cached. In the Execute step, the cached SQL statements are read and executed to import data, or the cached CSV file data is read and imported to the specified destination database. Compared with the fast mode, this mode can be used to import data in a more secure but less efficient manner.'."\n",
+ 'type' => 'string',
+ 'example' => 'FAST_MODE',
+ ],
+ ],
+ ],
+ 'CronExtConfig' => [
+ 'description' => 'The additional configuration information about historical data cleanup. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OptimizeTableAfterEveryClearTimes' => [
+ 'description' => 'Indicates whether the Periodically Optimize Table feature is enabled. Valid values:'."\n"
+ ."\n"
+ .'* **0** (default): The feature is disabled.'."\n"
+ .'* **A value greater than 0**: The feature is enabled. The value indicates the number of cleanups after which the system performs defragmentation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CurrentClearTaskCount' => [
+ 'description' => 'The number of times defragmentation is performed. This parameter is valid only if the value of OptimizeTableAfterEveryClearTimes is greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"DataCorrectOrderDetail\\": {\\n \\"PreCheckDetail\\": {\\n \\"TaskCheckDO\\": [\\n {\\n \\"UserTip\\": \\"tip messsage\\",\\n \\"CheckStatus\\": \\"SUCCESS\\",\\n \\"CheckStep\\": \\"PERMISSION_CHECK\\"\\n }\\n ]\\n },\\n \\"OrderDetail\\": {\\n \\"RbSQL\\": \\"empty\\",\\n \\"RbAttachmentName\\": \\"test\\",\\n \\"Classify\\": \\"test\\",\\n \\"ExeSQL\\": \\"update t1 set name = \'xxx\' where id <= 100\\",\\n \\"EstimateAffectRows\\": 100,\\n \\"RbSQLType\\": \\"text\\",\\n \\"ActualAffectRows\\": 100,\\n \\"IgnoreAffectRows\\": false,\\n \\"AttachmentName\\": \\"xxx\\",\\n \\"SqlType\\": \\"text\\",\\n \\"IgnoreAffectRowsReason\\": \\"test\\"\\n },\\n \\"DatabaseList\\": {\\n \\"Database\\": [\\n {\\n \\"DbId\\": 0,\\n \\"DbType\\": \\"mysql\\",\\n \\"Logic\\": false,\\n \\"SearchName\\": \\"xxx@xxx:3306\\",\\n \\"EnvType\\": \\"product\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"approved\\",\\n \\"ExecMode\\": \\"COMMITOR\\",\\n \\"ConfigDetail\\": {\\n \\"DetailType\\": \\"BIG_FILE\\",\\n \\"FileType\\": \\"CSV\\",\\n \\"CsvTableName\\": \\"tb_import_tb_name\\",\\n \\"FileEncoding\\": \\"UTF-8\\",\\n \\"Cron\\": true,\\n \\"CronCallTimes\\": 0,\\n \\"CronFormat\\": \\"0 0 2 * * ?\\",\\n \\"Duration\\": 1,\\n \\"CronStatus\\": \\"SUCCESS\\",\\n \\"CronLastCallStartTime\\": \\"2024-04-19 02:00:00.0\\",\\n \\"CronNextCallTime\\": \\"2024-04-19 02:00:00\\\\n\\",\\n \\"CurrentTaskId\\": 0,\\n \\"ImportExtConfig\\": {\\n \\"InsertType\\": \\"INSERT\\",\\n \\"CsvFirstRowIsColumnDef\\": true,\\n \\"IgnoreError\\": false,\\n \\"ImportMode\\": \\"FAST_MODE\\"\\n },\\n \\"CronExtConfig\\": {\\n \\"OptimizeTableAfterEveryClearTimes\\": 0,\\n \\"CurrentClearTaskCount\\": 0\\n }\\n }\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDataCorrectOrderDetailResponse>\\n <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>\\n <DataCorrectOrderDetail>\\n <PreCheckDetail>\\n <UserTip>tip messsage</UserTip>\\n <CheckStatus>SUCCESS</CheckStatus>\\n <CheckStep>PERMISSION_CHECK</CheckStep>\\n </PreCheckDetail>\\n <OrderDetail>\\n <RbSQL>empty</RbSQL>\\n <RbAttachmentName>test</RbAttachmentName>\\n <Classify>test</Classify>\\n <ExeSQL>update t1 set name = \'xxx\' where id &lt;= 100</ExeSQL>\\n <EstimateAffectRows>100</EstimateAffectRows>\\n <RbSQLType>text</RbSQLType>\\n <ActualAffectRows>100</ActualAffectRows>\\n <IgnoreAffectRows>false</IgnoreAffectRows>\\n <AttachmentName>xxx</AttachmentName>\\n <SqlType>text</SqlType>\\n <IgnoreAffectRowsReason>test</IgnoreAffectRowsReason>\\n </OrderDetail>\\n <DatabaseList>\\n <DbId>1860****</DbId>\\n <DbType>mysql</DbType>\\n <Logic>false</Logic>\\n <SearchName>xxx@xxx:3306</SearchName>\\n <EnvType>product</EnvType>\\n </DatabaseList>\\n <Status>approved</Status>\\n <ExecMode>COMMITOR</ExecMode>\\n </DataCorrectOrderDetail>\\n <Success>true</Success>\\n</GetDataCorrectOrderDetailResponse>","errorExample":""}]',
+ 'title' => 'GetDataCorrectOrderDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataCronClearConfig' => [
+ 'summary' => 'Queries the scheduling configuration of a ticket for cleaning up historical data.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DataCronClearConfig' => [
+ 'description' => 'Data configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CronFormat' => [
+ 'description' => 'The crontab expression that you can use to run the task at a specified time. For more information, see [Crontab expression](~~206581~~).'."\n",
+ 'type' => 'string',
+ 'example' => '0 0 23 ? * 7,1',
+ ],
+ 'Duration' => [
+ 'description' => 'The execution duration of the task. Unit: hours. If the value is 0, it indicates the duration is not specified.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'CronStatus' => [
+ 'description' => 'The status of the scheduled task. If this parameter is empty, it indicates the task is not run. Valid values:'."\n"
+ ."\n"
+ .'* PAUSE: The task is suspended.'."\n"
+ .'* WAITING: The task is waiting to be run.'."\n"
+ .'* SUCCESS: The task is complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'PAUSE',
+ ],
+ 'CronCallTimes' => [
+ 'description' => 'The number of times that the task is run.'."\n",
+ 'type' => 'string',
+ 'example' => '2',
+ ],
+ 'CronLastCallStartTime' => [
+ 'description' => 'The time when the task was last run.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-11-18 00:00:00',
+ ],
+ 'CronNextCallTime' => [
+ 'description' => 'The time when the task is run next time. This parameter is displayed only when the status of the scheduled task is SUCCESS.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-11-19 00:00:00',
+ ],
+ 'OptimizeTableAfterEveryClearTimes' => [
+ 'description' => 'Specifies whether to enable automatic execution of the OPTIMIZE TABLE statement. Valid values:'."\n"
+ ."\n"
+ .'* 0: disables automatic execution'."\n"
+ .'* A number greater than 0: enables automatic execution. The number specifies the number of times that cleanup operations must be performed before the OPTIMIZE TABLE statement is automatically executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'CurrentClearTaskCount' => [
+ 'description' => 'The number of times that the Optimize Table statement is automatically exeuted. This parameter is valid only when the value of the OptimizeTableAfterEveryClearTimes parameter is greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DataCronClearConfig\\": {\\n \\"CronFormat\\": \\"0 0 23 ? * 7,1\\",\\n \\"Duration\\": \\"1\\",\\n \\"CronStatus\\": \\"SUCCESS\\",\\n \\"CronCallTimes\\": \\"2\\",\\n \\"CronLastCallStartTime\\": \\"2022-11-18 00:00:00\\",\\n \\"CronNextCallTime\\": \\"2022-11-19 00:00:00\\",\\n \\"OptimizeTableAfterEveryClearTimes\\": 0,\\n \\"CurrentClearTaskCount\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataCronClearConfigResponse>\\n <RequestId>283C461F-11D8-48AA-B695-DF092DA32AF3</RequestId>\\n <Success>true</Success>\\n <DataCronClearConfig>\\n <CronFormat>0 0 23 ? * 7,1</CronFormat>\\n <Duration>1</Duration>\\n <CronStatus>SUCCESS</CronStatus>\\n <CronCallTimes>2</CronCallTimes>\\n <CronLastCallStartTime>2022-11-18 00:00:00</CronLastCallStartTime>\\n <CronNextCallTime>2022-11-19 00:00:00</CronNextCallTime>\\n <OptimizeTableAfterEveryClearTimes>0</OptimizeTableAfterEveryClearTimes>\\n <CurrentClearTaskCount>0</CurrentClearTaskCount>\\n </DataCronClearConfig>\\n</GetDataCronClearConfigResponse>","errorExample":""}]',
+ 'title' => 'GetDataCronClearConfig',
+ ],
+ 'GetDataCorrectSQLFile' => [
+ 'summary' => 'Queries the download URL of the SQL script for a data change task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '730000',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'FileUrl' => [
+ 'description' => 'The download URL of the SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://dmsxxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"FileUrl\\": \\"https://dmsxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDataCorrectSQLFileResponse>\\n <FileUrl>https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/uplJMIpQ%3D</FileUrl>\\n <RequestId>386EAA20-67FB-4D06-B7BF-2ABA11241185</RequestId>\\n <Success>true</Success>\\n</GetDataCorrectSQLFileResponse>","errorExample":""}]',
+ 'title' => 'GetDataCorrectSQLFile',
+ 'description' => 'This operation applies to [regular data change](~~58419~~) and [batch data import](~~144643~~).'."\n",
+ ],
+ 'ListDataCorrectPreCheckSQL' => [
+ 'summary' => 'Queries the information about SQL statements that are involved in the precheck of a data change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data change ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the data change ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '453****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1930****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '31853A2B-DC9D-5B39-8492-D2AC8BCF550E',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PreCheckSQLList' => [
+ 'description' => 'The precheck information about SQL statements.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheckSQL' => [
+ 'description' => 'The SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'OPTIMIZE TABLE `Text_TableNames`',
+ ],
+ 'AffectRows' => [
+ 'description' => 'The estimated number of affected rows.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1930****',
+ ],
+ 'SQLReviewQueryKey' => [
+ 'description' => 'The key that is used to query the details of optimization suggestions. You can call the [GetSQLReviewOptimizeDetail](~~265977~~) operation to query the details of optimization suggestions based on the key.'."\n",
+ 'type' => 'string',
+ 'example' => 'b9e771fc6ec247dea6d06a32c777****',
+ ],
+ 'SqlReviewStatus' => [
+ 'description' => 'The review status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **WAITING**: The SQL statement is pending for review.'."\n"
+ .'* **RUNNING**: The SQL statement is being reviewed.'."\n"
+ .'* **IGNORE**: The SQL statement review is skipped.'."\n"
+ .'* **PASS**: The SQL statement passed the review.'."\n"
+ .'* **BLOCK**: The SQL statement failed the review.'."\n",
+ 'type' => 'string',
+ 'example' => 'WAITING',
+ ],
+ 'SqlType' => [
+ 'description' => 'The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.'."\n",
+ 'type' => 'string',
+ 'example' => 'OPTIMIZE',
+ ],
+ 'TableNames' => [
+ 'description' => 'The name of the table whose data is changed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Text_TableNames',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"31853A2B-DC9D-5B39-8492-D2AC8BCF550E\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"PreCheckSQLList\\": [\\n {\\n \\"CheckSQL\\": \\"OPTIMIZE TABLE `Text_TableNames`\\",\\n \\"AffectRows\\": 0,\\n \\"DbId\\": 0,\\n \\"SQLReviewQueryKey\\": \\"b9e771fc6ec247dea6d06a32c777****\\",\\n \\"SqlReviewStatus\\": \\"WAITING\\",\\n \\"SqlType\\": \\"OPTIMIZE\\",\\n \\"TableNames\\": \\"Text_TableNames\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDataCorrectPreCheckSQLResponse>\\n <RequestId>31853A2B-DC9D-5B39-8492-D2AC8BCF550E</RequestId>\\n <PreCheckSQLList>\\n <CheckSQL>OPTIMIZE TABLE `Text_TableNames`</CheckSQL>\\n <SqlReviewStatus>WAITING</SqlReviewStatus>\\n <TableNames>`Text_TableNames`,</TableNames>\\n <DbId>1930****</DbId>\\n <SqlType>OPTIMIZE</SqlType>\\n <AffectRows>0</AffectRows>\\n </PreCheckSQLList>\\n <Success>true</Success>\\n</ListDataCorrectPreCheckSQLResponse>","errorExample":""}]',
+ 'title' => 'ListDataCorrectPreCheckSQL',
+ 'description' => 'For more information about the Normal Data Modify feature, see [Change regular data](~~58419~~).'."\n",
+ ],
+ 'ListDataCorrectPreCheckDB' => [
+ 'summary' => 'Queries the databases that are involved in the precheck of a data change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket for the data change.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '432****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n"
+ ."\n"
+ .'Valid values: an integer that is greater than 0.'."\n"
+ ."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4321****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '95A972AF-FAED-4768-9360-7C0DF5D594D0',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PreCheckDBList' => [
+ 'description' => 'The information about the databases that are involved in the precheck.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43***',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@localhost:3306',
+ ],
+ 'SqlNum' => [
+ 'description' => 'The number of SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95A972AF-FAED-4768-9360-7C0DF5D594D0\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"PreCheckDBList\\": [\\n {\\n \\"DbId\\": 0,\\n \\"SearchName\\": \\"test@localhost:3306\\",\\n \\"SqlNum\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDataCorrectPreCheckDBResponse>\\n <RequestId>A793B353-2D13-47A3-AF45-53798FBD864F</RequestId>\\n <PreCheckDBList>\\n <SqlNum>1</SqlNum>\\n <SearchName>poc_dev@rm-uf61****1w0926d66.mysql.rds.aliyuncs.com:3306【poc_dev】</SearchName>\\n <DbId>8050000</DbId>\\n </PreCheckDBList>\\n <Success>true</Success>\\n</ListDataCorrectPreCheckDBResponse>","errorExample":""}]',
+ 'title' => 'ListDataCorrectPreCheckDB',
+ 'description' => 'For more information about the Normal Data Modify feature, see [Change regular data](~~58419~~).'."\n",
+ ],
+ 'ExecuteDataCorrect' => [
+ 'summary' => 'Submits a ticket for data change.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '16677',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '406****',
+ ],
+ ],
+ [
+ 'name' => 'ActionDetail',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters that are required to perform the data change.'."\n"
+ ."\n"
+ .'```'."\n"
+ ."\n"
+ .'json'."\n"
+ .'"actionDetail" : {'."\n"
+ .' "startTime" :"2021-07-01 00:00:00", // Specify the start time to change data. If you want to immediately change data, you do not need to set this parameter. '."\n"
+ .' "endTime" : "2021-07-01 01:00:00", // Specify the end time to change data. If you want to immediately change data, you do not need to set this parameter. '."\n"
+ .' "transaction" : false, // Specify whether to change data as a transaction. '."\n"
+ .' "backupData" : true // Specify whether to back up data. '."\n"
+ .' }'."\n"
+ .'```'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'example' => '{ "startTime" : "2021-07-01 00:00:00", "endTime" : "2021-07-01 01:00:00", "transaction" : false, "backupData" : true }',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to call the API operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'EADDA791-2809-58CE-A303-743A77FF****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unknown server error',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EADDA791-2809-58CE-A303-743A77FF****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ExecuteDataCorrectResponse>\\n <RequestId>EADDA791-2809-58CE-A303-743A77FF****</RequestId>\\n <Success>true</Success>\\n</ExecuteDataCorrectResponse>","errorExample":""}]',
+ 'title' => 'ExecuteDataCorrect',
+ ],
+ 'RetryDataCorrectPreCheck' => [
+ 'summary' => 'Reruns the precheck for a data change ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data change ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the data change ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '414****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5BC081C7-5F77-5C92-9758-E1ED17CA****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'OrderId is mandatory for this action.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingOrderId',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BC081C7-5F77-5C92-9758-E1ED17CA****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"OrderId is mandatory for this action.\\",\\n \\"ErrorCode\\": \\"MissingOrderId\\"\\n}","errorExample":""},{"type":"xml","example":"<RetryDataCorrectPreCheckResponse>\\n <RequestId>5BC081C7-5F77-5C92-9758-E1ED17CA****</RequestId>\\n <Success>true</Success>\\n</RetryDataCorrectPreCheckResponse>","errorExample":""}]',
+ 'title' => 'RetryDataCorrectPreCheck',
+ ],
+ 'RestartDataCorrectSQLJob' => [
+ 'summary' => 'Reruns a failed SQL task for data change.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data change ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the data change ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '453****',
+ ],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the rerun operation. Valid values:'."\n"
+ ."\n"
+ .'* **ALL**: reruns all SQL tasks.'."\n"
+ .'* **SINGLE**: reruns a single SQL task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ALL',
+ 'enum' => [
+ 'ALL',
+ 'SINGLE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL task. You can call the [GetDataCorrectTaskDetail](~~208481~~) and [ListDBTaskSQLJob](~~207049~~) operations to obtain the value of this parameter.'."\n"
+ ."\n"
+ .'If the Type parameter is set to SINGLE, you must pass the value of the JobId parameter to confirm the ID of the SQL task that you want to rerun.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '43253',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '809B52F2-CD2B-53DA-88C8-F7042787E673',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"809B52F2-CD2B-53DA-88C8-F7042787E673\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartDataCorrectSQLJobResponse>\\n <RequestId>809B52F2-CD2B-53DA-88C8-F7042787E673</RequestId>\\n <Success>true</Success>\\n</RestartDataCorrectSQLJobResponse>","errorExample":""}]',
+ 'title' => 'RestartDataCorrectSQLJob',
+ ],
+ 'ListDataImportSQLPreCheckDetail' => [
+ 'summary' => 'Queries the precheck information of SQL statements used for data import in a ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'SqlType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **SELECT**'."\n"
+ .'* **INSERT**'."\n"
+ .'* **DELETE**'."\n"
+ .'* **CREATE_TABLE**'."\n"
+ ."\n"
+ .'> You can log on to the Data Management (DMS) console and choose **Security and Specifications** > **Operation Audit** in the top navigation bar to view more types of SQL statements.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INSERT',
+ ],
+ ],
+ [
+ 'name' => 'StatusCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The state of the ticket. If you leave this parameter empty, all the states are queried by default. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The ticket is being initialized.'."\n"
+ .'* **RUNNING**: The ticket is in progress.'."\n"
+ .'* **SUCCESS**: The ticket is complete.'."\n"
+ .'* **TIMEOUT**: The ticket is skipped due to timeout.'."\n"
+ .'* **FAIL**: The ticket fails.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SUCCESS',
+ ],
+ ],
+ [
+ 'name' => 'PageNumer',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\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' => '31853A2B-DC9D-5B39-8492-D2AC8BCF550E',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PreCheckSQLDetailList' => [
+ 'description' => 'The precheck information of SQL statements.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The precheck information of the SQL statement.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SqlId' => [
+ 'description' => 'The SQL ID, which indicates the sequence number of the SQL statement. The number starts with 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'SqlType' => [
+ 'description' => 'The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.'."\n",
+ 'type' => 'string',
+ 'example' => 'INSERT',
+ ],
+ 'StatusCode' => [
+ 'description' => 'The state of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The ticket was being initialized.'."\n"
+ .'* **RUNNING**: The ticket was in progress.'."\n"
+ .'* **SUCCESS**: The ticket was complete.'."\n"
+ .'* **TIMEOUT**: The ticket was skipped due to timeout.'."\n"
+ .'* **FAIL**: The ticket failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'Skip' => [
+ 'description' => 'Indicates whether the precheck of the SQL statement was skipped. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The number of SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31853A2B-DC9D-5B39-8492-D2AC8BCF550E\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"PreCheckSQLDetailList\\": [\\n {\\n \\"SqlId\\": 1,\\n \\"SqlType\\": \\"INSERT\\",\\n \\"StatusCode\\": \\"SUCCESS\\",\\n \\"Skip\\": true\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]',
+ 'title' => 'ListDataImportSQLPreCheckDetail',
+ 'description' => 'You can call this operation only if the data is imported in security mode in your data import ticket.'."\n",
+ ],
+ 'ListDataImportSQLType' => [
+ 'summary' => 'Queries the types of SQL statements used for data import in a ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\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' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE49D6',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'SqlTypeResult' => [
+ 'description' => 'The types of SQL statements.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The type of the SQL statement, such as DELETE, UPDATE, or INSERT.'."\n",
+ 'type' => 'string',
+ 'example' => 'INSERT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5EE2B9E-2F95-57FA-B284-CB441CEE49D6\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"SqlTypeResult\\": [\\n \\"INSERT\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListDataImportSQLType',
+ 'description' => 'You can call this operation only if the data is imported in security mode in your data import ticket.'."\n",
+ ],
+ 'GetDataImportSQL' => [
+ 'summary' => 'Queries the SQL statements used for data import in a ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '14****',
+ ],
+ ],
+ [
+ 'name' => 'SqlId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The SQL ID. You can call the ListDataImportSQLPreCheckDetail operation to query the SQL ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '15****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\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' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'SQLDetail' => [
+ 'description' => 'The details of SQL statements.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecSql' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'insert into t1 values (1);',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"SQLDetail\\": {\\n \\"ExecSql\\": \\"insert into t1 values (1);\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataImportSQL',
+ 'description' => 'You can call this operation only if the data is imported in security mode in your data import ticket.'."\n",
+ ],
+ 'SkipDataCorrectRowCheck' => [
+ 'summary' => 'Skips the verification on the number of rows in the precheck for data change.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'Reason',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The reason for skipping the verification on the number of rows in the precheck for data change.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'save test time',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","type":"json"}]',
+ 'title' => 'SkipDataCorrectRowCheck',
+ ],
+ 'CreateProcCorrectOrder' => [
+ 'summary' => 'Creates a programmable object ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsILBT4A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The operators that are related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the operator that is related to the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1342**',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the programmable object change.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'DbItemList' => [
+ 'description' => 'The information about the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the database.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID. Databases are divided into physical databases and logical databases.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '19721978',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'RollbackSQL' => [
+ 'description' => 'The SQL statements for rolling back the data change.'."\n"
+ ."\n"
+ .'> This parameter is required if you set the **RollbackSqlType** parameter to **TEXT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'empty',
+ ],
+ 'RollbackAttachmentName' => [
+ 'description' => 'The key of the attachment that contains the SQL statements used to roll back the data change. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key from the value of AttachmentKey.'."\n"
+ ."\n"
+ .'> This parameter is required if you set **RollbackSqlType** to **ATTACHMENT**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_rollback.sql',
+ ],
+ 'RollbackSqlType' => [
+ 'description' => 'The format of the SQL statements used to roll back the data change. Valid values:'."\n"
+ ."\n"
+ .'* **TEXT**'."\n"
+ .'* **ATTACHMENT**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TEXT',
+ 'enum' => [
+ 'TEXT',
+ 'ATTACHMENT',
+ ],
+ ],
+ 'ExecSQL' => [
+ 'description' => 'The SQL statements for data change.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'DELIMITER ///'."\n"
+ .'CREATE PROCEDURE GetAllProducts()'."\n"
+ .'BEGIN'."\n"
+ .'SELECT * FROM base_user;'."\n"
+ .'END ///',
+ ],
+ 'ExecMode' => [
+ 'description' => 'The mode in which the data change ticket is executed after the ticket is approved. Valid values:'."\n"
+ ."\n"
+ .'* **COMMITOR**: The ticket is executed by the user who submits the ticket.'."\n"
+ .'* **AUTO**: The ticket is automatically executed after the ticket is approved.'."\n"
+ .'* **LAST_AUDITOR**: The ticket is executed by the last approver of the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'COMMITOR',
+ 'default' => 'COMMITOR',
+ 'enum' => [
+ 'COMMITOR',
+ 'AUTO',
+ 'LAST_AUDITOR',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment for the ticket. The attachment provides more instructions for this operation.'."\n"
+ ."\n"
+ .'You can call the [GetUserUploadFileJob](~~206069~~) operation to query the key of the attachment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4***',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The ticket IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12*****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","type":"json"}]',
+ 'title' => 'CreateProcCorrectOrder',
+ 'description' => 'You can call this API operation only for database instances that are managed in Security Collaboration mode.'."\n",
+ ],
+ 'CreatePublishGroupTask' => [
+ 'summary' => 'Executes a schema design ticket.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n"
+ ."\n"
+ .'> : You can create a schema design ticket in the DMS console. For more information, see [Design schemas](~~69711~~). You can also create a schema design ticket by calling the [CreateOrder](~~144649~~) operation and obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '142435',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database for which the schema design is executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Indicates whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'PublishStrategy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The policy to execute the schema design ticket. Valid values:'."\n"
+ ."\n"
+ .'* IMMEDIATELY: immediately executes the schema design ticket.'."\n"
+ .'* REGULARLY: executes the schema design ticket at a scheduled time.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'IMMEDIATELY',
+ 'enum' => [
+ 'IMMEDIATELY',
+ 'REGULARLY',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PlanTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time to execute the schema design ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2019-10-10 00:00:00',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '413452',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 0,\\n \\"RequestId\\": \\"28A1B16E-8CC7-51C3-A298-B8FC79AEB0A0\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreatePublishGroupTask',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDDLPublishRecords' => [
+ 'summary' => 'Queries the publishing details of a schema design ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms867K9R',
+ ],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '结构设计功能为重页面编辑态控制台功能，无完整API，无法完成自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n"
+ ."\n"
+ .'> You can create a schema design ticket in the Data Management (DMS) console. For more information, see [Design schemas](~~69711~~). You can also call the [CreateOrder](~~144649~~) operation to create a schema design ticket and obtain the ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3214325',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, log on to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A1549FB0-D4B8-4140-919F-17322C1072B8',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DDLPublishRecordList' => [
+ 'description' => 'The details of the publishing records.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The publishing record.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AuditStatus' => [
+ 'description' => 'The approval state of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **EXEMPT_PASS**: The ticket passes without approval.'."\n"
+ .'* **TO_AUDIT**: The ticket is pending for approval.'."\n"
+ .'* **CANCEL**: The ticket is canceled.'."\n"
+ .'* **SUCCESS**: The ticket is approved.'."\n"
+ .'* **FAIL**: The ticket fails to pass the approval.'."\n",
+ 'type' => 'string',
+ 'example' => 'CANCEL',
+ ],
+ 'AuditExpireTime' => [
+ 'description' => 'The time when the approval expires.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-14 20:52:38',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the ticket. You can obtain the user ID by calling the [GetUser](~~147098~~) operation and querying the value of the UserId parameter. The value is not the unique ID (UID) of the Alibaba Cloud account.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1423',
+ ],
+ 'Finality' => [
+ 'description' => 'Indicates whether the approval is terminated. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The approval is terminated.'."\n"
+ .'* **false**: The approval is not terminated.'."\n"
+ ."\n"
+ .'> Multiple reasons can terminate the approval. For example, you withdraw the application or your ticket is not approved before the specified time.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'FinalityReason' => [
+ 'description' => 'The reason for the termination.'."\n",
+ 'type' => 'string',
+ 'example' => 'CANCEL',
+ ],
+ 'PublishStatus' => [
+ 'description' => 'The publishing state of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **START**: The ticket is created.'."\n"
+ .'* **ANALYZE**: The ticket is under analysis.'."\n"
+ .'* **AUDIT**: The ticket is under approval.'."\n"
+ .'* **DISPATCH**: A task is generated for the ticket.'."\n"
+ .'* **SUCCESS**: The task is successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'AUDIT',
+ ],
+ 'RiskLevel' => [
+ 'description' => 'The risk level of the operation. Valid values:'."\n"
+ ."\n"
+ .'* **NONE_RISK**: The operation does not have risks.'."\n"
+ .'* **LOW_RISK**: The operation is at low risk.'."\n"
+ .'* **MIDDLE_RISK**: The operation is at medium risk.'."\n"
+ .'* **HIGH_RISK**: The operation is at high risk.'."\n",
+ 'type' => 'string',
+ 'example' => 'LOW_RISK',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the publishing state.'."\n",
+ 'type' => 'string',
+ 'example' => 'CANCEL',
+ ],
+ 'WorkflowInstanceId' => [
+ 'description' => 'The ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432153',
+ ],
+ 'Comment' => [
+ 'title' => '发布备注',
+ 'description' => 'Release remarks.',
+ 'type' => 'string',
+ 'example' => 'Release remarks',
+ ],
+ 'PublishTaskInfoList' => [
+ 'description' => 'The list of publishing tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the publishing task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4325',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: the database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'PlanTime' => [
+ 'description' => 'The time to publish the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-14 20:52:38',
+ ],
+ 'PublishStrategy' => [
+ 'description' => 'The publishing policy. Valid values:'."\n"
+ ."\n"
+ .'* **IMMEDIATELY**: immediately publishes the ticket.'."\n"
+ .'* **REGULARLY**: publishes the ticket at a scheduled time.'."\n",
+ 'type' => 'string',
+ 'example' => 'IMMEDIATELY',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the state.'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE',
+ ],
+ 'TaskJobStatus' => [
+ 'description' => 'The state of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE',
+ ],
+ 'PublishJobList' => [
+ 'description' => 'The list of the publishing tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the publishing task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecuteCount' => [
+ 'description' => 'The number of SQL statements that are executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'Scripts' => [
+ 'description' => 'The script for data changes.'."\n",
+ 'type' => 'string',
+ 'example' => 'ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table after the change.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_toolkit_rename_table_after_rename',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the state.'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE',
+ ],
+ 'TaskJobStatus' => [
+ 'description' => 'The state of the publishing task. Valid values:'."\n"
+ ."\n"
+ .'* **NONE**: The state of the task is unknown.'."\n"
+ .'* **SUCCESS**: The task is successful.'."\n"
+ .'* **FAIL**: The task fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'NONE',
+ ],
+ 'DBTaskGroupId' => [
+ 'description' => 'The ID of the SQL task group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '423515',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1549FB0-D4B8-4140-919F-17322C1072B8\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DDLPublishRecordList\\": [\\n {\\n \\"AuditStatus\\": \\"CANCEL\\",\\n \\"AuditExpireTime\\": \\"2020-12-14 20:52:38\\",\\n \\"CreatorId\\": 1423,\\n \\"Finality\\": true,\\n \\"FinalityReason\\": \\"CANCEL\\",\\n \\"PublishStatus\\": \\"AUDIT\\",\\n \\"RiskLevel\\": \\"LOW_RISK\\",\\n \\"StatusDesc\\": \\"CANCEL\\",\\n \\"WorkflowInstanceId\\": 432153,\\n \\"Comment\\": \\"发布备注\\",\\n \\"PublishTaskInfoList\\": [\\n {\\n \\"DbId\\": 4325,\\n \\"Logic\\": false,\\n \\"PlanTime\\": \\"2020-12-14 20:52:38\\",\\n \\"PublishStrategy\\": \\"IMMEDIATELY\\",\\n \\"StatusDesc\\": \\"NONE\\",\\n \\"TaskJobStatus\\": \\"NONE\\",\\n \\"PublishJobList\\": [\\n {\\n \\"ExecuteCount\\": 0,\\n \\"Scripts\\": \\"ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL\\",\\n \\"TableName\\": \\"test_toolkit_rename_table_after_rename\\",\\n \\"StatusDesc\\": \\"NONE\\",\\n \\"TaskJobStatus\\": \\"NONE\\",\\n \\"DBTaskGroupId\\": 423515\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDDLPublishRecordsResponse>\\n <RequestId>A1549FB0-D4B8-4140-919F-17322C1072B8</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <ErrorCode>UnknownError</ErrorCode>\\n <DDLPublishRecordList>\\n <AuditStatus>CANCEL</AuditStatus>\\n <AuditExpireTime>2020-12-14 20:52:38</AuditExpireTime>\\n <CreatorId>1423</CreatorId>\\n <Finality>true</Finality>\\n <FinalityReason>CANCEL</FinalityReason>\\n <PublishStatus>AUDIT</PublishStatus>\\n <RiskLevel>LOW_RISK</RiskLevel>\\n <StatusDesc>CANCEL</StatusDesc>\\n <WorkflowInstanceId>432153</WorkflowInstanceId>\\n <Comment>我是发布备注</Comment>\\n <PublishTaskInfoList>\\n <DbId>4325</DbId>\\n <Logic>false</Logic>\\n <PlanTime>2020-12-14 20:52:38</PlanTime>\\n <PublishStrategy>IMMEDIATELY</PublishStrategy>\\n <StatusDesc>NONE</StatusDesc>\\n <TaskJobStatus>NONE</TaskJobStatus>\\n <PublishJobList>\\n <ExecuteCount>0</ExecuteCount>\\n <Scripts>ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL</Scripts>\\n <TableName>test_toolkit_rename_table_after_rename</TableName>\\n <StatusDesc>NONE</StatusDesc>\\n <TaskJobStatus>NONE</TaskJobStatus>\\n <DBTaskGroupId>423515</DBTaskGroupId>\\n </PublishJobList>\\n </PublishTaskInfoList>\\n </DDLPublishRecordList>\\n</ListDDLPublishRecordsResponse>","errorExample":""}]',
+ 'title' => 'ListDDLPublishRecords',
+ ],
+ 'GetTableDesignProjectFlow' => [
+ 'summary' => 'Queries the information about a schema design ticket, such as the current node of the ticket, whether the ticket can be returned to the schema design node, and the publishing strategy.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219318',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms867K9R',
+ ],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '结构设计功能相关API不全无法构造完整测试用例进行自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工单号',
+ 'description' => 'The ID of the schema design ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '95****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ProjectFlow' => [
+ 'description' => 'The information about the schema design process.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FlowNodeArray' => [
+ 'description' => 'The nodes in the process.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeRole' => [
+ 'description' => 'The role of the node in the process.'."\n"
+ ."\n"
+ .'* START: The ticket was created.'."\n"
+ .'* DESIGN: The schema is being created.'."\n"
+ .'* PUBLISH: The schema is published.'."\n"
+ .'* END: The ticket is complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'DESIGN',
+ ],
+ 'NodeTitle' => [
+ 'description' => 'The title of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Position' => [
+ 'description' => 'The position of the node in the process. The value starts from 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PublishAnchor' => [
+ 'description' => 'Indicates whether the node is the anchor node. A schema design process has only one anchor node, on which the schema is published. After the schema is published on the anchor node, a post-publish image is generated and the DDL metadata lock is released.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'BackToDesign' => [
+ 'description' => 'Indicates whether the ticket can be returned to the schema design node. Valid values:'."\n"
+ ."\n"
+ .'* **1**: The ticket can be returned to the schema design node.'."\n"
+ .'* **0**: The ticket cannot be returned to the schema design node. This value can be returned only for the PUBLISH node.'."\n",
+ 'type' => 'boolean',
+ 'example' => '1',
+ ],
+ 'CanSkip' => [
+ 'description' => 'Indicates whether the current node can be skipped. Valid values:'."\n"
+ ."\n"
+ .'* **1**: The current node can be skipped.'."\n"
+ .'* **0**: The current node cannot be skipped. This value can be returned only for the PUBLISH node.'."\n",
+ 'type' => 'boolean',
+ 'example' => '0',
+ ],
+ 'PublishStrategies' => [
+ 'description' => 'The available publishing strategies.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The publishing strategy.'."\n"
+ ."\n"
+ .'* **IMMEDIATELY**: immediately publish the schema.'."\n"
+ .'* **REGULARLY**: publish the schema at the scheduled time.'."\n",
+ 'type' => 'string',
+ 'example' => 'IMMEDIATELY',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CurrentPosition' => [
+ 'description' => 'The position of the current node in the process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the security rule set that is applied to the schema design ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql default',
+ ],
+ 'RuleComment' => [
+ 'description' => 'The description of the security rule set that is applied to the schema design ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysq_test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ProjectFlow\\": {\\n \\"FlowNodeArray\\": [\\n {\\n \\"NodeRole\\": \\"DESIGN\\",\\n \\"NodeTitle\\": \\"设计阶段\\",\\n \\"Position\\": 1,\\n \\"PublishAnchor\\": false,\\n \\"BackToDesign\\": true,\\n \\"CanSkip\\": true,\\n \\"PublishStrategies\\": [\\n \\"IMMEDIATELY\\"\\n ]\\n }\\n ],\\n \\"CurrentPosition\\": 2,\\n \\"RuleName\\": \\"mysql default\\",\\n \\"RuleComment\\": \\"mysql缺省规则集\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetTableDesignProjectFlow',
+ ],
+ 'GetTableDesignProjectInfo' => [
+ 'summary' => 'Queries the information about the project and change base database of a schema design ticket, such as the state of the ticket, the ID of the user who created the ticket, and the name and ID of the change base database.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219310',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms867K9R',
+ ],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '结构设计功能为重页面编辑态控制台功能，无完整API，无法完成自动化测试',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工单号',
+ 'description' => 'The ID of the schema design ticket. You can call the [ListOrders](~~465867~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '95****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '48778434-5796-571A-8455-A59146588401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ProjectInfo' => [
+ 'description' => 'The information about the schema design project.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '95****',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The project ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the ticket was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-04-23 02:57:01',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the ticket was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-04-23 02:57:01',
+ ],
+ 'Status' => [
+ 'description' => 'The state of the schema design project. Valid values:'."\n"
+ ."\n"
+ .'* **DESIGN**: The schema is being designed.'."\n"
+ .'* **PUBLISHED**: The schema is published.'."\n"
+ .'* **CLOSE**: The ticket is closed.'."\n",
+ 'type' => 'string',
+ 'example' => 'DESIGN',
+ ],
+ 'Title' => [
+ 'description' => 'The name of the schema design project.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the schema design project.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '71****',
+ ],
+ 'BaseDatabase' => [
+ 'description' => 'The information about the change base database of the schema design ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'example' => 'bk_atc020',
+ ],
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '11****',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc_test',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'POLARDB',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48778434-5796-571A-8455-A59146588401\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ProjectInfo\\": {\\n \\"OrderId\\": 0,\\n \\"ProjectId\\": 0,\\n \\"GmtCreate\\": \\"2024-04-23 02:57:01\\",\\n \\"GmtModified\\": \\"2024-04-23 02:57:01\\",\\n \\"Status\\": \\"DESIGN\\",\\n \\"Title\\": \\"用户增长战役\\",\\n \\"Description\\": \\"测试\\",\\n \\"CreatorId\\": 0,\\n \\"BaseDatabase\\": {\\n \\"SearchName\\": \\"[email protected]\\",\\n \\"SchemaName\\": \\"bk_atc020\\",\\n \\"DbId\\": 0,\\n \\"Logic\\": false,\\n \\"Alias\\": \\"核心交易库\\",\\n \\"EnvType\\": \\"dev\\",\\n \\"DbType\\": \\"POLARDB\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetTableDesignProjectInfo',
+ ],
+ 'CreateDatabaseExportOrder' => [
+ 'summary' => 'Creates a database export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ParentId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the parent ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => ' 877****',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the ticket. This parameter helps reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'document_test',
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment that provides more instructions for the ticket. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'PluginParam',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Classify' => [
+ 'description' => 'The reason for the database export.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'document_test',
+ ],
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '17****',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '137****',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'true',
+ ],
+ 'Config' => [
+ 'description' => 'The configurations for database export.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SQLExtOption' => [
+ 'description' => 'The extension options of the SQL script. You can leave this parameter empty.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The extension option of the SQL script. Valid values:'."\n"
+ ."\n"
+ .'* **DROP**: A DROP TABLE statement is generated before the CREATE statement.'."\n"
+ .'* **TRUNCATE**: A TRUNCATE TABLE statement is generated before an INSERT statement.'."\n"
+ .'* **COMPRESS**: The values to be inserted by an INSERT statement is compressed to 5 MB.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DROP',
+ ],
+ 'required' => true,
+ ],
+ 'DataOption' => [
+ 'description' => 'The export options for big data. The options are used to filter the big data to be exported. You can leave this parameter empty.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The export option for big data. Valid values:'."\n"
+ ."\n"
+ .'* **BLOB**: exports big data of types such as BLOG and TINYBLOB.'."\n"
+ .'* **TEXT**: exports big data of types such as TEXT and TINYTEXT.'."\n"
+ .'* **BINARY**: exports big data of types such as BINARY and VARBINARY.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'BLOB',
+ ],
+ 'required' => true,
+ ],
+ 'ExportContent' => [
+ 'description' => 'The type of data that you want to export. Valid values:'."\n"
+ ."\n"
+ .'* **DATA**: The data of the database is exported.'."\n"
+ .'* **STRUCT**: The schema of the database is exported.'."\n"
+ .'* **DATA_STRUCT**: The data and schema of the database are exported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'DATA',
+ ],
+ 'ExportTypes' => [
+ 'description' => 'The types of schemas that you want to export.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The type of schema that you want to export. Valid values:'."\n"
+ ."\n"
+ .'* **PROCEDURE**'."\n"
+ .'* **FUNCTION**'."\n"
+ .'* **TRIGGER**'."\n"
+ .'* **VIEW**'."\n"
+ .'* **EVENT**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PROCEDURE',
+ ],
+ 'required' => false,
+ ],
+ 'SelectedTables' => [
+ 'description' => 'The tables that you want to export.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table that you want to export.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dmstest_table',
+ ],
+ 'required' => false,
+ ],
+ 'Tables' => [
+ 'description' => 'The conditions used to filter the tables to be exported.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The condition used to filter the tables to be exported.'."\n",
+ 'example' => 'where 1=1',
+ ],
+ ],
+ 'TargetOption' => [
+ 'description' => 'The format in which the database is exported. Valid values:'."\n"
+ ."\n"
+ .'* **SQL**'."\n"
+ .'* **CSV**'."\n"
+ .'* **XLSX**'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SQL',
+ ],
+ ],
+ 'required' => true,
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '[email protected]:3306',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders involved in this operation.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user ID of the stakeholder. The stakeholders involved in this export. All the specified stakeholders can view the ticket details and take part in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2452345113****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CreateOrderResult' => [
+ 'description' => 'The information about the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": {\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateDatabaseExportOrder',
+ ],
+ 'CreateDataExportOrder' => [
+ 'summary' => 'Creates a ticket to export an SQL result set.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '174313',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ParentId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the parent ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '877****',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the ticket. This parameter helps reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'business_test',
+ ],
+ ],
+ [
+ 'name' => 'AttachmentKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the attachment that provides more instructions for the ticket. You can call the [GetUserUploadFileJob](~~206069~~) operation to obtain the attachment key.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'order_attachment.txt',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders involved in this operation.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user ID of the stakeholder. This ID is a user ID and is not the ID of an Alibaba Cloud account. The stakeholders involved in this export. All the specified stakeholders can view the ticket details and take part in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2452345113****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PluginParam',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AffectRows' => [
+ 'description' => 'The estimated number of data rows to be affected.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ 'Classify' => [
+ 'description' => 'The reason for the export ticket.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '132****',
+ ],
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '18****',
+ ],
+ 'Logic' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n"
+ ."\n"
+ .'> If you set this parameter to **true**, the database that you specify must be a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'true',
+ ],
+ 'IgnoreAffectRows' => [
+ 'description' => 'Specifies whether to skip verification. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'true',
+ ],
+ 'IgnoreAffectRowsReason' => [
+ 'description' => 'The reason for skipping verification. This parameter is required if you set IgnoreAffectRows to true.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test only, does not affect the business, and does not require verification.',
+ ],
+ 'ExeSQL' => [
+ 'description' => 'The SQL statements that can be executed.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SELECT * FROM DMS_test'."\n"
+ .' LIMIT 20;',
+ ],
+ 'Watermark' => [
+ 'description' => 'The information about the watermarks.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WatermarkTypes' => [
+ 'description' => 'The methods in which the watermark is embedded.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The method in which the watermark is embedded. Valid values:'."\n"
+ ."\n"
+ .'* **DATA**: embeds identification information into data.'."\n"
+ .'* **FILE**: embeds identification information into files.'."\n"
+ ."\n"
+ .'For more information about watermarks, see [Use data watermarks](~~444281~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DATA',
+ ],
+ 'required' => false,
+ ],
+ 'Keys' => [
+ 'description' => 'One or more primary keys or unique keys.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The primary keys or unique keys. Separate multiple keys with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ID',
+ ],
+ 'required' => false,
+ ],
+ 'ColumnName' => [
+ 'description' => 'The field into which the watermark is to be embedded.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user_number',
+ ],
+ 'DataWatermark' => [
+ 'description' => 'The information to be embedded as a watermark into data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ 'FileWatermark' => [
+ 'description' => 'The information to be embedded as a watermark into files.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud account that actually calls the API.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CreateOrderResult' => [
+ 'description' => 'The content of the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '819****',
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": {\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CreateDataExportOrder',
+ ],
+ 'ExecuteDataExport' => [
+ 'summary' => 'Executes a data export ticket.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '16678',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ActionDetail',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters that are required to perform the operation. Sample code:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "mode" : "FAST", // The mode in which data is exported. Default value: FAST. A value of NORMAL specifies that the export task can be terminated during the export. "encoding" : "UTF8", // The encoding format. "startTime" : "2022-12-22 00:00:00", // The point in time at which data export starts. "transaction" : false, // Specifies whether to enable transactions. "fileType" : "SQL" // The format of the exported file.}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'> You can also set mode, encoding, and fileType to the following values:'."\n"
+ ."\n"
+ .'* mode: NORMAL'."\n"
+ ."\n"
+ .'* encoding: UTF8MB4, GB2312, ISO\\_8859\\_1, GBK, LATAIN1, or CP1252'."\n"
+ ."\n"
+ .'* fileType: XLSX, CSV, JSON, or TXT'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{ "fileType": "CSV", "encoding": "" }',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to call the API operation.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FE8EE2F1-4880-46BC-A704-5CF63EAF9A04</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ExecuteDataExport',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataExportPreCheckDetail' => [
+ 'summary' => 'Queries the precheck details of an SQL result set export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '34****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C1D39814-9808-47F8-AFE0-AF167239AC9B',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PreCheckResult' => [
+ 'description' => 'Indicates the result of the precheck task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IgnoreAffectRows' => [
+ 'description' => 'Specifies whether to skip verification. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ .'- false',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PreCheckDetailList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PreCheckDetailList' => [
+ 'description' => 'The list of pre-check details.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AffectRows' => [
+ 'description' => 'The estimated number of data rows to be affected.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'SQL' => [
+ 'description' => 'The SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT * FROM tmp_table LIMIT 1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1D39814-9808-47F8-AFE0-AF167239AC9B\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"PreCheckResult\\": {\\n \\"IgnoreAffectRows\\": true,\\n \\"PreCheckDetailList\\": {\\n \\"PreCheckDetailList\\": [\\n {\\n \\"AffectRows\\": 1,\\n \\"SQL\\": \\"SELECT * FROM tmp_table LIMIT 1\\"\\n }\\n ]\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GetDataExportPreCheckDetail',
+ ],
+ 'GetDataExportDownloadURL' => [
+ 'summary' => 'Queries the download URL of export results for a data export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '12558',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '546****',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to call the API operation.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '21400447956867****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DownloadURLResult' => [
+ 'description' => 'The details of the download URL of the file that records the export results for the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HasResult' => [
+ 'description' => 'Indicates whether export results are available for download. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TipMessage' => [
+ 'description' => 'The message that indicates an exception.'."\n",
+ 'type' => 'string',
+ 'example' => 'tip message',
+ ],
+ 'URL' => [
+ 'description' => 'The download URL of the file that records the export results for the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4BF24EA5-9013-4C85-AE68-6C23AF5E0097',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DownloadURLResult\\": {\\n \\"HasResult\\": true,\\n \\"TipMessage\\": \\"tip message\\",\\n \\"URL\\": \\"https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\"\\n },\\n \\"RequestId\\": \\"4BF24EA5-9013-4C85-AE68-6C23AF5E0097\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDataExportDownloadURLResponse>\\n <DownloadURLResult>\\n <URL>https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip</URL>\\n <HasResult>true</HasResult>\\n </DownloadURLResult>\\n <RequestId>4BF24EA5-9013-4C85-AE68-6C23AF5E0097</RequestId>\\n <Success>true</Success>\\n</GetDataExportDownloadURLResponse>","errorExample":""}]',
+ 'title' => 'GetDataExportDownloadURL',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDatabaseExportOrderDetail' => [
+ 'summary' => 'Queries the details of a database export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '821****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'CFD8FE00-36D9-4C1B-940D-65A7B73D9066',
+ ],
+ 'DatabaseExportOrderDetail' => [
+ 'description' => 'The details of the database export ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '821****',
+ ],
+ 'Committer' => [
+ 'description' => 'The user who submitted the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmsuser',
+ ],
+ 'CommitterId' => [
+ 'description' => 'The ID of the user who submitted the ticket. This ID is a user ID and is not the ID of an Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '12***',
+ ],
+ 'Comment' => [
+ 'description' => 'The business background information of the database export ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The status description of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'ticket approval',
+ ],
+ 'WorkflowStatusDesc' => [
+ 'description' => 'The status description of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'ticket approval',
+ ],
+ 'KeyInfo' => [
+ 'description' => 'The key information about the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2583****',
+ ],
+ 'DownloadURL' => [
+ 'description' => 'The URL that is used to download the export result.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://oss.xxx.com',
+ ],
+ 'AuditDate' => [
+ 'description' => 'The time when the ticket was submitted.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-13 13:44:59',
+ ],
+ 'Config' => [
+ 'description' => 'The configuration information about the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbName' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ 'ExportContent' => [
+ 'description' => 'The type of data that was exported. Valid values:'."\n"
+ ."\n"
+ .'* **DATA**: The data of the database was exported.'."\n"
+ .'* **STRUCT**: The schema of the database was exported.'."\n"
+ .'* **DATA_STRUCT**: The data and schema of the database were exported.'."\n",
+ 'type' => 'string',
+ 'example' => 'DATA',
+ ],
+ 'TargetOption' => [
+ 'description' => 'The format in which the database was exported. Valid values:'."\n"
+ ."\n"
+ .'* **SQL**'."\n"
+ .'* **CSV**'."\n"
+ .'* **XLSX**'."\n",
+ 'type' => 'string',
+ 'example' => 'SQL',
+ ],
+ 'ExportTypes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ExportTypes' => [
+ 'description' => 'The type of schema that was exported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Valid values:'."\n"
+ ."\n"
+ .'* **PROCEDURE**'."\n"
+ .'* **FUNCTION**'."\n"
+ .'* **TRIGGER**'."\n"
+ .'* **VIEW**'."\n"
+ .'* **EVENT**'."\n",
+ 'type' => 'string',
+ 'example' => 'PROCEDURE',
+ ],
+ ],
+ ],
+ ],
+ 'SelectedTables' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SelectedTables' => [
+ 'description' => 'The tables that were exported from the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'example' => 'user_test',
+ ],
+ ],
+ ],
+ ],
+ 'SQLExtOption' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SQLExtOption' => [
+ 'description' => 'The extension options of the SQL script.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Valid values:'."\n"
+ ."\n"
+ .'* **DROP**: A DROP TABLE statement is generated before the CREATE statement.'."\n"
+ .'* **TRUNCATE**: A TRUNCATE TABLE statement is generated before an INSERT statement.'."\n"
+ .'* **COMPRESS**: The values to be inserted by an INSERT statement is compressed to 5 MB.'."\n",
+ 'type' => 'string',
+ 'example' => 'DROP',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Log' => [
+ 'description' => 'The execution logs.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-12 14:58:32:015 Database Dump Start.'."\n"
+ .'2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0',
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CFD8FE00-36D9-4C1B-940D-65A7B73D9066\\",\\n \\"DatabaseExportOrderDetail\\": {\\n \\"Id\\": 0,\\n \\"Committer\\": \\"dmsuser\\",\\n \\"CommitterId\\": \\"12***\\",\\n \\"Comment\\": \\"测试\\",\\n \\"SearchName\\": \\"[email protected]:3306\\",\\n \\"StatusDesc\\": \\"工单审批中。\\",\\n \\"WorkflowStatusDesc\\": \\"工单审批中。\\",\\n \\"KeyInfo\\": {\\n \\"DbId\\": 0,\\n \\"DownloadURL\\": \\"https://oss.xxx.com\\",\\n \\"AuditDate\\": \\"2023-04-13 13:44:59\\",\\n \\"Config\\": {\\n \\"DbName\\": \\"dmstest\\",\\n \\"ExportContent\\": \\"DATA\\",\\n \\"TargetOption\\": \\"SQL\\",\\n \\"ExportTypes\\": {\\n \\"ExportTypes\\": [\\n \\"PROCEDURE\\"\\n ]\\n },\\n \\"SelectedTables\\": {\\n \\"SelectedTables\\": [\\n \\"user_test\\"\\n ]\\n },\\n \\"SQLExtOption\\": {\\n \\"SQLExtOption\\": [\\n \\"DROP\\"\\n ]\\n }\\n }\\n },\\n \\"Log\\": \\"2023-04-12 14:58:32:015 Database Dump Start.\\\\n2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0\\"\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GetDatabaseExportOrderDetail',
+ ],
+ 'GetDataExportOrderDetail' => [
+ 'summary' => 'Queries the information about a data export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '12559',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~465867~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'DataExportOrderDetail' => [
+ 'description' => 'The information about the data export ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyInfo' => [
+ 'description' => 'The status information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PreCheckId' => [
+ 'description' => 'The precheck ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The state of the data export ticket. Valid values:'."\n"
+ ."\n"
+ .'* **PRE_CHECKING**: The ticket was being prechecked.'."\n"
+ .'* **PRE_CHECK_SUCCESS**: The ticket passed the precheck.'."\n"
+ .'* **PRE_CHECK_FAIL**: The ticket failed to pass the prechecked.'."\n"
+ .'* **WAITING_APPLY_AUDIT**: The ticket was to be submitted for approval.'."\n"
+ .'* **APPLY_AUDIT_SUCCESS**: The ticket was submitted for approval.'."\n"
+ .'* **ENABLE_EXPORT**: The ticket was approved. Data can be exported.'."\n"
+ .'* **WAITING_EXPORT**: Data was to be scheduled for export.'."\n"
+ .'* **DOING_EXPORT**: Data was being exported.'."\n"
+ .'* **EXPORT_FAIL**: Data failed to be exported.'."\n"
+ .'* **EXPORT_SUCCESS**: Data was exported.'."\n",
+ 'type' => 'string',
+ 'example' => 'EXPORT_SUCCESS',
+ ],
+ 'JobId' => [
+ 'description' => 'Export task ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1385****',
+ ],
+ ],
+ ],
+ 'OrderDetail' => [
+ 'description' => 'The details of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database from which data was exported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'Database' => [
+ 'description' => 'The name of the database from which data was exported.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx@xxx:3306',
+ ],
+ 'Classify' => [
+ 'description' => 'The category of the reason for the data export.'."\n",
+ 'type' => 'string',
+ 'example' => 'text',
+ ],
+ 'ExeSQL' => [
+ 'description' => 'The SQL statement that was executed to export data.'."\n",
+ 'type' => 'string',
+ 'example' => 'select 1',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ActualAffectRows' => [
+ 'description' => 'The number of rows that were affected by the SQL statement.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'IgnoreAffectRows' => [
+ 'description' => 'Indicates whether the affected rows are skipped.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'IgnoreAffectRowsReason' => [
+ 'description' => 'The reason why the affected rows are skipped.'."\n",
+ 'type' => 'string',
+ 'example' => 'empty',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"DataExportOrderDetail\\": {\\n \\"KeyInfo\\": {\\n \\"PreCheckId\\": 0,\\n \\"JobStatus\\": \\"EXPORT_SUCCESS\\",\\n \\"JobId\\": 0\\n },\\n \\"OrderDetail\\": {\\n \\"DbId\\": 0,\\n \\"Database\\": \\"xxx@xxx:3306\\",\\n \\"Classify\\": \\"text\\",\\n \\"ExeSQL\\": \\"SELECT * FROM DMS_test\\\\n LIMIT 20;\\",\\n \\"Logic\\": false,\\n \\"ActualAffectRows\\": 1,\\n \\"IgnoreAffectRows\\": false,\\n \\"IgnoreAffectRowsReason\\": \\"empty\\",\\n \\"EnvType\\": \\"test\\"\\n }\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DataExportOrderDetail>\\n <KeyInfo>\\n <PreCheckId>15544</PreCheckId>\\n <JobStatus>EXPORT_SUCCESS</JobStatus>\\n </KeyInfo>\\n <OrderDetail>\\n <Logic>false</Logic>\\n <ActualAffectRows>1</ActualAffectRows>\\n <ExeSQL>select 1;</ExeSQL>\\n <Database>yuyang_test@xxx:3306【yuyang_test_xxx】杭州 非单元化</Database>\\n <IgnoreAffectRows>false</IgnoreAffectRows>\\n <DbId>116367</DbId>\\n <Classify>测试</Classify>\\n <EnvType>product</EnvType>\\n </OrderDetail>\\n</DataExportOrderDetail>\\n<RequestId>78C93646-D9B1-4E6E-B5FD-C69F94A7905A</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetDataExportOrderDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDbExportDownloadURL' => [
+ 'summary' => 'Queries the download URL of the results of a database export ticket.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '73****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DownloadURLResult' => [
+ 'description' => 'The download URL of the exported file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HasResult' => [
+ 'description' => 'Indicates whether export results are available for download. Valid values:'."\n"
+ ."\n"
+ .'* **true**: Export results are available for download.'."\n"
+ .'* **false**: No export results are available for download.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TipMessage' => [
+ 'description' => 'The message that indicates an exception.'."\n",
+ 'type' => 'string',
+ 'example' => 'tip message',
+ ],
+ 'URL' => [
+ 'description' => 'The download URL of the exported file.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request succeeded.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadURLResult\\": {\\n \\"HasResult\\": true,\\n \\"TipMessage\\": \\"tip message\\",\\n \\"URL\\": \\"https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\"\\n },\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GetDbExportDownloadURL',
+ ],
+ 'SuspendDataExportJob' => [
+ 'summary' => 'Suspends an ongoing or scheduled SQL result set export task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '245849',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '903****',
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL result set export task. You can call the [GetDataExportOrderDetail](~~465911~~) operation to obtain the value of this parameter. If you set this parameter to Null, no SQL result set export task is suspended.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1276****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'SuspendDataExportJob',
+ ],
+ 'PauseDataExportJob' => [
+ 'summary' => 'Terminates a SQL result set export task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '245851',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '546****',
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL result set export task. You can call the [GetDataExportOrderDetail](~~465911~~) operation to obtain the value of this parameter. If you set this parameter to Null, no SQL result set export task is suspended.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1276****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'PauseDataExportJob',
+ ],
+ 'RemoveDataExportJob' => [
+ 'summary' => 'Deletes a data export task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '245858',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL result set export task. You can call the [GetDataExportOrderDetail](~~465911~~) operation to obtain the value of this parameter. If you set this parameter to Null, no SQL result set export task is suspended.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1276****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RemoveDataExportJob',
+ ],
+ 'RestartDataExportJob' => [
+ 'summary' => 'Restarts a SQL result set export task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '245856',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '23****',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ticket ID. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL result set export task. You can call the [GetDataExportOrderDetail](~~465911~~) operation to obtain the value of this parameter. If you set this parameter to Null, no SQL result set export task is suspended.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1276****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RestartDataExportJob',
+ ],
+ 'CreateSQLReviewOrder' => [
+ 'summary' => 'Creates a SQL review ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the SQL review. This reduces unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The stakeholders involved in this operation. All the specified stakeholders can view the ticket details and take part in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The IDs of the stakeholders.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123443',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectName' => [
+ 'description' => 'The name of the project.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SQL review for xxx'."\n",
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabases](~~141876~~) operation to query the ID of the database.'."\n"
+ ."\n"
+ .'> You can call this operation to query only physical databases. This operation is unavailable to query logical databases.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123321',
+ ],
+ 'AttachmentKeyList' => [
+ 'description' => 'The files to be reviewed. Multiple files can be reviewed at a time.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The key of the file. You can add multiple keys. To obtain the key of a file, call the [GetUserUploadFileJob](~~206069~~) operation.'."\n"
+ ."\n"
+ .'> Only XML files based on the iBatis or MyBatis framework or TXT files are supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'upload_xxxx.sql',
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The result of the ticket creation task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1423532',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CreateOrderResult\\": [\\n 1423532\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateSQLReviewOrderResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <ErrorCode>UnknownError</ErrorCode>\\n <CreateOrderResult>1423532</CreateOrderResult>\\n</CreateSQLReviewOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateSQLReviewOrder',
+ 'description' => 'You can call this operation only for database instances that are managed in Security Collaboration mode.'."\n"
+ ."\n"
+ .'For more information about the SQL review feature, see [SQL review](~~60374~~).'."\n",
+ ],
+ 'GetSQLReviewCheckResultStatus' => [
+ 'summary' => 'Queries the result of an SQL review.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can obtain the ticket ID from the response parameters of the [CreateSQLReviewOrder](~~257777~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '123321',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'CheckResultStatus' => [
+ 'description' => 'The result of the SQL review.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalSQLCount' => [
+ 'description' => 'The total number of SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'CheckedCount' => [
+ 'description' => 'The number of SQL statements that were reviewed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'CheckStatusResult' => [
+ 'description' => 'The result of the SQL status check.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'New' => [
+ 'description' => 'The number of SQL statements to be reviewed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'Unknown' => [
+ 'description' => 'The number of abnormal SQL statements.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'CheckNotPass' => [
+ 'description' => 'The number of SQL statements that failed to pass the review.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CheckPass' => [
+ 'description' => 'The number of SQL statements that passed the review.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '8',
+ ],
+ 'ForcePass' => [
+ 'description' => 'The number of SQL statements that passed the manual review.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'ForceNotPass' => [
+ 'description' => 'The number of SQL statements that failed to pass the manual review.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'SQLReviewResult' => [
+ 'description' => 'The optimization suggestion for SQL statements.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MustImprove' => [
+ 'description' => 'The number of SQL statements that must be modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'PotentialIssue' => [
+ 'description' => 'The number of SQL statements that have potential issues.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'SuggestImprove' => [
+ 'description' => 'The number of SQL statements that can be modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'UseDmsToolkit' => [
+ 'description' => 'The number of SQL statements that can be used for lock-free schema changes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'UseDmsDmlUnlock' => [
+ 'description' => 'The number of SQL statements that can be used for lock-free data changes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'TableIndexSuggest' => [
+ 'description' => 'The number of SQL statements that can use indexes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"CheckResultStatus\\": {\\n \\"TotalSQLCount\\": 10,\\n \\"CheckedCount\\": 10,\\n \\"CheckStatusResult\\": {\\n \\"New\\": 0,\\n \\"Unknown\\": 0,\\n \\"CheckNotPass\\": 1,\\n \\"CheckPass\\": 8,\\n \\"ForcePass\\": 1,\\n \\"ForceNotPass\\": 0\\n },\\n \\"SQLReviewResult\\": {\\n \\"MustImprove\\": 1,\\n \\"PotentialIssue\\": 0,\\n \\"SuggestImprove\\": 3,\\n \\"UseDmsToolkit\\": 0,\\n \\"UseDmsDmlUnlock\\": 0,\\n \\"TableIndexSuggest\\": 2\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSQLReviewCheckResultStatusResponse>\\n <RequestId>E1ABE358-14A0-4DFA-9776-1A3CB59192DF</RequestId>\\n <CheckResultStatus>\\n <SQLReviewResult>\\n <TableIndexSuggest>1</TableIndexSuggest>\\n <MustImprove>1</MustImprove>\\n <SuggestImprove>1</SuggestImprove>\\n <PotentialIssue>2</PotentialIssue>\\n </SQLReviewResult>\\n <TotalSQLCount>4</TotalSQLCount>\\n <CheckedCount>4</CheckedCount>\\n <CheckStatusResult>\\n <CheckNotPass>1</CheckNotPass>\\n <CheckPass>3</CheckPass>\\n </CheckStatusResult>\\n </CheckResultStatus>\\n <Success>true</Success>\\n</GetSQLReviewCheckResultStatusResponse>","errorExample":""}]',
+ 'title' => 'GetSQLReviewCheckResultStatus',
+ 'description' => 'For more information about the SQL review feature, see [SQL review](~~60374~~).'."\n",
+ ],
+ 'ListSQLReviewOriginSQL' => [
+ 'summary' => 'Queries the details of the SQL statements that are involved in an SQL review ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL review ticket. You can call the [CreateSQLReviewOrder](~~257777~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '123321',
+ ],
+ ],
+ [
+ 'name' => 'OrderActionDetail',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters that are used to filter SQL statements involved in the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => [
+ 'description' => 'The ID of the file that contains the SQL statements to be reviewed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123345',
+ ],
+ 'SQLReviewResult' => [
+ 'description' => 'The optimization suggestion for the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **MUST_IMPROVE**: The SQL statement must be optimized.'."\n"
+ .'* **POTENTIAL_ISSUE**: The SQL statement contains potential issues.'."\n"
+ .'* **SUGGEST_IMPROVE**: We recommend that you optimize the SQL statement.'."\n"
+ .'* **USE_DMS_TOOLKIT**: We recommend that you change schemas without locking tables.'."\n"
+ .'* **USE_DMS_DML_UNLOCK**: We recommend that you change data without locking tables.'."\n"
+ .'* **TABLE_INDEX_SUGGEST**: We recommend that you optimize indexes for the SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MUST_IMPROVE',
+ 'enum' => [
+ 'MUST_IMPROVE',
+ 'POTENTIAL_ISSUE',
+ 'SUGGEST_IMPROVE',
+ 'USE_DMS_TOOLKIT',
+ 'USE_DMS_DML_UNLOCK',
+ 'TABLE_INDEX_SUGGEST',
+ ],
+ ],
+ 'CheckStatusResult' => [
+ 'description' => 'The review status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **new**: The SQL statement was waiting to be reviewed.'."\n"
+ .'* **unknown**: The SQL statement cannot be parsed.'."\n"
+ .'* **check_not_pass**: The SQL statement failed to pass the review.'."\n"
+ .'* **check_pass**: The SQL statement passed the review.'."\n"
+ .'* **force_pass**: The SQL statement passed the manual review.'."\n"
+ .'* **force_not_pass**: The SQL statement failed to pass the manual review.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'check_not_pass',
+ 'enum' => [
+ 'new',
+ 'unknown',
+ 'check_not_pass',
+ 'check_pass',
+ 'force_pass',
+ 'force_not_pass',
+ ],
+ ],
+ 'Page' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '500',
+ 'example' => '20',
+ 'default' => '20',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The number of SQL statements in the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'OriginSQLList' => [
+ 'description' => 'The information about the parsed SQL statements.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'SQLId' => [
+ 'description' => 'The ID of the SQL statement.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1111',
+ ],
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123321',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'test.sql',
+ ],
+ 'SQLContent' => [
+ 'description' => 'The SQL statement in the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'select id from table_name',
+ ],
+ 'CheckStatus' => [
+ 'description' => 'The review status of the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **new**: The SQL statement was waiting to be reviewed.'."\n"
+ .'* **unknown**: The SQL statement cannot be parsed.'."\n"
+ .'* **check_not_pass**: The SQL statement failed to pass the review.'."\n"
+ .'* **check_pass**: The SQL statement passed the review.'."\n"
+ .'* **force_pass**: The SQL statement passed the manual review.'."\n"
+ .'* **force_not_pass**: The SQL statement failed to pass the manual review.'."\n",
+ 'type' => 'string',
+ 'example' => 'check_pass',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the review status.'."\n",
+ 'type' => 'string',
+ 'example' => 'passed the test',
+ ],
+ 'CheckedTime' => [
+ 'description' => 'The time when the SQL statement was reviewed.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-06-09 21:07:00',
+ ],
+ 'SqlHash' => [
+ 'description' => 'The MD5 hash value that is obtained after the SQL statement is calculated by using a hash algorithm.'."\n",
+ 'type' => 'string',
+ 'example' => '95adb6e77a0884d9e50232cb8c5c969d',
+ ],
+ 'ReviewSummary' => [
+ 'description' => 'The statistics on the optimization suggestions for SQL statements. The value is a JSON string. Valid values:'."\n"
+ ."\n"
+ .'* **MUST_IMPROVE**: The SQL statements must be optimized.'."\n"
+ .'* **POTENTIAL_ISSUE**: The SQL statements contain potential issues.'."\n"
+ .'* **SUGGEST_IMPROVE**: We recommend that you optimize the SQL statements.'."\n"
+ .'* **USEDMSTOOLKIT**: We recommend that you change schemas without locking tables.'."\n"
+ .'* **USEDMSDML_UNLOCK**: We recommend that you change data without locking tables.'."\n"
+ .'* **TABLEINDEXSUGGEST**: We recommend that you optimize indexes for the SQL statements.'."\n",
+ 'type' => 'string',
+ 'example' => '{"POTENTIAL_ISSUE":1,"SUGGEST_IMPROVE":1}',
+ ],
+ 'SQLReviewQueryKey' => [
+ 'description' => 'The key that is used to query the information about optimization suggestions. You can call the [GetSQLReviewOptimizeDetail](~~465919~~) operation to query the details based on this key.',
+ 'type' => 'string',
+ 'example' => 'a57e54ec5433475ea3082d882fdb89c5',
+ ],
+ 'SQLName' => [
+ 'description' => 'The name of the SQL statement.'."\n",
+ 'type' => 'string',
+ 'example' => 'getByPk',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0A00863F-6366-5583-9B96-891DC8D8F88A\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"OriginSQLList\\": [\\n {\\n \\"SQLId\\": 1111,\\n \\"FileId\\": 0,\\n \\"FileName\\": \\"test.sql\\",\\n \\"SQLContent\\": \\"CREATE TABLE `test_sql_review_table` (\\\\n `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,\\\\n `gmt_create` datetime NOT NULL,\\\\n `name` varchar(256) DEFAULT NULL\\\\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;\\",\\n \\"CheckStatus\\": \\"check_pass\\",\\n \\"StatusDesc\\": \\"检测通过\\",\\n \\"CheckedTime\\": \\"2021-06-09 21:07:00\\",\\n \\"SqlHash\\": \\"c7992dc1b681c6733894aded7834f423\\",\\n \\"ReviewSummary\\": \\"{\\\\\\\\\\\\\\"SUGGEST_IMPROVE\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"POTENTIAL_ISSUE\\\\\\\\\\\\\\":1}\\",\\n \\"SQLReviewQueryKey\\": \\"6e9a4bc6867a4174a96b23c8b48b****\\",\\n \\"SQLName\\": \\"getByPk\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSQLReviewOriginSQLResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n <TotalCount>10</TotalCount>\\n <OriginSQLList>\\n <SQLId>1111</SQLId>\\n <FileId>123321</FileId>\\n <FileName>test.sql</FileName>\\n <SQLContent>select id from table_name</SQLContent>\\n <CheckStatus>check_pass</CheckStatus>\\n <StatusDesc>检测通过</StatusDesc>\\n <CheckedTime>2021-06-09 21:07:00</CheckedTime>\\n <SqlHash>95adb6e77a0884d9e50232cb8c5c969d</SqlHash>\\n <ReviewSummary>{\\"POTENTIAL_ISSUE\\":1,\\"SUGGEST_IMPROVE\\":1}</ReviewSummary>\\n <SQLReviewQueryKey>a57e54ec5433475ea3082d882fdb89c5</SQLReviewQueryKey>\\n <SQLName>getByPk</SQLName>\\n </OriginSQLList>\\n</ListSQLReviewOriginSQLResponse>","errorExample":""}]',
+ 'title' => 'ListSQLReviewOriginSQL',
+ 'description' => 'For more information about the SQL review feature, see [SQL review](~~60374~~).'."\n",
+ ],
+ 'GetSQLReviewOptimizeDetail' => [
+ 'summary' => 'Queries the details of optimization suggestions. The operation applies only to the tickets for the data changes and SQL review.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SQLReviewQueryKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key that is used to query the details of optimization suggestions. You can call the [ListSQLReviewOriginSQL](~~257870~~) operation to query the key.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'a57e54ec5433475ea3082d882fdb****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'OptimizeDetail' => [
+ 'description' => 'The details of optimization suggestions for SQL statements.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'QueryKey' => [
+ 'description' => 'The key that is used to query the details of optimization suggestions.'."\n",
+ 'type' => 'string',
+ 'example' => 'a57e54ec5433475ea3082d882fdb****',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance to which the database belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123321',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '111222',
+ ],
+ 'SqlType' => [
+ 'description' => 'The type of the SQL statement. Valid values: DELETE, UPDATE, and ALTER_TABLE.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE',
+ ],
+ 'QualityResult' => [
+ 'description' => 'The quality of the SQL statement.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'syntax error',
+ ],
+ 'Results' => [
+ 'description' => 'The review results based on rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the rule. For more information, see [SQL review optimization](~~194114~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT_SUGGEST_ASSIGN_WHERE',
+ ],
+ 'Feedback' => [
+ 'description' => 'The optimization suggestion for the SQL statement. Valid values:'."\n"
+ ."\n"
+ .'* **MUST_IMPROVE**: The SQL statement must be improved.'."\n"
+ .'* **POTENTIAL_ISSUE**: The SQL statement contains potential issues.'."\n"
+ .'* **SUGGEST_IMPROVE**: We recommend that you improve the SQL statement.'."\n"
+ .'* **USEDMSTOOLKIT**: We recommend that you change schemas without locking tables.'."\n"
+ .'* **USEDMSDML_UNLOCK**: We recommend that you change data without locking tables.'."\n"
+ .'* **TABLEINDEXSUGGEST**: We recommend that you use SQL statements that use indexes.'."\n",
+ 'type' => 'string',
+ 'example' => 'MUST_IMPROVE',
+ ],
+ 'Comments' => [
+ 'description' => 'The comment that is specified when you create the SQL review rule. For more information, see [SQL review optimization](~~194114~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx business rule: the query must have a where condition.',
+ ],
+ 'Messages' => [
+ 'description' => 'The review results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'audit information.',
+ 'type' => 'string',
+ 'example' => 'the xxx table does not exist.',
+ ],
+ ],
+ 'Scripts' => [
+ 'description' => 'The SQL script for data changes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpType' => [
+ 'description' => 'The purpose of the SQL script. The value is set to AddIndex.'."\n",
+ 'type' => 'string',
+ 'example' => 'AddIndex',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'alter table xxx add index idx_xx(yyy);',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ ],
+ ],
+ ],
+ 'RuleType' => [
+ 'description' => 'The type of the SQL review rule. Valid values:'."\n"
+ ."\n"
+ .'* **REVIEW**: a rule that is used to review SQL statements based on standards.'."\n"
+ .'* **OPTIMIZE**: a rule that is used to provide optimization suggestions.'."\n",
+ 'type' => 'string',
+ 'example' => 'REVIEW',
+ ],
+ ],
+ ],
+ ],
+ 'OccurError' => [
+ 'description' => 'Indicates whether an error occurs. Valid values:'."\n"
+ ."\n"
+ .'* **true**: An error occurs.'."\n"
+ .'* **false**: No error occurs.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"OptimizeDetail\\": {\\n \\"QueryKey\\": \\"a57e54ec5433475ea3082d882fdb****\\",\\n \\"InstanceId\\": 123321,\\n \\"DbId\\": 111222,\\n \\"SqlType\\": \\"UPDATE\\",\\n \\"QualityResult\\": {\\n \\"ErrorMessage\\": \\"syntax error\\",\\n \\"Results\\": [\\n {\\n \\"RuleName\\": \\"SELECT_SUGGEST_ASSIGN_WHERE\\",\\n \\"Feedback\\": \\"MUST_IMPROVE\\",\\n \\"Comments\\": \\"xxx业务规定：查询必须带where条件\\",\\n \\"Messages\\": [\\n \\"xxx表不存在\\"\\n ],\\n \\"Scripts\\": [\\n {\\n \\"OpType\\": \\"AddIndex\\",\\n \\"Content\\": \\"alter table xxx add index idx_xx(yyy);\\",\\n \\"TableName\\": \\"xxx\\"\\n }\\n ],\\n \\"RuleType\\": \\"REVIEW\\"\\n }\\n ],\\n \\"OccurError\\": false\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSQLReviewOptimizeDetailResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n <OptimizeDetail>\\n <QueryKey>a57e54ec5433475ea3082d882fdb****</QueryKey>\\n <InstanceId>123321</InstanceId>\\n <DbId>111222</DbId>\\n <SqlType>UPDATE</SqlType>\\n <QualityResult>\\n <ErrorMessage>syntax error</ErrorMessage>\\n <Results>\\n <RuleName>SELECT_SUGGEST_ASSIGN_WHERE</RuleName>\\n <Feedback>MUST_IMPROVE</Feedback>\\n <Comments>xxx业务规定：查询必须带where条件</Comments>\\n <Messages>xxx表不存在</Messages>\\n <Scripts>\\n <OpType>AddIndex</OpType>\\n <Content>alter table xxx add index idx_xx(yyy);</Content>\\n <TableName>xxx</TableName>\\n </Scripts>\\n <RuleType>REVIEW</RuleType>\\n </Results>\\n <OccurError>false</OccurError>\\n </QualityResult>\\n </OptimizeDetail>\\n</GetSQLReviewOptimizeDetailResponse>","errorExample":""}]',
+ 'title' => 'GetSQLReviewOptimizeDetail',
+ 'description' => 'For more information about the SQL review feature, see [SQL review](~~60374~~).',
+ ],
+ 'CreateDataTrackOrder' => [
+ 'summary' => 'Creates a data tracking ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose or objective of the data tracking ticket. This parameter is used to help reduce unnecessary communication.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the operators that are related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of an operator that is related to the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123***',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabases](~~141876~~) operation to query the ID of the database.'."\n"
+ ."\n"
+ .'> You can call this operation to create a data tracking ticket for only physical databases. This operation is not applicable to logical databases.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '123***',
+ ],
+ 'JobStartTime' => [
+ 'description' => 'The start time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2023-04-23 00:00:00',
+ ],
+ 'JobEndTime' => [
+ 'description' => 'The end time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2023-04-23 10:00:00',
+ ],
+ 'TableNames' => [
+ 'description' => 'The names of the tables for which you want to track data operations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of a table for which you want to track data operations.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table2',
+ ],
+ 'required' => true,
+ ],
+ 'TrackTypes' => [
+ 'description' => 'The types of data operations that you want to track.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A type of data operation that you want to track. Valid values:'."\n"
+ ."\n"
+ .'* **INSERT**'."\n"
+ .'* **UPDATE**'."\n"
+ .'* **DELETE**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INSERT',
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The IDs of the data tracking tickets.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the data tracking ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","type":"json"}]',
+ 'title' => 'CreateDataTrackOrder',
+ 'description' => 'This operation is available only for instances that are managed in Security Collaboration mode.'."\n",
+ ],
+ 'GetDataTrackJobDegree' => [
+ 'summary' => 'Queries the progress of a data tracking task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '321****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'JobDegree' => [
+ 'description' => 'The progress details of the data tracking task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ListCompletionDegree' => [
+ 'description' => 'The progress of binary log obtaining. Valid values: 0 to 1. A value of 1 indicates that binary log obtaining is complete.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '1',
+ ],
+ 'DownloadCompletionDegree' => [
+ 'description' => 'The progress of binary log download. Valid values: 0 to 1. A value of 1 indicates that binary log download is complete.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '1',
+ ],
+ 'FilterCompletionDegree' => [
+ 'description' => 'The progress of binary log parsing. Valid values: 0 to 1. A value of 1 indicates that binary log parsing is complete.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '1',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The status of the data tracking task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The task is being initialized.'."\n"
+ .'* **LISTING**: The binary logs are being obtained.'."\n"
+ .'* **LIST_SUCCESS**: The binary logs are successfully obtained.'."\n"
+ .'* **DOWNLOADING**: The binary logs are being downloaded.'."\n"
+ .'* **DOWNLOAD_FAIL**: The binary logs failed to be downloaded.'."\n"
+ .'* **DOWNLOAD_SUCCESS**: The binary logs are successfully downloaded.'."\n"
+ .'* **FILTERING**: The binary logs are being parsed.'."\n"
+ .'* **FILTER_FAIL**: The binary logs failed to be parsed.'."\n"
+ .'* **FILTER_SUCCESS**: The binary logs are successfully parsed.'."\n",
+ 'type' => 'string',
+ 'example' => 'FILTER_SUCCESS',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the task status.'."\n",
+ 'type' => 'string',
+ 'example' => 'searching success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"JobDegree\\": {\\n \\"ListCompletionDegree\\": 1,\\n \\"DownloadCompletionDegree\\": 1,\\n \\"FilterCompletionDegree\\": 1,\\n \\"JobStatus\\": \\"FILTER_SUCCESS\\",\\n \\"StatusDesc\\": \\"searching success\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataTrackJobDegree',
+ ],
+ 'GetDataTrackJobTableMeta' => [
+ 'summary' => 'Queries the metadata of tables involved in a data tracking task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TableMetaList' => [
+ 'description' => 'The metadata of tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The metadata of a table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'DB165',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'live_stat',
+ ],
+ 'Columns' => [
+ 'description' => 'The information about columns.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about a column.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'claimantno',
+ ],
+ 'ColumnPosition' => [
+ 'description' => 'The position of the column.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the column. Examples: BIGINT, INT, and VARCHAR.'."\n",
+ 'type' => 'string',
+ 'example' => 'BIGINT',
+ ],
+ 'Fictive' => [
+ 'description' => 'Indicates whether the column is a virtual column. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Charset' => [
+ 'description' => 'The name of the character set.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8mb4',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"TableMetaList\\": [\\n {\\n \\"SchemaName\\": \\"DB165\\",\\n \\"TableName\\": \\"live_stat\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"claimantno\\",\\n \\"ColumnPosition\\": 1,\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"Fictive\\": false,\\n \\"Charset\\": \\"utf8mb4\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'GetDataTrackJobTableMeta',
+ ],
+ 'GetDataTrackOrderDetail' => [
+ 'summary' => 'Queries the details of a data tracking ticket.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '4328****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DataTrackOrderDetail' => [
+ 'description' => 'The details of the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3431****',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DatabaseSearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx@yyy:3306',
+ ],
+ 'TableNames' => [
+ 'description' => 'The names of the tables for which data operations are tracked.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of a table for which data operations are tracked.'."\n",
+ 'type' => 'string',
+ 'example' => 'table2',
+ ],
+ ],
+ 'TrackTypes' => [
+ 'description' => 'The types of data operations that are tracked.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A type of data operation that is tracked.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE',
+ ],
+ ],
+ 'JobStartTime' => [
+ 'description' => 'The start time of the time range in which data operations are tracked. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-23 00:00:00',
+ ],
+ 'JobEndTime' => [
+ 'description' => 'The end time of the time range in which data operations are tracked. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-23 10:00:00',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'as_task',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The status of the data tracking task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The task is being initialized.'."\n"
+ .'* **LISTING**: The binary logs are being obtained.'."\n"
+ .'* **LIST_SUCCESS**: The binary logs are successfully obtained.'."\n"
+ .'* **DOWNLOADING**: The binary logs are being downloaded.'."\n"
+ .'* **DOWNLOAD_FAIL**: The binary logs failed to be downloaded.'."\n"
+ .'* **DOWNLOAD_SUCCESS**: The binary logs are successfully downloaded.'."\n"
+ .'* **FILTERING**: The binary logs are being parsed.'."\n"
+ .'* **FILTER_FAIL**: The binary logs failed to be parsed.'."\n"
+ .'* **FILTER_SUCCESS**: The binary logs are successfully parsed.'."\n",
+ 'type' => 'string',
+ 'example' => 'FILTER_SUCCESS',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the task status.'."\n",
+ 'type' => 'string',
+ 'example' => 'searching success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DataTrackOrderDetail\\": {\\n \\"DbId\\": 0,\\n \\"Logic\\": false,\\n \\"DatabaseSearchName\\": \\"xxx@yyy:3306\\",\\n \\"TableNames\\": [\\n \\"table2\\"\\n ],\\n \\"TrackTypes\\": [\\n \\"UPDATE\\"\\n ],\\n \\"JobStartTime\\": \\"2023-04-23 00:00:00\\",\\n \\"JobEndTime\\": \\"2023-04-23 10:00:00\\",\\n \\"SchemaName\\": \\"as_task\\",\\n \\"JobStatus\\": \\"FILTER_SUCCESS\\",\\n \\"StatusDesc\\": \\"searching success\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataTrackOrderDetail',
+ ],
+ 'SearchDataTrackResult' => [
+ 'summary' => 'Searches for the parsing result of a data tracking task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '420****',
+ ],
+ ],
+ [
+ 'name' => 'FilterStartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The start time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2023-04-23 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'FilterEndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2023-04-23 10:00:00',
+ ],
+ ],
+ [
+ 'name' => 'FilterTableList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the tables for which you want to track data operations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of a table for which you want to track data operations.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table2',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'FilterTypeList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The types of data operations that you want to track.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A type of data operation that you want to track.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'UPDATE',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ColumnFilter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The condition to filter columns.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'c_payer_name',
+ ],
+ 'Operator' => [
+ 'description' => 'The type of the operator used to configure the filter condition. Valid values:'."\n"
+ ."\n"
+ .'* **EQUAL**: retrieves the column whose value is equal to the specified value.'."\n"
+ .'* **NOT_EQUAL**: retrieves the column whose value is not equal to the specified value.'."\n"
+ .'* **IN**: retrieves the column whose value is in the IN list.'."\n"
+ .'* **BETWEEN**: retrieves the column whose value is in the specified range.'."\n"
+ .'* **LESS**: retrieves the column whose value is less than the specified value.'."\n"
+ .'* **MORE**: retrieves the column whose value is greater than the specified value.'."\n"
+ .'* **NOT_IN**: retrieves the column whose value is not in the IN list.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EQUAL',
+ 'enum' => [
+ 'EQUAL',
+ 'NOT_EQUAL',
+ 'IN',
+ 'BETWEEN',
+ 'LESS',
+ 'MORE',
+ 'NOT_IN',
+ ],
+ ],
+ 'Value' => [
+ 'description' => 'The value used in the filter condition.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'BetweenStart' => [
+ 'description' => 'The start value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'BetweenEnd' => [
+ 'description' => 'The end value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'InList' => [
+ 'description' => 'The IN list used in the filter condition. This parameter takes effect only when Operator is set to IN or NOT_IN.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A value in the IN list. This parameter takes effect only when Operator is set to IN or NOT_IN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '62***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TrackResult' => [
+ 'description' => 'The parsing result of the data tracking task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '109',
+ ],
+ 'EventList' => [
+ 'description' => 'The details of the event logs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of an event log.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DataAfter' => [
+ 'description' => 'The data records after you perform data operations in the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A data record after you perform data operations in the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ 'DataBefore' => [
+ 'description' => 'The data records before you perform data operations in the database.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A data record before you perform data operations in the database.'."\n",
+ 'type' => 'string',
+ 'example' => '2',
+ ],
+ ],
+ 'EventLength' => [
+ 'description' => 'The length of the event content. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4324',
+ ],
+ 'EventTimestamp' => [
+ 'description' => 'The event time.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-23 10:25:47',
+ ],
+ 'EventType' => [
+ 'description' => 'The type of the event. Valid values:'."\n"
+ ."\n"
+ .'* **WRITE_ROWS**: indicates an INSERT operation.'."\n"
+ .'* **UPDATE_ROWS**: indicates an UPDATE operation.'."\n"
+ .'* **DELETE_ROWS**: indicates a DELETE operation.'."\n"
+ .'* **EXT_WRITE_ROWS**: indicates an INSERT operation, which is equivalent to WRITE_ROWS.'."\n"
+ .'* **EXT_UPDATE_ROWS**: indicates an UPDATE operation, which is equivalent to UPDATE_ROWS.'."\n"
+ .'* **EXT_DELETE_ROWS**: indicates a DELETE operation, which is equivalent to DELETE_ROWS.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE_ROWS',
+ ],
+ 'EventId' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RollSQL' => [
+ 'description' => 'The SQL statements used to roll back the data change.'."\n",
+ 'type' => 'string',
+ 'example' => '-- Timestamp:2023-04-23 10:25:47 #1\\r\\nUPDATE `dc_test`.`tb_chunk_dml` SET `id`=1 , `gmt_create`=\'2021-09-30T00:00:00\' , `content`=\'2023-03-30 14:51:50\' , `c1`=\'2023-04-17 13:42:03\' , `c_id`=1 , `c13425`=\'b\\\\\'\' , `c432532535`= null , `c1432`= null , `c143243253`= null , `c1432535`= null , `c43125325`= null , `c3425325`= null WHERE (`id`=1)"',
+ ],
+ ],
+ ],
+ ],
+ 'TableInfoList' => [
+ 'description' => 'The metadata of tables for which you track data operations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The metadata of a table for which you track data operations.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'prod_eb_vas',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'import_table_test1',
+ ],
+ 'Columns' => [
+ 'description' => 'The information about columns.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about a column.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'basic_platform',
+ ],
+ 'ColumnPosition' => [
+ 'description' => 'The position of the column.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the column. Examples: BIGINT, INT, and VARCHAR.'."\n",
+ 'type' => 'string',
+ 'example' => 'BIGINT',
+ ],
+ 'Fictive' => [
+ 'description' => 'Indicates whether the column is a virtual column. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'Description' => [
+ 'description' => 'The description of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'auto-description',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"TrackResult\\": {\\n \\"TotalCount\\": 109,\\n \\"EventList\\": [\\n {\\n \\"DataAfter\\": [\\n \\"1\\"\\n ],\\n \\"DataBefore\\": [\\n \\"2\\"\\n ],\\n \\"EventLength\\": 4324,\\n \\"EventTimestamp\\": \\"2023-04-23 10:25:47\\",\\n \\"EventType\\": \\"UPDATE_ROWS\\",\\n \\"EventId\\": 1,\\n \\"RollSQL\\": \\"-- Timestamp:2023-04-23 10:25:47 #1\\\\\\\\r\\\\\\\\nUPDATE `dc_test`.`tb_chunk_dml` SET `id`=1 , `gmt_create`=\'2021-09-30T00:00:00\' , `content`=\'2023-03-30 14:51:50\' , `c1`=\'2023-04-17 13:42:03\' , `c_id`=1 , `c13425`=\'b\\\\\\\\\\\\\\\\\'\' , `c432532535`= null , `c1432`= null , `c143243253`= null , `c1432535`= null , `c43125325`= null , `c3425325`= null WHERE (`id`=1)\\\\\\"\\"\\n }\\n ],\\n \\"TableInfoList\\": [\\n {\\n \\"SchemaName\\": \\"prod_eb_vas\\",\\n \\"TableName\\": \\"import_table_test1\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"basic_platform\\",\\n \\"ColumnPosition\\": 1,\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"Fictive\\": true\\n }\\n ],\\n \\"Description\\": \\"auto-description\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'SearchDataTrackResult',
+ ],
+ 'DownloadDataTrackResult' => [
+ 'summary' => 'Downloads the parsing result of a data tracking task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to obtain the ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '406****',
+ ],
+ ],
+ [
+ 'name' => 'RollbackSQLType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the SQL statement.'."\n"
+ ."\n"
+ .'* **REVERSE**: undoes or rolls back an executed SQL statement, which is equivalent to the UNDO SQL statement.'."\n"
+ .'* **FORWARD**: redoes or re-executes an SQL statement that failed to be executed, which is equivalent to the REDO SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'REVERSE',
+ 'enum' => [
+ 'REVERSE',
+ 'FORWARD',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'FilterStartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The start time of the time range in which you want to track data operations. The time must be specified in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2023-04-23 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'FilterEndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end time of the time range in which you want to track data operations. The time must be specified in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2023-04-23 10:00:00',
+ ],
+ ],
+ [
+ 'name' => 'FilterTableList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The names of the tables for which you want to track data operations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of a table for which you want to track data operations.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table2',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'FilterTypeList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The types of data operations that you want to track.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A type of data operation that you want to track.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'UPDATE',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ColumnFilter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The condition to filter columns.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'account_name',
+ ],
+ 'Operator' => [
+ 'description' => 'The type of the operator used to configure the filter condition. Valid values:'."\n"
+ ."\n"
+ .'* **EQUAL**: retrieves the column whose value is equal to the specified value.'."\n"
+ .'* **NOT_EQUAL**: retrieves the column whose value is not equal to the specified value.'."\n"
+ .'* **IN**: retrieves the column whose value is in the IN list.'."\n"
+ .'* **BETWEEN**: retrieves the column whose value is in the specified range.'."\n"
+ .'* **LESS**: retrieves the column whose value is less than the specified value.'."\n"
+ .'* **MORE**: retrieves the column whose value is greater than the specified value.'."\n"
+ .'* **NOT_IN**: retrieves the column whose value is not in the IN list.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EQUAL',
+ 'enum' => [
+ 'EQUAL',
+ 'NOT_EQUAL',
+ 'IN',
+ 'BETWEEN',
+ 'LESS',
+ 'MORE',
+ 'NOT_IN',
+ ],
+ ],
+ 'Value' => [
+ 'description' => 'The value used in the filter condition.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'BetweenStart' => [
+ 'description' => 'The start value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'BetweenEnd' => [
+ 'description' => 'The end value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'InList' => [
+ 'description' => 'The IN list used in the filter condition.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'This parameter takes effect only when Operator is set to IN or NOT_IN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'EventIdList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the events.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The event ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DownloadKeyId' => [
+ 'description' => 'The ID of the download key, which is used to download the parsing result of the data tracking task.'."\n",
+ 'type' => 'string',
+ 'example' => 'e23dd7ec-a19f-4a69-8eb3-8ffd26e6****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DownloadKeyId\\": \\"e23dd7ec-a19f-4a69-8eb3-8ffd26e6****\\"\\n}","type":"json"}]',
+ 'title' => 'DownloadDataTrackResult',
+ ],
+ 'QueryDataTrackResultDownloadStatus' => [
+ 'summary' => 'Queries the download and parsing progress of data tracking logs.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the ticket. You can call the [ListOrders](~~144643~~) operation to query the ID of the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'DownloadKeyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the download key, which is used to identify the parsing progress of data tracking logs. You can call the DownloadDataTrackResult operation to query the ID of the key.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e23dd7ec-a19f-4a69-8eb3-8ffd26e6****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StatusResult' => [
+ 'description' => 'The information about the download progress.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DownloadStatus' => [
+ 'description' => 'The status of the download task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The download task is being initialized.'."\n"
+ .'* **LISTING**: The download task is in a transient intermediate state during the initialization.'."\n"
+ .'* **DOWNLOADING**: The download task is being processed.'."\n"
+ .'* **DOWNLOAD_SUCCESS**: The download task was successfully processed.'."\n"
+ .'* **DOWNLOAD_FAIL**: The download task failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'DOWNLOAD_SUCCESS',
+ ],
+ 'DownloadUrl' => [
+ 'description' => 'The URL that is used to download data tracking logs. This parameter is returned only when the value of DownloadStatus is DOWNLOAD_SUCCESS.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://idbsaasstore.oss-cn-zhangjiakou.aliyuncs.com/****_REDO_31201_207.zip?Expires=1682239593&OSSAccessKeyId=****&Signature=****'."\n",
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the state.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '69',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StatusResult\\": {\\n \\"DownloadStatus\\": \\"DOWNLOAD_SUCCESS\\",\\n \\"DownloadUrl\\": \\"https://idbsaasstore.oss-cn-zhangjiakou.aliyuncs.com/****_REDO_31201_207.zip?Expires=1682239593&OSSAccessKeyId=****&Signature=****\\\\n\\",\\n \\"StatusDesc\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 69\\n }\\n}","type":"json"}]',
+ 'title' => 'QueryDataTrackResultDownloadStatus',
+ ],
+ 'CreateUploadFileJob' => [
+ 'summary' => 'Creates a task to upload an attachment file.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileSource',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose of the attachment file. Valid values:'."\n"
+ ."\n"
+ .'* **datacorrect**: The file is uploaded to change data.'."\n"
+ .'* **order_info_attachment**: The file is uploaded as an attachment in a ticket.'."\n"
+ .'* **big-file**: The file is uploaded to import multiple data records at a time.'."\n"
+ .'* **sqlreview**: The file is uploaded for SQL review.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'datacorrect',
+ 'enum' => [
+ 'datacorrect',
+ 'order_info_attachment',
+ 'big-file',
+ 'sqlreview',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the attachment file.'."\n"
+ ."\n"
+ .'> The file name must end with .txt or .sql. For example, the file name can be test.txt or test.sql.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test.txt',
+ ],
+ ],
+ [
+ 'name' => 'UploadURL',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The URL of the attachment file. The URL must be an HTTP URL or an HTTPS URL.'."\n"
+ ."\n"
+ .'> You can upload the attachment file to an Object Storage Service (OSS) bucket and obtain the URL of the file in the OSS console. For more information, see [Share objects](~~195674~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'https://XXX.oss-cn-hangzhou.aliyuncs.com/test.txt',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E103C5F9-DE47-53F2-BF34-D71DF38F****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unsupported url scheme : null, scheme must be https or http',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'JobKey' => [
+ 'description' => 'The key of the task.'."\n"
+ ."\n"
+ .'> You can call the [GetUserUploadFileJob](~~206069~~) operation to query the progress and details of the task.'."\n",
+ 'type' => 'string',
+ 'example' => '761f18031635736380812****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E103C5F9-DE47-53F2-BF34-D71DF38F****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"Unsupported url scheme : null, scheme must be https or http\\",\\n \\"ErrorCode\\": \\"InvalidParameterValid\\",\\n \\"JobKey\\": \\"761f18031635736380812****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUploadFileJobResponse>\\n <JobKey>761f18031635736380812****</JobKey>\\n <RequestId>E103C5F9-DE47-53F2-BF34-D71DF38F****</RequestId>\\n <Success>true</Success>\\n</CreateUploadFileJobResponse>","errorExample":""}]',
+ 'title' => 'CreateUploadFileJob',
+ ],
+ 'CreateUploadOSSFileJob' => [
+ 'summary' => 'Creates a task to upload an Object Storage Service (OSS) file and obtain the key of the task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileSource',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The purpose of the file upload task. Valid values:'."\n"
+ ."\n"
+ .'* **datacorrect**: The file is uploaded to change data.'."\n"
+ .'* **order_info_attachment**: The file is uploaded as an attachment in a ticket.'."\n"
+ .'* **big-file**: The file is uploaded to import multiple data records at a time.'."\n"
+ .'* **sqlreview**: The file is uploaded for SQL review.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'datacorrect',
+ 'enum' => [
+ 'datacorrect',
+ 'order_info_attachment',
+ 'big-file',
+ 'sqlreview',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the file.'."\n"
+ ."\n"
+ .'> The file name must end with .txt or .sql. For example, the file name can be text.txt.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test.sql',
+ ],
+ ],
+ [
+ 'name' => 'UploadTarget',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the OSS file to be uploaded.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Endpoint' => [
+ 'description' => 'The endpoint of the OSS bucket.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'http://oss-cn-hangzhou.aliyuncs.com',
+ ],
+ 'BucketName' => [
+ 'description' => 'The name of the OSS bucket.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_bucket',
+ ],
+ 'ObjectName' => [
+ 'description' => 'The name of the OSS object.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test.sql',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'JobKey' => [
+ 'description' => 'The key of the file upload task. You can query the upload progress and task details. For more information, see [GetUserUploadFileJob](~~206069~~).'."\n",
+ 'type' => 'string',
+ 'example' => '65254a4c1614235217749100e',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"JobKey\\": \\"65254a4c1614235217749100e\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUploadOSSFileJobResponse>\\n <JobKey>7000005000007000009000000</JobKey>\\n <RequestId>44355324-9534-4AF4-B7AA-8EDE3C767889</RequestId>\\n <Success>true</Success>\\n</CreateUploadOSSFileJobResponse>","errorExample":""}]',
+ 'title' => 'CreateUploadOSSFileJob',
+ ],
+ 'GetUserUploadFileJob' => [
+ 'summary' => 'Obtains the information of a file upload task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The key of the file upload task. The key is returned when you call the [CreateUploadFileJob](~~206059~~) or [CreateUploadOSSFileJob](~~206060~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '65254a49100e',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => 'BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'UploadFileJobDetail' => [
+ 'description' => 'The details of the file upload task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobKey' => [
+ 'description' => 'The key of the file upload task.'."\n",
+ 'type' => 'string',
+ 'example' => '65254a4c1614235217749100e',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'test.sql',
+ ],
+ 'FileSize' => [
+ 'description' => 'The size of the file. Unit: byte.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2968269',
+ ],
+ 'FileSource' => [
+ 'description' => 'The purpose of the uploaded file. Valid values:'."\n"
+ ."\n"
+ .'* **datacorrect**: The file is uploaded to change data.'."\n"
+ .'* **order_info_attachment**: The file is uploaded as an attachment in a ticket.'."\n"
+ .'* **big-file**: The file is uploaded to import multiple data records at a time.'."\n"
+ .'* **sqlreview**: The file is uploaded for SQL review.'."\n",
+ 'type' => 'string',
+ 'example' => 'datacorrect',
+ ],
+ 'UploadType' => [
+ 'description' => 'The method used to upload the file. Valid values:'."\n"
+ ."\n"
+ .'* **URL**'."\n"
+ .'* **OSS**'."\n",
+ 'type' => 'string',
+ 'example' => 'URL',
+ ],
+ 'UploadURL' => [
+ 'description' => 'The URL of the file.'."\n"
+ ."\n"
+ .'> This parameter is returned if the value of **UploadType** is **URL**.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://xxxx/test.sql',
+ ],
+ 'UploadOSSParam' => [
+ 'description' => 'The information about the Object Storage Service (OSS) bucket from which the file is uploaded.'."\n"
+ ."\n"
+ .'> This parameter is returned if the value of **UploadType** is **OSS**.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Endpoint' => [
+ 'description' => 'The endpoint of the OSS bucket.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://oss-cn-hangzhou.aliyuncs.com',
+ ],
+ 'BucketName' => [
+ 'description' => 'The name of the OSS bucket.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_bucket',
+ ],
+ 'ObjectName' => [
+ 'description' => 'The name of the OSS object.'."\n",
+ 'type' => 'string',
+ 'example' => 'test.sql',
+ ],
+ ],
+ ],
+ 'UploadedSize' => [
+ 'description' => 'The size of the uploaded file. Unit: byte.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2968269',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The status of the file upload task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The file upload task was initialized.'."\n"
+ .'* **PENDING**: The file upload task waited to be run.'."\n"
+ .'* **BE_SCHEDULED**: The file upload task waited to be scheduled.'."\n"
+ .'* **FAIL**: The file upload task failed.'."\n"
+ .'* **SUCCESS**: The file upload task was successful.'."\n"
+ .'* **RUNNING**: The file upload task was being run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'JobStatusDesc' => [
+ 'description' => 'The information about the status of the file upload task.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'AttachmentKey' => [
+ 'description' => 'The key of the file that is returned after the file is uploaded. You can use this key when you upload the file as an attachment in a ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"UploadFileJobDetail\\": {\\n \\"JobKey\\": \\"65254a4c1614235217749100e\\",\\n \\"FileName\\": \\"test.sql\\",\\n \\"FileSize\\": 2968269,\\n \\"FileSource\\": \\"datacorrect\\",\\n \\"UploadType\\": \\"URL\\",\\n \\"UploadURL\\": \\"http://xxxx/test.sql\\",\\n \\"UploadOSSParam\\": {\\n \\"Endpoint\\": \\"http://oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BucketName\\": \\"test_bucket\\",\\n \\"ObjectName\\": \\"test.sql\\"\\n },\\n \\"UploadedSize\\": 2968269,\\n \\"JobStatus\\": \\"SUCCESS\\",\\n \\"JobStatusDesc\\": \\"success\\",\\n \\"AttachmentKey\\": \\"upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetUserUploadFileJobResponse>\\n <RequestId>22FFF57C-6E85-4C3D-90AF-C1BFE79E1FAF</RequestId>\\n <UploadFileJobDetail>\\n <JobStatus>INIT</JobStatus>\\n <JobKey>7000005000007000009000000</JobKey>\\n <UploadURL>https://dbxxx.oss-cn-hangzhou.aliyuncs.com/dm/1.txt</UploadURL>\\n <UploadedSize>0</UploadedSize>\\n <JobStatusDesc/>\\n <FileSource>datacorrect</FileSource>\\n <FileName>1.txt</FileName>\\n <UploadType>URL</UploadType>\\n <FileSize>-1</FileSize>\\n </UploadFileJobDetail>\\n <Success>true</Success>\\n</GetUserUploadFileJobResponse>","errorExample":""}]',
+ 'title' => 'GetUserUploadFileJob',
+ ],
+ 'CreateDataArchiveOrder' => [
+ 'summary' => 'Creates a data archiving ticket to archive data to destinations such as dedicated storage space or ApsaraDB RDS for MySQL instances.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '185526',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsPWN318',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '任务描述信息',
+ 'description' => 'The description of the task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'PluginType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '插件类型信息，默认为DATA_ARCHIVE，非必填',
+ 'description' => 'The type of the plug-in. Default value: DATA_ARCHIVE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DATA_ARCHIVE',
+ 'default' => 'DATA_ARCHIVE',
+ ],
+ ],
+ [
+ 'name' => 'RelatedUserList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '相关用户列表，非必填',
+ 'description' => 'The list of the related users.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of an operator that is related to the ticket.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123***',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ParentId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '父工单ID，非必填，由父工单创建子工单时才需填写',
+ 'description' => 'The ID of the parent ticket. A parent ticket is generated only when a child ticket is created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123****',
+ ],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '归档参数',
+ 'description' => 'The parameters for archiving data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ArchiveMethod' => [
+ 'title' => '目标端（除了内置存储方式，其他均需先在DMS控制台为已登录状态）'."\n"
+ .'inner_oss：专属存储'."\n"
+ .'oss_userself：用户OSS '."\n"
+ .'mysql：RDS MySQL'."\n"
+ .'polardb：polardb mysql'."\n"
+ .'adb_mysql：adb MySQL'."\n"
+ .'lindorm：lindorm',
+ 'description' => 'The archiving destination to which you want to archive data. Valid values:'."\n"
+ ."\n"
+ .'> If you set ArchiveMethod to a value other than inner_oss, you must register the corresponding destination database with Data Management (DMS) before you create the data archiving ticket. After the database is registered with DMS, the database is displayed in the Instances Connected section of the DMS console.'."\n"
+ ."\n"
+ .'* **inner_oss**: dedicated storage, which is a built-in Object Storage Service (OSS) bucket.'."\n"
+ .'* **oss_userself**: OSS bucket of the user.'."\n"
+ .'* **mysql**: ApsaraDB RDS for MySQL instance.'."\n"
+ .'* **polardb**: PolarDB for MySQL cluster.'."\n"
+ .'* **adb_mysql**: AnalyticDB for MySQL V3.0 cluster.'."\n"
+ .'* **lindorm**: Lindorm instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'mysql',
+ ],
+ 'RunMethod' => [
+ 'title' => '归档方式：'."\n"
+ .'周期调度 “schedule”'."\n"
+ .'立即执行 “now”',
+ 'description' => 'The method that is used to run the data archiving task. Valid values:'."\n"
+ ."\n"
+ .'* **schedule**: The data archiving task is periodically scheduled.'."\n"
+ .'* **now**: The data archiving task is immediately run.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'now',
+ ],
+ 'Variables' => [
+ 'title' => '变量：对应归档变量配置，用于用户使用自定义时间变量来作为归档过滤条件。每一个有两个属性：1. name 2. pattern',
+ 'description' => 'The configuration of archiving variables. You can use a time variable as a filter condition for archiving data. Each variable has two attributes: name and pattern.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The configuration of archiving variables.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'title' => '时间变量名，若用于归档过滤条件，需与“过滤条件”中的变量名称一致。',
+ 'description' => 'The name of the time variable. If the time variable is used as a filter condition for archiving data, the variable name must be the same as the one that is specified in **TableWhere**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 't',
+ ],
+ 'Pattern' => [
+ 'title' => '变量模式：用于定义时间变量的值。'."\n"
+ .'形式及含义如下（可详见说明文档https://help.aliyun.com/document_detail/209323.html?spm=a2ccf.orders.0.0.369b250eb7TCic）：'."\n"
+ .'yyyy-MM-dd|-3d：业务运行时间的前3天'."\n"
+ .'yyyy-MM-dd|-1w：业务运行时间的前1周'."\n"
+ .'yyyy-MM-dd|-4M：业务运行时间的前4个月'."\n"
+ .'yyyy-MM-dd|-2y：业务运行时间的前2年'."\n"
+ .'yyyy-MM-dd|-3h：业务运行时间的前3小时'."\n"
+ .'yyyy-MM-dd|+5m：业务运行时间后5分钟'."\n"
+ .'其中前半部分”yyyy-MM-dd|“为固定值，后半部分中-表示业务时间前，+表示业务时间后'."\n",
+ 'description' => 'The format of the time variable. The format is used to define the value of the time variable. For more information, see [Configure variables](~~209323~~). The following examples show the formats of a time variable:'."\n"
+ ."\n"
+ .'* **yyyy-MM-dd|-3d**: three days before the point in time when the task is run.'."\n"
+ .'* **yyyy-MM-dd|-1w**: seven days before the point in time when the task is run.'."\n"
+ .'* **yyyy-MM-dd|-4M**: four months before the point in time when the task is run.'."\n"
+ .'* **yyyy-MM-dd|-2y**: two years before the point in time when the task is run.'."\n"
+ .'* **yyyy-MM-dd|-3h**: 3 hours before the point in time when the task is run.'."\n"
+ .'* **yyyy-MM-dd|+5m**: 5 minutes after the point in time when the task is run.'."\n"
+ ."\n"
+ .'> In these examples, yyyy-MM-dd| indicates a fixed value. For the remaining part, a hyphen (-) indicates that the time is before that when the task is run, and a plus sign (+) indicates that the time is after that when the task is run.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'yyyy-MM-dd|-3d',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '{name: "time", pattern: "yyyy-MM-dd|+2d"}',
+ ],
+ 'required' => false,
+ ],
+ 'Logic' => [
+ 'title' => '是否为逻辑库，默认为false。',
+ 'description' => 'Specifies whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ 'TableIncludes' => [
+ 'title' => '需要归档的表的集合',
+ 'description' => 'The collection of tables to be archived.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'title' => '表名',
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table1',
+ ],
+ 'TableWhere' => [
+ 'title' => '归档的where筛选条件，如：'."\n"
+ .'id<10；'."\n"
+ .'若使用时间变量过滤，写法如：字段名<=\'${变量名}\'，变量名与API variables中对应的name一致。',
+ 'description' => 'The filter condition that is specified by the WHERE clause of the archiving configuration. If a time variable is used in the filter condition, the filter condition is specified in the following format: field name <=\'${variable name}\'. The variable name in the filter condition must be the same as the time variable name that is specified in the Variables parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'gmt_modified<\'${time}\'',
+ ],
+ ],
+ 'required' => true,
+ ],
+ 'required' => true,
+ ],
+ 'TableMapping' => [
+ 'title' => '归档目标端的表名，api调用无需填写，采用默认值',
+ 'description' => 'The table names mapped to the destination database. This parameter is not required and the default value is used.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table name mapped to the destination database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table1',
+ ],
+ 'required' => false,
+ ],
+ 'OrderAfter' => [
+ 'title' => '后置行为：'."\n"
+ .'清理源库：“delete”'."\n"
+ .'数据校验：“check”',
+ 'description' => 'The post behaviors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The post behavior. Valid values:'."\n"
+ ."\n"
+ .'* **delete**: deletes the archived data from the source database.'."\n"
+ .'* **check**: verifies the archived data. This operation is time-consuming.'."\n"
+ .'* **clear**: deletes the temporary table. This value takes effect only when you select the other two values for this parameter at the same time.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '"delete"',
+ ],
+ 'required' => false,
+ ],
+ 'SourceCatalogName' => [
+ 'title' => '源库catalog，'."\n"
+ .'对于两层逻辑结构的数据库，如MySQL，polardb mysql，adb mysql，可不填，'."\n"
+ .'对于lindorm与mongo，填入空字符串，'."\n"
+ .'对于三层逻辑结构的数据库，如postgresql，填入catalog名',
+ 'description' => 'The catalog of the source database. Valid values:'."\n"
+ ."\n"
+ .'* **def**: Set this parameter to def if the source database is of the two-layer logical schema, such as a MySQL database, a PolarDB for MySQL cluster, or an AnalyticDB for MySQL instance.'."\n"
+ .'* **Empty string**: Set this parameter to an empty string if the source database is a Lindorm or ApsaraDB for MongoDB instance.'."\n"
+ .'* **Catalog name**: Set this parameter to the catalog name of the source database if the source database is of the three-layer logical schema, such as a PostgreSQL database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'def',
+ 'default' => 'def',
+ ],
+ 'SourceSchemaName' => [
+ 'title' => '源库schema，源库与目标库同名。'."\n"
+ .'如MySQL为库名，postgresql为schema名。',
+ 'description' => 'The schema name of the source database. The schema name of the source database is the same as that of the destination database. If the source database is a MySQL database, this parameter specifies the name of the source database. If the source database is a PostgreSQL database, this parameter specifies the schema name of the source database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'schema_test',
+ ],
+ 'SourceInstanceName' => [
+ 'title' => '源库实例名，可在控制台查看。',
+ 'description' => 'The name of the source instance. If the database instance is a self-managed database or a third-party cloud database, you can call the [GetInstance](~~465826~~) operation to query the instance ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'pc-bp1*******',
+ ],
+ 'TargetInstanceHost' => [
+ 'title' => '目标库host，若目标实例同时开放了内网与公网，优先写入内网host。',
+ 'description' => 'The host of the destination instance. If the destination instance can be accessed over an internal network or the Internet, preferentially set the value to the internal endpoint of the destination instance.'."\n"
+ ."\n"
+ .'* If data is archived in an OSS bucket, set the value to the name of the bucket.'."\n"
+ .'* If data is archived in dedicated storage space, set the value to inner_oss.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'am-bp1*********.ads.aliyuncs.com',
+ ],
+ 'CronStr' => [
+ 'title' => '当归档类型为周期归档时必填。填写Crontab表达式，以便定期执行任务，更多信息，请参见https://help.aliyun.com/zh/dms/create-shadow-tables-for-synchronization',
+ 'description' => 'A crontab expression that specifies the scheduling cycle of the data archiving task. For more information, see the [Crontab expressions](~~206581~~) section of the "Create shadow tables for synchronization" topic. You must specify this parameter if you set RunMethod to schedule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00 05 11 * * ?',
+ ],
+ 'DatabaseId' => [
+ 'description' => 'The database ID. If the database is a self-managed database or a third-party cloud database, you can call the [GetDatabase](~~465856~~) operation to query the database ID. If the database is an Alibaba Cloud database, ignore this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1***',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request, which is used to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreateOrderResult' => [
+ 'description' => 'The ID of the data archiving ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data archiving ticket ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12*****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"CreateOrderResult\\": [\\n 0\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateDataArchiveOrderResponse>\\n <RequestId>283C461F-11D8-48AA-B695-DF092DA32AF3</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <ErrorCode>UnknownError</ErrorCode>\\n</CreateDataArchiveOrderResponse>","errorExample":""}]',
+ 'title' => 'CreateDataArchiveOrder',
+ 'description' => 'You can call this API operation only for database instances that are managed in Security Collaboration mode.'."\n",
+ ],
+ 'GetDataArchiveOrderDetail' => [
+ 'summary' => 'Queries the details of a data archiving ticket, including the time when the ticket was created, the scheduling information of the data archiving task, the logs of the data archiving task, and the database to which data is archived.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of data archiving tickets.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '868****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '5***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TraceId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Tracks service requests.'."\n",
+ 'type' => 'string',
+ 'example' => '0a06e1e316757357507896067d3780',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'User [19929582****] not exist',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the call failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'NoPermission',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request, which is used to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4161CE36-28DF-5191-8A6F-A17076A0B124',
+ ],
+ 'DataArchiveOrderDetail' => [
+ 'description' => 'The details of data archiving tickets.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Comment' => [
+ 'description' => 'The description of the data archiving tickets.'."\n",
+ 'type' => 'string',
+ 'example' => 'Archiving of test results',
+ ],
+ 'Committer' => [
+ 'description' => 'The user who submitted the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest',
+ ],
+ 'CommitterId' => [
+ 'description' => 'The ID of the user who submitted the ticket. The ID is a user ID and not the ID of an Alibaba Cloud account.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '26***',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the ticket was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-15 16:00:48',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the ticket was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-23 16:00:48',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of data archiving tickets.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '868****',
+ ],
+ 'PluginExtraData' => [
+ 'description' => 'The additional information about the ticket.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DagInfo' => [
+ 'description' => 'The information about the workflow.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '59****',
+ ],
+ 'CronBeginDate' => [
+ 'description' => 'The start time for scheduling. The task flow is not scheduled before this point in time.'."\n",
+ 'type' => 'string',
+ 'example' => '1970-01-01',
+ ],
+ 'CronEndDate' => [
+ 'description' => 'The end time for scheduling. The task flow is not scheduled after this point in time.'."\n",
+ 'type' => 'string',
+ 'example' => '9999-01-01',
+ ],
+ 'CronTrigger' => [
+ 'description' => 'Indicates whether the archiving task is a scheduled task. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DWDevelop' => [
+ 'description' => 'Indicates whether the task is used to develop warehouses.'."\n"
+ ."\n"
+ .'> This field is a retained field that is not in use.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DagName' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'data-archive-9099197',
+ ],
+ 'DagOwnerId' => [
+ 'description' => 'The ID of the owner of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => '13****',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the deployment record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '93***',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'order id:9099197',
+ ],
+ 'EditDagId' => [
+ 'description' => 'The ID of the editable workflow version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the workflow was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-15 16:00:48',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the workflow was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-06-15 16:00:48',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'IsPublic' => [
+ 'description' => 'Indicates whether the workflow is public. Valid values:'."\n"
+ ."\n"
+ .'* **0**: not public.'."\n"
+ .'* **1**: public.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'Legacy' => [
+ 'description' => 'Indicates whether the task is a historical task. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'System' => [
+ 'description' => 'Indicates whether the task was created by the system. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'string',
+ 'example' => '5***',
+ ],
+ 'TriggerOnce' => [
+ 'description' => 'Indicates whether the workflow is triggered to run once. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'DbBaseInfo' => [
+ 'description' => 'The database information related to data archiving tickets.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Alias' => [
+ 'description' => 'The alias of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'tf-testAccDMSEnterpriseLogicDatabase853****',
+ ],
+ 'AlterTimeout' => [
+ 'description' => 'The timeout period of queries on the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '600',
+ ],
+ 'AssetControl' => [
+ 'description' => 'Indicates whether access control is enabled for data assets. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'CatalogName' => [
+ 'description' => 'The name of the instance in the instance list.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ClusterNode' => [
+ 'description' => 'Indicates whether the instance is added to the DMS whitelist.'."\n",
+ 'type' => 'string',
+ 'example' => 'whitelist_done',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabase](~~141876~~) operation to query the ID of the database.'."\n"
+ ."\n"
+ .'> You can call the [ListDatabases](~~141873~~) operation to query the ID of a physical database or the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '348****',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'DbaId' => [
+ 'description' => 'The ID of the database administrator (DBA) of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '16****',
+ ],
+ 'DbaName' => [
+ 'description' => 'The nickname of the DBA of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'DBA',
+ ],
+ 'Description' => [
+ 'description' => 'The complete endpoint of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]',
+ ],
+ 'Encoding' => [
+ 'description' => 'The encoding format of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'utf8',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment'."\n"
+ .'* **dev**: development environment'."\n"
+ .'* **pre**: staging environment'."\n"
+ .'* **test**: test environment'."\n"
+ .'* **sit**: system integration testing (SIT) environment'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment'."\n"
+ .'* **pet**: stress testing environment'."\n"
+ .'* **stag**: STAG environment'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'Follow' => [
+ 'description' => 'Indicates whether the instance needs special attention. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint that is used to connect to the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-2ze756u8837****.mysql.rds.aliyuncs.com',
+ ],
+ 'Idc' => [
+ 'description' => 'The region in which the database instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-beijing',
+ ],
+ 'IdcTitle' => [
+ 'description' => 'The name of the region in which the database instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-beijing',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance to which the database belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '175****',
+ ],
+ 'InstanceSource' => [
+ 'description' => 'The source of the database instance.Valid values:'."\n"
+ ."\n"
+ .'* **RDS**: an ApsaraDB RDS instance.'."\n"
+ .'* **ECS_OWN**: a self-managed database deployed on an Elastic Compute Service (ECS) instance.'."\n"
+ .'* **PUBLIC_OWN**: a self-managed database instance that is connected over the Internet.'."\n"
+ .'* **VPC_ID**: a self-managed database instance in a virtual private cloud (VPC) that is connected over Express Connect circuits.'."\n"
+ .'* **GATEWAY**: a database instance connected by using a database gateway.'."\n",
+ 'type' => 'string',
+ 'example' => 'RDS',
+ ],
+ 'LastSyncTime' => [
+ 'description' => 'The time when the database information was last obtained.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-14 18:34:45',
+ ],
+ 'Level' => [
+ 'description' => 'The instance level.'."\n",
+ 'type' => 'string',
+ 'example' => 'medium',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is logical. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'OwnerIds' => [
+ 'description' => 'The IDs of the owners of the databases, which are stored as an array. You can call the [GetUser](~~147098~~) or [ListUsers](~~141938~~) operation to query the IDs of the owners.'."\n"
+ ."\n"
+ .'> The value of OwnerIds is the same as the value of UserId'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the owner of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '77****',
+ ],
+ ],
+ 'OwnerNames' => [
+ 'description' => 'The usernames of the database owners.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The username of the database owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'day',
+ ],
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3306',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]',
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The details of the control mode of the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbType' => [
+ 'description' => 'The type of the instance engine. For information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'adb_mysql default',
+ ],
+ 'FreeOrStable' => [
+ 'description' => 'Indicates whether the instance is managed in Flexible Management or Stable Change mode. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the security rule was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-05-24 14:12:32',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the security rule was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-05-25 14:12:32',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The type of the control mode of the instance. Valid values:'."\n"
+ ."\n"
+ .'* **COMMON**: The instance is managed in Security Collaboration mode.'."\n"
+ .'* **NONE_CONTROL**: The instance is managed in Flexible Management mode.'."\n"
+ .'* **STABLE**: The instance is managed in Stable Change mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ 'GroupName' => [
+ 'description' => 'The name of the security rule that corresponds to the control mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'adb_mysql default',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the security rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'LastMenderId' => [
+ 'description' => 'The user ID of the last modified security rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'State' => [
+ 'description' => 'The status of the database. Valid values:'."\n"
+ ."\n"
+ .'* **NORMAL**: The database is running as expected.'."\n"
+ .'* **DISABLE**: The database is disabled.'."\n"
+ .'* **OFFLINE**: The database is unpublished.'."\n"
+ .'* **NOT_EXIST**: The database does not exist.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'TableCount' => [
+ 'description' => 'The number of tables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '201',
+ ],
+ 'TnsName' => [
+ 'description' => 'The name of TNS.'."\n",
+ 'type' => 'string',
+ 'example' => 'TNS_4010',
+ ],
+ 'UnitType' => [
+ 'description' => 'The unit type.'."\n",
+ 'type' => 'string',
+ 'example' => '-1',
+ ],
+ ],
+ ],
+ 'InstanceTotal' => [
+ 'description' => 'The total number of archiving tasks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'Instances' => [
+ 'description' => 'The list of archiving tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BusinessTime' => [
+ 'description' => 'The business time of the task flow. The time is displayed in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-14 16:00:57',
+ ],
+ 'DagId' => [
+ 'description' => 'The task flow ID. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '37***',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the task flow ended. The time is displayed in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-06-04 15:14:00',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the task flow was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-14 16:00:57',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the task flow was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-14 16:00:57',
+ ],
+ 'HistoryDagId' => [
+ 'description' => 'The ID of the historical task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '32***',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the instance in the task flow that is executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'LastRunningContext' => [
+ 'description' => 'The context of the previous execution of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "nodes": ['."\n"
+ .' 48**'."\n"
+ .' ],'."\n"
+ .' "edges": {}'."\n"
+ .'}',
+ ],
+ 'Msg' => [
+ 'description' => 'The context of the current execution of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task is waiting for execution.'."\n"
+ .'* **1**: The task is in progress.'."\n"
+ .'* **2**: The task is suspended.'."\n"
+ .'* **3**: The task failed.'."\n"
+ .'* **4**: The task is successful.'."\n"
+ .'* **5**: The task is complete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'string',
+ 'example' => '5***',
+ ],
+ 'TriggerType' => [
+ 'description' => 'The mode in which the task flow was triggered. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow was triggered based on a schedule.'."\n"
+ .'* **1**: The task flow was manually triggered.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'Version' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'NextFireTimeResult' => [
+ 'description' => 'The time when the next task is triggered.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CronFireType' => [
+ 'description' => 'The type of scheduled triggering.'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_SET',
+ ],
+ ],
+ ],
+ 'PageIndex' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'TempTableNameMap' => [
+ 'description' => 'The name of the temporary table that is generated by the archiving task (indicated by the archiving task ID).'."\n",
+ 'type' => 'object',
+ 'example' => '{'."\n"
+ .' "803***": ['."\n"
+ .' "tmp_dms_21321_20230704144336_temp_test_check"'."\n"
+ .' ]'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'PluginParam' => [
+ 'description' => 'The ticket creation parameter. The value is a JSON string. For more information, see [PluginType parameter](~~429109~~).'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ArchiveMethod' => [
+ 'description' => 'The type of the archiving destination.'."\n",
+ 'type' => 'string',
+ 'example' => 'inner_oss',
+ ],
+ 'DbSchema' => [
+ 'description' => 'The schema of the database and table to be archived.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is logical.'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'OrderAfter' => [
+ 'description' => 'The post behavior of archiving.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The post behavior of archiving. The post behavior is to use the DELETE statement to clean up the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'delete',
+ ],
+ ],
+ 'RunMethod' => [
+ 'description' => 'The running method, which indicates whether to run the task immediately or at a specific point in time.'."\n",
+ 'type' => 'string',
+ 'example' => 'now',
+ ],
+ 'SourceDatabaseId' => [
+ 'description' => 'The ID of the source database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'TableIncludes' => [
+ 'description' => 'The list of the archived tables and the filter conditions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'example' => 'tm_insured_cb',
+ ],
+ 'TableWhere' => [
+ 'description' => 'The filter condition.'."\n",
+ 'type' => 'string',
+ 'example' => 'id<1000 or gmt_create<\'2023-05-14 16:00:57\'',
+ ],
+ ],
+ ],
+ ],
+ 'TableMapping' => [
+ 'description' => 'The mapping of schemas.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The mapping of the source table name, source column name, destination table name, and destination column name.'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "schema": "oracle_info",'."\n"
+ .' "tarTb": "eoa_context_test",'."\n"
+ .' "tbPartKey": [],'."\n"
+ .' "oriTb": "eoa_context",'."\n"
+ .' "columns": ['."\n"
+ .' {'."\n"
+ .' "tName": "dbid_test",'."\n"
+ .' "oName": "dbid"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "dbPartKey": [],'."\n"
+ .' "customPk": ['."\n"
+ .' "id"'."\n"
+ .' ]'."\n"
+ .' }',
+ ],
+ ],
+ 'TargetInstanceId' => [
+ 'description' => 'The ID of the destination instance.'."\n",
+ 'type' => 'string',
+ 'example' => '12***',
+ ],
+ 'Variables' => [
+ 'description' => 'The time variable defined for scheduled archiving.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The time variable that calculates an offset based on the previous day of the current time.'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "name": "test",'."\n"
+ .' "pattern": "yyyy-MM-dd|-10d"'."\n"
+ .' }',
+ ],
+ ],
+ ],
+ ],
+ 'PluginType' => [
+ 'description' => 'The plug-in type that corresponds to the type of the ticket. The plug-in type for data archiving is DATA_ARCHIVE. For more information, see [PluginType parameter](~~429109~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'DATA_ARCHIVE',
+ ],
+ 'RelatedUserList' => [
+ 'description' => 'The user IDs related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user IDs related to the ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '65****',
+ ],
+ ],
+ 'RelatedUserNickList' => [
+ 'description' => 'The nicknames of the users that are related to the ticket.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The nickname of the user that is related to the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'publicyuhzou',
+ ],
+ ],
+ 'StatusCode' => [
+ 'description' => 'The status code of the ticket. Valid values:'."\n"
+ ."\n"
+ .'* **new**: newly created.'."\n"
+ .'* **toaudit**: being reviewed.'."\n"
+ .'* **Approved**: approved.'."\n"
+ .'* **reject**: rejected.'."\n"
+ .'* **processing**: being executed.'."\n"
+ .'* **Success**: successful.'."\n"
+ .'* **closed**: disabled.'."\n",
+ 'type' => 'string',
+ 'example' => 'processing',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The status description of the ticket.'."\n",
+ 'type' => 'string',
+ 'example' => 'a ticket task is being executed.',
+ ],
+ 'WorkflowInstanceId' => [
+ 'description' => 'The ID of the approval process. You can call the [GetOrderBaseInfo](~~144642~~) operation to obtain the ID of the approval process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '29****',
+ ],
+ 'WorkflowStatusDesc' => [
+ 'description' => 'The description of the approval process.'."\n",
+ 'type' => 'string',
+ 'example' => 'approved',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TraceId\\": \\"0a06e1e316757357507896067d3780\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"User [199295823****] not exist\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"RequestId\\": \\"4161CE36-28DF-5191-8A6F-A17076A0B124\\",\\n \\"DataArchiveOrderDetail\\": {\\n \\"Comment\\": \\"Archiving of test results\\",\\n \\"Committer\\": \\"dmstest\\",\\n \\"CommitterId\\": 0,\\n \\"GmtCreate\\": \\"2023-05-15 16:00:48\\",\\n \\"GmtModified\\": \\"2023-05-23 16:00:48\\",\\n \\"Id\\": 0,\\n \\"PluginExtraData\\": {\\n \\"DagInfo\\": {\\n \\"CreatorId\\": \\"59****\\",\\n \\"CronBeginDate\\": \\"1970-01-01\\",\\n \\"CronEndDate\\": \\"9999-01-01\\",\\n \\"CronTrigger\\": false,\\n \\"DWDevelop\\": false,\\n \\"DagName\\": \\"data-archive-9099197\\",\\n \\"DagOwnerId\\": \\"13****\\",\\n \\"DeployId\\": 0,\\n \\"Description\\": \\"order id:9099197\\",\\n \\"EditDagId\\": 0,\\n \\"GmtCreate\\": \\"2023-05-15 16:00:48\\",\\n \\"GmtModified\\": \\"2023-06-15 16:00:48\\",\\n \\"Id\\": 0,\\n \\"IsPublic\\": 0,\\n \\"Legacy\\": false,\\n \\"System\\": false,\\n \\"TenantId\\": \\"5***\\",\\n \\"TriggerOnce\\": false\\n },\\n \\"DbBaseInfo\\": {\\n \\"Alias\\": \\"tf-testAccDMSEnterpriseLogicDatabase853****\\",\\n \\"AlterTimeout\\": 600,\\n \\"AssetControl\\": true,\\n \\"CatalogName\\": \\"test\\",\\n \\"ClusterNode\\": \\"whitelist_done\\",\\n \\"DbId\\": 0,\\n \\"DbType\\": \\"MySQL\\",\\n \\"DbaId\\": 0,\\n \\"DbaName\\": \\"DBA\\",\\n \\"Description\\": \\"test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]\\",\\n \\"Encoding\\": \\"utf8\\",\\n \\"EnvType\\": \\"product\\",\\n \\"Follow\\": false,\\n \\"Host\\": \\"rm-2ze756u8837****.mysql.rds.aliyuncs.com\\",\\n \\"Idc\\": \\"cn-beijing\\",\\n \\"IdcTitle\\": \\"cn-beijing\\",\\n \\"InstanceId\\": 0,\\n \\"InstanceSource\\": \\"RDS\\",\\n \\"LastSyncTime\\": \\"2023-05-14 18:34:45\\",\\n \\"Level\\": \\"中\\",\\n \\"Logic\\": false,\\n \\"OwnerIds\\": [\\n 0\\n ],\\n \\"OwnerNames\\": [\\n \\"天天\\"\\n ],\\n \\"Port\\": 3306,\\n \\"SchemaName\\": \\"test\\",\\n \\"SearchName\\": \\"test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]\\",\\n \\"StandardGroup\\": {\\n \\"DbType\\": \\"MySQL\\",\\n \\"Description\\": \\"adb_mysql default\\",\\n \\"FreeOrStable\\": false,\\n \\"GmtCreate\\": \\"2020-05-24 14:12:32\\",\\n \\"GmtModified\\": \\"2020-05-25 14:12:32\\",\\n \\"GroupMode\\": \\"COMMON\\",\\n \\"GroupName\\": \\"adb_mysql default\\",\\n \\"Id\\": 0,\\n \\"LastMenderId\\": 0\\n },\\n \\"State\\": \\"NORMAL\\",\\n \\"TableCount\\": 201,\\n \\"TnsName\\": \\"TNS_4010\\",\\n \\"UnitType\\": \\"-1\\"\\n },\\n \\"InstanceTotal\\": 2,\\n \\"Instances\\": [\\n {\\n \\"BusinessTime\\": \\"2023-05-14 16:00:57\\",\\n \\"DagId\\": 0,\\n \\"EndTime\\": \\"2022-06-04 15:14:00\\",\\n \\"GmtCreate\\": \\"2023-05-14 16:00:57\\",\\n \\"GmtModified\\": \\"2023-05-14 16:00:57\\",\\n \\"HistoryDagId\\": 0,\\n \\"Id\\": 0,\\n \\"LastRunningContext\\": \\"{\\\\n \\\\\\"nodes\\\\\\": [\\\\n 48**\\\\n ],\\\\n \\\\\\"edges\\\\\\": {}\\\\n}\\",\\n \\"Msg\\": \\"归档任务日志：2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\\\\\\\\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023\\",\\n \\"Status\\": 4,\\n \\"TenantId\\": \\"5***\\",\\n \\"TriggerType\\": 1,\\n \\"Version\\": \\"1\\"\\n }\\n ],\\n \\"NextFireTimeResult\\": {\\n \\"CronFireType\\": \\"NOT_SET\\"\\n },\\n \\"PageIndex\\": 10,\\n \\"PageSize\\": 20,\\n \\"TempTableNameMap\\": {\\n \\"803***\\": [\\n \\"tmp_dms_21321_20230704144336_temp_test_check\\"\\n ]\\n }\\n },\\n \\"PluginParam\\": {\\n \\"ArchiveMethod\\": \\"inner_oss\\",\\n \\"DbSchema\\": \\"test\\",\\n \\"Logic\\": true,\\n \\"OrderAfter\\": [\\n \\"delete\\"\\n ],\\n \\"RunMethod\\": \\"now\\",\\n \\"SourceDatabaseId\\": 0,\\n \\"TableIncludes\\": [\\n {\\n \\"TableName\\": \\"tm_insured_cb\\",\\n \\"TableWhere\\": \\"id<1000或者gmt_create<\'2023-05-14 16:00:57\'\\"\\n }\\n ],\\n \\"TableMapping\\": [\\n \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"oracle_info\\\\\\",\\\\n \\\\\\"tarTb\\\\\\": \\\\\\"eoa_context_test\\\\\\",\\\\n \\\\\\"tbPartKey\\\\\\": [],\\\\n \\\\\\"oriTb\\\\\\": \\\\\\"eoa_context\\\\\\",\\\\n \\\\\\"columns\\\\\\": [\\\\n {\\\\n \\\\\\"tName\\\\\\": \\\\\\"dbid_test\\\\\\",\\\\n \\\\\\"oName\\\\\\": \\\\\\"dbid\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"dbPartKey\\\\\\": [],\\\\n \\\\\\"customPk\\\\\\": [\\\\n \\\\\\"id\\\\\\"\\\\n ]\\\\n }\\"\\n ],\\n \\"TargetInstanceId\\": \\"12***\\",\\n \\"Variables\\": [\\n \\"{\\\\n \\\\\\"name\\\\\\": \\\\\\"test\\\\\\",\\\\n \\\\\\"pattern\\\\\\": \\\\\\"yyyy-MM-dd|-10d\\\\\\"\\\\n }\\"\\n ]\\n },\\n \\"PluginType\\": \\"DATA_ARCHIVE\\",\\n \\"RelatedUserList\\": [\\n 0\\n ],\\n \\"RelatedUserNickList\\": [\\n \\"publicyuhzou\\"\\n ],\\n \\"StatusCode\\": \\"processing\\",\\n \\"StatusDesc\\": \\"正在执行工单任务。\\",\\n \\"WorkflowInstanceId\\": 0,\\n \\"WorkflowStatusDesc\\": \\"审批通过\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataArchiveOrderDetail',
+ ],
+ 'GetDataArchiveCount' => [
+ 'summary' => 'Queries the statistics on the number of data archiving tickets, including the number of tickets of successful data archiving, failed data archiving,and in-progress data archiving, and the total number of data archiving tickets.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PluginType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The plugin type. Default value: DATA_ARCHIVE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DATA_ARCHIVE',
+ 'default' => 'DATA_ARCHIVE',
+ ],
+ ],
+ [
+ 'name' => 'OrderResultType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the identity. Default value: AS_ADMIN.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AS_ADMIN',
+ 'default' => 'AS_ADMIN',
+ ],
+ ],
+ [
+ 'name' => 'SearchDateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time when the ticket is modified or created. The statistics of data archiving tickets are calculated based on the creation time.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CREATE_TIME',
+ 'default' => 'CREATE_TIME',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '2****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FailCount' => [
+ 'title' => '失败的归档任务数目',
+ 'description' => 'The number of tickets that data archiving failed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1**',
+ ],
+ 'ProcessingCount' => [
+ 'title' => '正在进行中的归档任务数目',
+ 'description' => 'The number of tickets that data archiving is in progress.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2**',
+ ],
+ 'SuccessCount' => [
+ 'title' => '成功的归档任务数目',
+ 'description' => 'The number of tickets that data archiving is successful.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3**',
+ ],
+ 'TotalCount' => [
+ 'title' => '所有状态的归档任务数目',
+ 'description' => 'The total number of data archiving tickets.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6**',
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"FailCount\\": 12,\\n \\"ProcessingCount\\": 180,\\n \\"SuccessCount\\": 900,\\n \\"TotalCount\\": 1400\\n },\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2\\"\\n}","type":"json"}]',
+ 'title' => 'GetDataArchiveCount',
+ ],
+ 'GetPagedInstance' => [
+ 'summary' => 'Queries the task information about a ticket.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of data archiving ticket.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '868*****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TraceId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The trace ID, which is used to track the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0a06e1e316757357507896067d3780',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'PageIndex' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'Total' => [
+ 'description' => 'The total number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Instance' => [
+ 'description' => 'The information about the task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BusinessTime' => [
+ 'description' => 'The data timestamp of the task node.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-05-14 16:00:57',
+ ],
+ 'CheckStatus' => [
+ 'description' => 'The state of archived data verification. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The verification was successful.'."\n"
+ .'* **1**: Inconsistent data was detected.'."\n"
+ .'* **2**: The verification was not performed.'."\n"
+ .'* **3**: The verification is in progress.'."\n"
+ .'* **4**: The verification was interrupted.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'DagId' => [
+ 'description' => 'The unique ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33753',
+ ],
+ 'Delete' => [
+ 'description' => 'Indicates whether the source data is deleted. Valid values:'."\n"
+ ."\n"
+ .'* **true**: deletes the jobs in the application group.'."\n"
+ .'* **false**'."\n",
+ 'type' => 'string',
+ 'example' => 'false',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the task ended.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-23 10:23:20',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the task flow was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-03-28 10:50:45',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the task flow was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-04-18 15:28:16',
+ ],
+ 'HistoryDagId' => [
+ 'description' => 'The ID of the historical task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6851',
+ ],
+ 'Id' => [
+ 'description' => 'The task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24271',
+ ],
+ 'LastRunningContext' => [
+ 'description' => 'The context of the last execution of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '{”nodes":[11694,11695]"}',
+ ],
+ 'Msg' => [
+ 'description' => 'The details of the current task execution.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Status' => [
+ 'description' => 'The state of the archiving task.'."\n"
+ ."\n"
+ .'* **0**: Pending.'."\n"
+ .'* **1**: Running.'."\n"
+ .'* **2**: Paused.'."\n"
+ .'* **3**: Failed.'."\n"
+ .'* **4**: Succeeded.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'TaskType' => [
+ 'description' => 'The task type. Valid values:'."\n"
+ ."\n"
+ .'* **1**: data archiving'."\n"
+ .'* **2**: archived data restoration'."\n"
+ .'* **3**: archived data verification'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'string',
+ 'example' => '3406',
+ ],
+ 'TriggerType' => [
+ 'description' => 'The mode in which the task flow is triggered. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow was triggered based on a schedule.'."\n"
+ .'* **1**: The task flow was manually triggered.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'Version' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TraceId\\": \\"0a06e1e316757357507896067d3780\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"PageIndex\\": 1,\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"PageSize\\": 10,\\n \\"Total\\": 2,\\n \\"Data\\": {\\n \\"Instance\\": [\\n {\\n \\"BusinessTime\\": \\"2023-05-14 16:00:57\\",\\n \\"CheckStatus\\": 3,\\n \\"DagId\\": 0,\\n \\"Delete\\": \\"false\\",\\n \\"EndTime\\": \\"2023-04-23 10:23:20\\",\\n \\"GmtCreate\\": \\"2023-03-28 10:50:45\\",\\n \\"GmtModified\\": \\"2023-04-18 15:28:16\\",\\n \\"HistoryDagId\\": 0,\\n \\"Id\\": 0,\\n \\"LastRunningContext\\": \\"{”nodes\\\\\\":[11***,11***]\\\\\\"}\\",\\n \\"Msg\\": \\"”归档任务日志：xxxx“\\",\\n \\"Status\\": 1,\\n \\"TaskType\\": 1,\\n \\"TenantId\\": \\"34***\\",\\n \\"TriggerType\\": 1,\\n \\"Version\\": \\"13***\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'GetPagedInstance',
+ ],
+ 'ListDBTaskSQLJob' => [
+ 'summary' => 'Queries a list of SQL tasks.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DBTaskGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL task group. You can call the [GetStructSyncJobDetail](~~206160~~) operation to obtain this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'exclusiveMaximum' => false,
+ 'minimum' => '1',
+ 'example' => '1324235',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F6C47680-8D2D-43A4-8902-F2740D71A398',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DBTaskSQLJobList' => [
+ 'description' => 'The list of the SQL tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The SQL task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'description' => 'The ID of the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123435',
+ ],
+ 'JobType' => [
+ 'description' => 'The type of the SQL task.'."\n",
+ 'type' => 'string',
+ 'example' => 'STRUCT_SYNC',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the SQL task.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DbSearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@xxx:3306【test】',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43214523',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the SQL task was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-02-18 17:49:20',
+ ],
+ 'LastExecTime' => [
+ 'description' => 'The time when the SQL task was last executed.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-02-18 17:49:31',
+ ],
+ 'DbTaskGroupId' => [
+ 'description' => 'The ID of the SQL task group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4324132',
+ ],
+ 'Status' => [
+ 'description' => 'The state of the SQL task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The SQL task was initialized.'."\n"
+ .'* **PENDING**: The SQL task waited to be run.'."\n"
+ .'* **BE_SCHEDULED**: The SQL task waited to be scheduled.'."\n"
+ .'* **FAIL**: The SQL task failed.'."\n"
+ .'* **SUCCESS**: The SQL task was successful.'."\n"
+ .'* **PAUSE**: The SQL task was paused.'."\n"
+ .'* **DELETE**: The SQL task was deleted.'."\n"
+ .'* **RUNNING**: The SQL task was being run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'Transactional' => [
+ 'description' => 'Indicates whether the SQL task is executed as a transaction. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The SQL task is executed as a transaction.'."\n"
+ .'* **false**: The SQL task is not executed as a transaction.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of the SQL tasks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F6C47680-8D2D-43A4-8902-F2740D71A398\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DBTaskSQLJobList\\": [\\n {\\n \\"JobId\\": 0,\\n \\"JobType\\": \\"STRUCT_SYNC\\",\\n \\"Comment\\": \\"test\\",\\n \\"DbSearchName\\": \\"test@xxx:3306[test]\\",\\n \\"DbId\\": 43214523,\\n \\"Logic\\": false,\\n \\"CreateTime\\": \\"2021-02-18 17:49:20\\",\\n \\"LastExecTime\\": \\"2021-02-18 17:49:31\\",\\n \\"DbTaskGroupId\\": 0,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Transactional\\": false\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListDBTaskSQLJobResponse>\\n <RequestId>F6C47680-8D2D-43A4-8902-F2740D71A398</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <ErrorCode>UnknownError</ErrorCode>\\n <DBTaskSQLJobList>\\n <JobType>STRUCT_SYNC</JobType>\\n <Comment>test</Comment>\\n <DbSearchName>test@xxx:3306【test】</DbSearchName>\\n <DbId>43214523</DbId>\\n <Logic>false</Logic>\\n <CreateTime>2021-02-18 17:49:20</CreateTime>\\n <LastExecTime>2021-02-18 17:49:31</LastExecTime>\\n <Status>SUCCESS</Status>\\n <Transactional>false</Transactional>\\n </DBTaskSQLJobList>\\n <TotalCount>1</TotalCount>\\n</ListDBTaskSQLJobResponse>","errorExample":""}]',
+ 'title' => 'ListDBTaskSQLJob',
+ ],
+ 'ListDBTaskSQLJobDetail' => [
+ 'summary' => 'Queries the details of an SQL task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL task. You can call the [ListDBTaskSQLJob](~~207049~~) operation to query the SQL task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1276****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '3F044E33-FE09-58F1-8C61-A0F612EC****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'JobId is mandatory for this action.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingJobId',
+ ],
+ 'DBTaskSQLJobDetailList' => [
+ 'description' => 'The details of SQL tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobDetailId' => [
+ 'description' => 'The ID of the details of the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24723****',
+ ],
+ 'CurrentSql' => [
+ 'description' => 'The SQL statement that was executed in the SQL task.'."\n",
+ 'type' => 'string',
+ 'example' => 'update a set id = 1 where id = 1;',
+ ],
+ 'ExecuteCount' => [
+ 'description' => 'The number of times that the SQL statement was executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'JobId' => [
+ 'description' => 'The ID of the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1276****',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the physical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1988****',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Skip' => [
+ 'description' => 'Indicates whether the SQL statement was skipped. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The SQL statement was skipped.'."\n"
+ .'* **false**: The SQL statement was not skipped.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SqlType' => [
+ 'description' => 'The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.'."\n",
+ 'type' => 'string',
+ 'example' => 'CREATE_TABLE',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the SQL task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The SQL task was initialized.'."\n"
+ .'* **PENDING**: The SQL task waited to be run.'."\n"
+ .'* **BE_SCHEDULED**: The SQL task waited to be scheduled.'."\n"
+ .'* **FAIL**: The SQL task failed.'."\n"
+ .'* **SUCCESS**: The SQL task was successful.'."\n"
+ .'* **PAUSE**: The SQL task was paused.'."\n"
+ .'* **DELETE**: The SQL task was deleted.'."\n"
+ .'* **RUNNING**: The SQL task was being run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'Log' => [
+ 'description' => 'The details of the operational log.'."\n",
+ 'type' => 'string',
+ 'example' => 'log_info',
+ ],
+ 'StartTime' => [
+ 'description' => 'The point in time when the SQL task started.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-16 00:00:00',
+ ],
+ 'EndTime' => [
+ 'description' => 'The point in time when the SQL task ended.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-16 00:00:01',
+ ],
+ 'TimeDelay' => [
+ 'description' => 'The duration of the SQL task. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '38',
+ ],
+ 'AffectRows' => [
+ 'description' => 'The number of rows affected by the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of SQL tasks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3F044E33-FE09-58F1-8C61-A0F612EC****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"JobId is mandatory for this action.\\",\\n \\"ErrorCode\\": \\"MissingJobId\\",\\n \\"DBTaskSQLJobDetailList\\": [\\n {\\n \\"JobDetailId\\": 0,\\n \\"CurrentSql\\": \\"update a set id = 1 where id = 1;\\",\\n \\"ExecuteCount\\": 1,\\n \\"JobId\\": 0,\\n \\"DbId\\": 0,\\n \\"Logic\\": false,\\n \\"Skip\\": false,\\n \\"SqlType\\": \\"CREATE_TABLE\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Log\\": \\"log_info\\",\\n \\"StartTime\\": \\"2021-12-16 00:00:00\\",\\n \\"EndTime\\": \\"2021-12-16 00:00:01\\",\\n \\"TimeDelay\\": 38,\\n \\"AffectRows\\": 0\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListDBTaskSQLJobDetailResponse>\\n <RequestId>3F044E33-FE09-58F1-8C61-A0F612EC****</RequestId>\\n <Success>true</Success>\\n <ErrorMessage>JobId is mandatory for this action.</ErrorMessage>\\n <ErrorCode>MissingJobId</ErrorCode>\\n <DBTaskSQLJobDetailList>\\n <CurrentSql>update a set id = 1 where id = 1;</CurrentSql>\\n <ExecuteCount>1</ExecuteCount>\\n <Logic>false</Logic>\\n <Skip>false</Skip>\\n <SqlType>CREATE_TABLE</SqlType>\\n <Status>SUCCESS</Status>\\n <Log>log_info</Log>\\n <StartTime>2021-12-16 00:00:00</StartTime>\\n <EndTime>2021-12-16 00:00:01</EndTime>\\n <TimeDelay>38</TimeDelay>\\n <AffectRows>0</AffectRows>\\n </DBTaskSQLJobDetailList>\\n <TotalCount>1</TotalCount>\\n</ListDBTaskSQLJobDetailResponse>","errorExample":""}]',
+ 'title' => 'ListDBTaskSQLJobDetail',
+ ],
+ 'GetDBTaskSQLJobLog' => [
+ 'summary' => 'Queries the log that records the scheduling details of an SQL task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the SQL task. You can call the [ListDBTaskSQLJob](~~207049~~) operation to query the ID of the SQL task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1276****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4AC23904-55DE-550B-9676-E8946F07****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'JobId is mandatory for this action.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingJobId',
+ ],
+ 'Log' => [
+ 'description' => 'The log that records the scheduling details.'."\n",
+ 'type' => 'string',
+ 'example' => 'log_****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AC23904-55DE-550B-9676-E8946F07****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"JobId is mandatory for this action.\\",\\n \\"ErrorCode\\": \\"MissingJobId\\",\\n \\"Log\\": \\"log_****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDBTaskSQLJobLogResponse>\\n <RequestId>4AC23904-55DE-550B-9676-E8946F07****</RequestId>\\n <Log>\\r\\n------[2021-12-08 12:05:31]------\\r\\n创建任务：分组id：0;分组排序：0\\r\\n\\r\\n------[2021-12-08 12:05:32]------\\r\\n任务初始化...\\r\\n\\r\\n------[2021-12-08 12:05:32]------\\r\\nqn_bzbh5@rm-bp144d5ky4l4rli0417****.mysql.rds.****.com:3306【qn_rds mysql】\\r\\n\\r\\n------[2021-12-08 12:05:32]------\\r\\nuse normal connection :Normal\\r\\n\\r\\n------[2021-12-08 12:05:32]------\\r\\n事务：关闭.\\r\\n\\r\\n------[2021-12-08 12:05:32]------\\r\\n开始执行：共1条SQL待执行 queryKey: executeKey_12763320_598\\r\\n\\r\\n------[2021-12-08 12:05:33]------\\r\\nchange done!\\r\\n\\r\\n------[2021-12-08 12:05:33]------\\r\\n任务执行成功!\\r\\n\\r\\n------[2021-12-08 12:05:33]------\\r\\njobSuccess callback Start.\\r\\n\\r\\n------[2021-12-08 12:05:33]------\\r\\nstart database level metadata sync task [Master]...\\r\\n\\r\\ndatabase table level sync. cost：355 ms\\r\\n------[2021-12-08 12:05:33]------\\r\\ngroup success callback end !\\r\\n\\r\\n------[2021-12-08 12:05:33]------\\r\\njobSuccess callback End.\\r\\n</Log>\\n <Success>true</Success>\\n</GetDBTaskSQLJobLogResponse>","errorExample":""}]',
+ 'title' => 'GetDBTaskSQLJobLog',
+ ],
+ 'GetOnlineDDLProgress' => [
+ 'summary' => 'Queries the details and progress of an OnlineDDL task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'JobDetailId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the OnlineDDL SQL task details. You can call the [ListDBTaskSQLJobDetail](~~207073~~) operation to obtain the task detail ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '15***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'OnlineDDLTaskDetail' => [
+ 'description' => 'The details of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobStatus' => [
+ 'description' => 'The state of the task. Valid values:'."\n"
+ ."\n"
+ .'* **INIT**: The task is being initialized.'."\n"
+ .'* **SUCCESS**: The task is complete.'."\n"
+ .'* **RUNNING**: The task is being executed.'."\n"
+ .'* **WAITING_CUTOVER**: The task is waiting for cut-over.'."\n"
+ .'* **RESTARTING**: The task is restarting.'."\n"
+ .'* **PAUSE**: The task is suspended.'."\n"
+ .'* **UNSUPPORTED**: The task is not supported.'."\n"
+ .'* **CANCELED**: The task is canceled.'."\n"
+ .'* **FAIL**: The task failed.'."\n"
+ .'* **INTERRUPT**: The task is interrupted.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'StatusDesc' => [
+ 'description' => 'The description of the task status.'."\n",
+ 'type' => 'string',
+ 'example' => 'Success',
+ ],
+ 'DelaySeconds' => [
+ 'description' => 'The replay latency of DMS. Unit: seconds. The replay latency is the period of time that is taken to replay the binary logs of the table to the temporary table. The latency does not indicate the data migration latency between a primary database and a secondary database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'CopyTotal' => [
+ 'description' => 'The estimated total number of rows of the data. The value is obtained from the statistical data in the information_schema database. In most cases, the estimated total number of rows is smaller than the actual number of rows in a table.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'CopyCount' => [
+ 'description' => 'The actual amount of data replicated from the original table in the lock-free change operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9',
+ ],
+ 'ProgressRatio' => [
+ 'description' => 'The estimated execution progress. The actual progress is subject to the task status.'."\n",
+ 'type' => 'string',
+ 'example' => '90%',
+ ],
+ 'CutoverLockTimeSeconds' => [
+ 'description' => 'The maximum period of time that a table can be locked during cut-over. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'CutoverFailRetryTimes' => [
+ 'description' => 'The number of retries when the cut-over fails.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'CleanStrategy' => [
+ 'description' => 'The cleanup policy of the original table after the cut-over. Valid values:'."\n"
+ ."\n"
+ .'* **DROP**: Invalid original tables are deleted.'."\n"
+ .'* **MOVE**: Invalid original tables are moved to the test database. You can delete the tables manually.'."\n"
+ .'* **NOTHING**: Invalid original tables are retained in the original database. You can delete the tables manually.'."\n",
+ 'type' => 'string',
+ 'example' => 'DROP',
+ ],
+ 'CopyChunkSize' => [
+ 'description' => 'The size of each chunk that is used to replicate data. This parameter is used to specify the size of each chunk. A larger chunk size increases the replication efficiency and decreases the business performance.'."\n"
+ ."\n"
+ .'> During full replication, the original table is divided into N small chunks and each chunk is replicated to the temporary table one by one. By default, DMS dynamically adjusts the size of each chunk.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000',
+ ],
+ 'CopyChunkMode' => [
+ 'description' => 'The policy of full replication. Valid values:'."\n"
+ ."\n"
+ .'* **AUTO**: DMS dynamically adjusts the chunk size based on the performance of the database. Tables are locked for less than 1.5 seconds during a single replication operation.'."\n"
+ .'* **RUNNING**: DMS uses the specified value of the CopyChunkSize parameter. The valid value of the CopyChunkSize parameter ranges from 1 to 60000. If you set this parameter to RUNNING, you must specify the CopyChunkSize parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'AUTO',
+ ],
+ 'CutoverWindowStartTime' => [
+ 'description' => 'The beginning of the time window of the cut-over operation. Default value: 00:00:00. This parameter controls the time window of the cut-over. Cut-over can be performed only when the cut-over conditions are met and the time is within the specified time window. If the time is not within the time window, the cut-over operation is not performed until the time reaches the beginning of the time window.'."\n",
+ 'type' => 'string',
+ 'example' => '12:00:00',
+ ],
+ 'CutoverWindowEndTime' => [
+ 'description' => 'The end of the time window of the cut-over operation. This value is at least 30 minutes later than the CutoverWindowStartTime parameter. Default value: 23:59:59'."\n",
+ 'type' => 'string',
+ 'example' => '13:00:00',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"OnlineDDLTaskDetail\\": {\\n \\"JobStatus\\": \\"SUCCESS\\",\\n \\"StatusDesc\\": \\"Success\\",\\n \\"DelaySeconds\\": 0,\\n \\"CopyTotal\\": 10,\\n \\"CopyCount\\": 9,\\n \\"ProgressRatio\\": \\"90%\\",\\n \\"CutoverLockTimeSeconds\\": 2,\\n \\"CutoverFailRetryTimes\\": 3,\\n \\"CleanStrategy\\": \\"DROP\\",\\n \\"CopyChunkSize\\": 1000,\\n \\"CopyChunkMode\\": \\"AUTO\\",\\n \\"CutoverWindowStartTime\\": \\"12:00:00\\",\\n \\"CutoverWindowEndTime\\": \\"13:00:00\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetOnlineDDLProgressResponse>\\n <RequestId>34E01EDD-6A16-4CF0-9541-C644D1BE01AA</RequestId>\\n <Success>true</Success>\\n <OnlineDDLTaskDetail>\\n <JobStatus>SUCCESS</JobStatus>\\n <StatusDesc>Success</StatusDesc>\\n <DelaySeconds>0</DelaySeconds>\\n <CopyTotal>10</CopyTotal>\\n <CopyCount>9</CopyCount>\\n <ProgressRatio>90</ProgressRatio>\\n <CutoverLockTimeSeconds>2</CutoverLockTimeSeconds>\\n <CutoverFailRetryTimes>3</CutoverFailRetryTimes>\\n <CleanStrategy>DROP</CleanStrategy>\\n <CopyChunkSize>1000</CopyChunkSize>\\n <CopyChunkMode>AUTO</CopyChunkMode>\\n <CutoverWindowStartTime>12:00:00</CutoverWindowStartTime>\\n <CutoverWindowEndTime>13:00:00</CutoverWindowEndTime>\\n </OnlineDDLTaskDetail>\\n</GetOnlineDDLProgressResponse>","errorExample":""}]',
+ 'title' => 'GetOnlineDDLProgress',
+ ],
+ 'GenerateSqlFromNL' => [
+ 'summary' => 'Automatically retrieves relevant database and business information and generates the executable SQL statement based on the natural language description provided.',
+ 'description' => '## 请求说明'."\n"
+ .'- 该API用于将用户的自然语言问题转换为可执行的SQL查询语句。'."\n"
+ .'- 用户需要提供数据库ID (`dbId`) 和实例ID (`instanceId`)，以及想要查询的问题描述 (`question`)。'."\n"
+ .'- 可选参数包括业务知识 (`knowledge`)、数据库方言 (`dialect`)、历史消息 (`history`)、算法级别 (`level`) 和指定模型名称 (`model`)。'."\n"
+ .'- `dialect` 默认值为 "SQL"，表示生成标准SQL语句；`level` 默认值为 "base"，代表基础级别的处理。'."\n"
+ .'- 如果请求中包含多个表且这些表不属于同一个数据库，则返回的 `dbId` 将为0，表明这是一个跨库查询。'."\n"
+ .'- 返回结果中除了生成的SQL语句外，还包括了求解时用到的表、引用的知识点、展示用的SQL等信息，方便进一步理解和使用。'."\n",
+ 'path' => '/',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '数据库ID，可以调用[ListDatabases](~~141873~~)接口获取。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Knowledge',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '知识数据，额外输入的业务知识',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'state>0代表成功',
+ ],
+ ],
+ [
+ 'name' => 'Question',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '问题。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'Dialect',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '数据库实例类型',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '实例级别。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'base',
+ 'default' => 'base',
+ 'enum' => [
+ 'base',
+ 'medium',
+ 'complex',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '选用的模型名称，仅可用千问系列',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ [
+ 'name' => 'TableNames',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '选用的表名，列表（用逗号分隔），若指定该值，则只会使用选用的表'."\n",
+ 'type' => 'string',
+ 'docRequired' => false,
+ 'example' => 'users,orders',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功生成SQL',
+ 'schema' => [
+ 'title' => '取数'."\n",
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码。',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息。',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，返回值如下：'."\n"
+ .'- **true**：请求成功'."\n"
+ .'- **false**：请求失败',
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '返回的数据信息。',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Question' => [
+ 'title' => '原输入问题'."\n",
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Tables' => [
+ 'title' => '求解时用到的表列表。每个元素代表一个表实体，具体结构较为复杂，此处简化处理。',
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '求解时用到的表实体。每个元素代表一个具体的表，包括但不限于表名、表ID等信息。',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'title' => '表名，用于唯一标识数据库中的某张表。',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'ins_1.db1.table1',
+ ],
+ ],
+ ],
+ ],
+ 'KnowledgeReferences' => [
+ 'title' => '引用的知识',
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'title' => '知识的名称',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'sample_tbl',
+ ],
+ 'Content' => [
+ 'title' => '知识的具体内容',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '{\'Status\': \'OK\'}',
+ ],
+ 'Level' => [
+ 'title' => '知识类型。'."\n"
+ .' * RULE: 规则'."\n"
+ .' * FAQ: 常见问题解答'."\n"
+ .' * DOCUMENT: 文档',
+ 'description' => '',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'to_verify' => 'to_verify',
+ 'verified' => 'verified',
+ 'to_complete' => 'to_complete',
+ 'to_review' => 'to_review',
+ ],
+ 'example' => 'verified',
+ 'enum' => [
+ 'RULE',
+ 'FAQ',
+ 'DOCUMENT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Sql' => [
+ 'title' => 'GUID-SQL，后端处理量用这个'."\n",
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'SELECT * FROM table WHERE condition;',
+ ],
+ 'SimilarSql' => [
+ 'title' => '参考的相似SQL列表',
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Question' => [
+ 'title' => '问题描述',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Sql' => [
+ 'title' => '生成的SQL语句',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'SELECT * WHERE ResourceType = \'ACS::ECS::Instance\' AND ResourceGroupId != \'rg-xxx\'',
+ ],
+ 'Thought' => [
+ 'title' => '生成SQL时的思考过程',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Score' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0.52',
+ ],
+ ],
+ ],
+ ],
+ 'Thought' => [
+ 'title' => '无明确描述信息'."\n",
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '通过分析用户的问题和提供的知识，生成了相应的SQL语句。',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Question\\": \\"查询今天用户访问量\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"ins_1.db1.table1\\"\\n }\\n ],\\n \\"KnowledgeReferences\\": [\\n {\\n \\"Name\\": \\"sample_tbl\\",\\n \\"Content\\": \\"{\'Status\': \'OK\'}\\",\\n \\"Level\\": \\"verified\\"\\n }\\n ],\\n \\"Sql\\": \\"SELECT * FROM table WHERE condition;\\",\\n \\"SimilarSql\\": [\\n {\\n \\"Question\\": \\"实例xxx的访问量有多少？\\",\\n \\"Sql\\": \\"SELECT * WHERE ResourceType = \'ACS::ECS::Instance\' AND ResourceGroupId != \'rg-xxx\'\\",\\n \\"Thought\\": \\"度量（指标）： 用户询问了xx指标，根据上下文，需要计算xxx。\\\\n维度（筛选条件）： 用户问题里提到了xx的条件，结合上下文，核心维度为xxx。\\\\n综上，需要使用xxx表，使用xxx列。其中xxx作为projection选择，xxx用于过滤条件，xxx用于分组条件。\\",\\n \\"Score\\": \\"0.52\\"\\n }\\n ],\\n \\"Thought\\": \\"通过分析用户的问题和提供的知识，生成了相应的SQL语句。\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GenerateSqlFromNL',
+ ],
+ 'SetOwners' => [
+ 'summary' => 'Configures the owner of an instance, a database, or a table.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the resource. The ID of the resource varies with the owner type. The owner types and resource IDs have the following mappings:'."\n"
+ ."\n"
+ .'* INSTANCE: the ID of an instance. You can call the [ListInstances](~~141936~~) operation to query the ID of the instance.'."\n"
+ .'* DATABASE: the ID of a physical database. You can call the [ListDatabases](~~141873~~) operation to query the ID of the physical database.'."\n"
+ .'* LOGIC_DATABASE: the ID of a logical database. You can call the [ListLogicDatabases](~~141874~~) operation to query the ID of the logical database.'."\n"
+ .'* TABLE: the ID of a physical table. You can call the [ListTables](~~141878~~) operation to query the ID of the physical table.'."\n"
+ .'* LOGIC_DATABASE: the ID of a logical table. You can call the [ListLogicTables](~~141875~~) operation to query the ID of the logical table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '174****',
+ ],
+ ],
+ [
+ 'name' => 'OwnerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the owner. Valid values:'."\n"
+ ."\n"
+ .'* INSTANCE: an owner of an instance.'."\n"
+ .'* DATABASE: an owner of a physical database.'."\n"
+ .'* LOGIC_DATABASE: an owner of a logical database.'."\n"
+ .'* TABLE: an owner of a physical table.'."\n"
+ .'* LOGIC_TABLE: an owner of a logical table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'INSTANCE',
+ 'enum' => [
+ 'DATABASE',
+ 'LOGIC_DATABASE',
+ 'TABLE',
+ 'LOGIC_TABLE',
+ 'INSTANCE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'OwnerIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user whom you want to specify as an owner. Separate multiple IDs with commas (,). You can call the [GetUser](~~147098~~) or [ListUsers](~~141938~~) operation to query the ID of the user.'."\n"
+ ."\n"
+ .'> The value of the OwnerIds parameter is that of the UserId parameter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A99CD576-1E18-4E86-931E-C3CCE56DC030',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A99CD576-1E18-4E86-931E-C3CCE56DC030\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetOwnersResponse>\\n <RequestId>A99CD576-1E18-4E86-931E-C3CCE56DC030</RequestId>\\n <Success>true</Success>\\n</SetOwnersResponse>","errorExample":""}]',
+ 'title' => 'SetOwners',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListInstanceUserPermissions' => [
+ 'summary' => 'Queries the permissions of a user on an instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '174****',
+ ],
+ ],
+ [
+ 'name' => 'UserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The nickname of the user. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to query the nickname of the user.'."\n"
+ ."\n"
+ .'> The value of the NickName parameter is that of the UserName parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_nick_name',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of returned entries.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7D162AAE-6501-5691-BF14-D7018F662895',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'UserPermissions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'UserPermission' => [
+ 'description' => 'The permissions of the user on the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'UserNickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_nick_name',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '174****',
+ ],
+ 'PermDetails' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PermDetail' => [
+ 'description' => 'The details of permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginFrom' => [
+ 'description' => 'The user who grants the permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx authorization',
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permissions. Valid values:'."\n"
+ ."\n"
+ .'* LOGIN: the logon permissions'."\n"
+ .'* PERF: the query permissions on the instance'."\n",
+ 'type' => 'string',
+ 'example' => 'LOGIN',
+ ],
+ 'ExpireDate' => [
+ 'description' => 'The time when the permissions expire.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-12 00:00:00',
+ ],
+ 'CreateDate' => [
+ 'description' => 'The time when the permissions were granted.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-12-12 00:00:00',
+ ],
+ 'UserAccessId' => [
+ 'description' => 'The ID of the authorization record.'."\n",
+ 'type' => 'string',
+ 'example' => '773****',
+ ],
+ 'ExtraData' => [
+ 'description' => 'This parameter is reserved.'."\n",
+ 'type' => 'string',
+ 'example' => 'XXX',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"7D162AAE-6501-5691-BF14-D7018F662895\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"UserPermissions\\": {\\n \\"UserPermission\\": [\\n {\\n \\"UserId\\": \\"51****\\",\\n \\"UserNickName\\": \\"test_nick_name\\",\\n \\"InstanceId\\": \\"174****\\",\\n \\"PermDetails\\": {\\n \\"PermDetail\\": [\\n {\\n \\"OriginFrom\\": \\"XXX授权\\",\\n \\"PermType\\": \\"LOGIN\\",\\n \\"ExpireDate\\": \\"2020-12-12 00:00:00\\",\\n \\"CreateDate\\": \\"2019-12-12 00:00:00\\",\\n \\"UserAccessId\\": \\"773****\\",\\n \\"ExtraData\\": \\"XXX\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListInstanceUserPermissionsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>7D162AAE-6501-5691-BF14-D7018F662895</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <UserPermissions>\\n <UserId>51****</UserId>\\n <UserNickName>test_nick_name</UserNickName>\\n <InstanceId>174****</InstanceId>\\n <PermDetails>\\n <OriginFrom>XXX授权</OriginFrom>\\n <PermType>LOGIN</PermType>\\n <ExpireDate>2020-12-12 00:00:00</ExpireDate>\\n <CreateDate>2019-12-12 00:00:00</CreateDate>\\n <UserAccessId>773****</UserAccessId>\\n <ExtraData>XXX</ExtraData>\\n </PermDetails>\\n </UserPermissions>\\n <Success>true</Success>\\n</ListInstanceUserPermissionsResponse>","errorExample":""}]',
+ 'title' => 'ListInstanceUserPermissions',
+ ],
+ 'ListDatabaseUserPermssions' => [
+ 'summary' => 'Queries the permissions of users on a database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '-1',
+ ],
+ ],
+ [
+ 'name' => 'PermType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the permission. Valid values:'."\n"
+ ."\n"
+ .'* DATABASE: permissions on databases'."\n"
+ .'* TABLE: permissions on tables'."\n"
+ .'* COLUMN: permissions on fields'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATABASE',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'UserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'search_user_name',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '68075D06-7406-4887-83A7-F558A4D28C13',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'UserPermissions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'UserPermission' => [
+ 'description' => 'The details of user permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1234',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'table_name',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '14324',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx@xxxx:3306',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'UserNickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user_nick_name',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '1443',
+ ],
+ 'PermDetails' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PermDetail' => [
+ 'description' => 'The details of user permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginFrom' => [
+ 'description' => 'The description of the entity that authorizes the permission.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx grant',
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permission. Valid values:'."\n"
+ ."\n"
+ .'* QUERY: the query permissions'."\n"
+ .'* EXPORT: the export permissions'."\n"
+ .'* CORRECT: the change permissions'."\n",
+ 'type' => 'string',
+ 'example' => 'QUERY',
+ ],
+ 'ExpireDate' => [
+ 'description' => 'The time when the permissions expire.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-12 00:00:00',
+ ],
+ 'CreateDate' => [
+ 'description' => 'The time when the permission was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-12-12 00:00:00',
+ ],
+ 'UserAccessId' => [
+ 'description' => 'The ID of the authorization record.'."\n",
+ 'type' => 'string',
+ 'example' => '13434',
+ ],
+ 'ExtraData' => [
+ 'description' => 'The extra information. This parameter is reserved.'."\n",
+ 'type' => 'string',
+ 'example' => 'DEFAULT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of a column.'."\n",
+ 'type' => 'string',
+ 'example' => 'column_name',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'DsType' => [
+ 'description' => 'The type of resources on which the user has permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'DATABASE',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the table.'."\n",
+ 'type' => 'string',
+ 'example' => '42345',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the database instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'instance_alias',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"68075D06-7406-4887-83A7-F558A4D28C13\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"UserPermissions\\": {\\n \\"UserPermission\\": [\\n {\\n \\"DbId\\": \\"1234\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"UserId\\": \\"14324\\",\\n \\"SchemaName\\": \\"xxx@xxxx:3306\\",\\n \\"Logic\\": false,\\n \\"UserNickName\\": \\"user_nick_name\\",\\n \\"InstanceId\\": \\"1443\\",\\n \\"PermDetails\\": {\\n \\"PermDetail\\": [\\n {\\n \\"OriginFrom\\": \\"xxx grant\\",\\n \\"PermType\\": \\"QUERY\\",\\n \\"ExpireDate\\": \\"2020-12-12 00:00:00\\",\\n \\"CreateDate\\": \\"2019-12-12 00:00:00\\",\\n \\"UserAccessId\\": \\"13434\\",\\n \\"ExtraData\\": \\"DEFAULT\\"\\n }\\n ]\\n },\\n \\"EnvType\\": \\"product\\",\\n \\"ColumnName\\": \\"column_name\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DsType\\": \\"DATABASE\\",\\n \\"TableId\\": \\"42345\\",\\n \\"SearchName\\": \\"xxx\\",\\n \\"Alias\\": \\"instance_alias\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UserPermissions>\\n <UserPermission>\\n <Logic>false</Logic>\\n <UserNickName>xxx</UserNickName>\\n <DsType>DATABASE</DsType>\\n <Alias>beihe_ent_prod</Alias>\\n <PermDetails>\\n <PermDetail>\\n <ExpireDate>2020-10-31 00:00:00</ExpireDate>\\n <UserAccessId>390915</UserAccessId>\\n <PermType>QUERY</PermType>\\n <OriginFrom>xxx</OriginFrom>\\n <CreateDate>2019-11-21 15:07:45</CreateDate>\\n </PermDetail>\\n <PermDetail>\\n <ExpireDate>2020-10-31 00:00:00</ExpireDate>\\n <UserAccessId>390916</UserAccessId>\\n <PermType>EXPORT</PermType>\\n <OriginFrom>xxx</OriginFrom>\\n <CreateDate>2019-11-21 15:07:45</CreateDate>\\n </PermDetail>\\n <PermDetail>\\n <ExpireDate>2020-10-31 00:00:00</ExpireDate>\\n <UserAccessId>390917</UserAccessId>\\n <PermType>CORRECT</PermType>\\n <OriginFrom>xxx</OriginFrom>\\n <CreateDate>2019-11-21 15:07:45</CreateDate>\\n </PermDetail>\\n </PermDetails>\\n <InstanceId>1434</InstanceId>\\n <SearchName>xxx@xxxx:3306</SearchName>\\n <DbId>123434</DbId>\\n <UserId>432423</UserId>\\n <DbType>drds</DbType>\\n <EnvType>product</EnvType>\\n <SchemaName>xxx</SchemaName>\\n </UserPermission>\\n</UserPermissions>\\n<TotalCount>1</TotalCount>\\n<RequestId>68075D06-7406-4887-83A7-F558A4D28C13</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListDatabaseUserPermssions',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListUserPermissions' => [
+ 'summary' => 'Queries the permissions of a user on databases and tables.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'PermType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The permissions on a specific type of resources that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* DATABASE: permissions on databases'."\n"
+ .'* TABLE: permissions on tables'."\n"
+ .'* COLUMN: permissions on fields'."\n"
+ .'* INSTANCE: permissions on instances'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATABASE',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [GetUser](~~147098~~) or [ListUsers](~~141938~~) operation to query the ID of the user.'."\n"
+ ."\n"
+ .'> The user ID is different from the ID of your Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'db_name',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword used in the query. For example, if you want to query permissions on an instance, you can specify the endpoint of the instance, such as rm-bp144d5ky4l4r****.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rm-bp144d5ky4l4r****',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* true: The database is a logical database.'."\n"
+ .'* false: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'* product: production environment'."\n"
+ .'* dev: development environment'."\n"
+ .'* pre: staging environment'."\n"
+ .'* test: test environment'."\n"
+ .'* sit: SIT environment'."\n"
+ .'* uat: user acceptance testing (UAT) environment'."\n"
+ .'* pet: stress testing environment'."\n"
+ .'* stag: STAG environment'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dev',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'polardb',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries that meet the query conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'UserPermissions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'UserPermission' => [
+ 'description' => 'The details of the permissions that the user has.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'string',
+ 'example' => '1860****',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_table',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_db',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* true: The database is a logical database.'."\n"
+ .'* false: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'UserNickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'nick_name',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '174****',
+ ],
+ 'PermDetails' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PermDetail' => [
+ 'description' => 'The details of permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginFrom' => [
+ 'description' => 'The user who grants the permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx authorization',
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permissions. Valid values:'."\n"
+ ."\n"
+ .'* QUERY: the query permissions'."\n"
+ .'* EXPORT: the export permissions'."\n"
+ .'* CORRECT: the change permissions'."\n",
+ 'type' => 'string',
+ 'example' => 'QUERY',
+ ],
+ 'ExpireDate' => [
+ 'description' => 'The time when the permissions expire.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-12 00:00:00',
+ ],
+ 'CreateDate' => [
+ 'description' => 'The time when the permissions were granted.'."\n",
+ 'type' => 'string',
+ 'example' => '2019-12-12 00:00:00',
+ ],
+ 'UserAccessId' => [
+ 'description' => 'The ID of the authorization record.'."\n",
+ 'type' => 'string',
+ 'example' => '758****',
+ ],
+ 'ExtraData' => [
+ 'description' => 'This parameter is reserved.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs. Valid values:'."\n"
+ ."\n"
+ .'- product: production environment'."\n"
+ .'- dev: development environment'."\n"
+ .'- pre: staging environment'."\n"
+ .'- test: test environment'."\n"
+ .'- sit: SIT environment'."\n"
+ .'- uat: UAT environment'."\n"
+ .'- pet: stress testing environment'."\n"
+ .'- stag: STAG environment',
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.',
+ 'type' => 'string',
+ 'example' => 'column_name',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database. For more information about the valid values of this parameter, see [DbType parameter](https://www.alibabacloud.com/help/en/data-management-service/latest/dbtype-parameter).',
+ 'type' => 'string',
+ 'example' => 'polardb',
+ ],
+ 'DsType' => [
+ 'description' => 'The permissions on a specific type of objects that are granted to the user. Valid values: '."\n"
+ ."\n"
+ .'- DATABASE: permissions on physical databases'."\n"
+ .'- LOGIC_DATABASE: permissions on logical databases'."\n"
+ .'- TABLE: permissions on physical tables'."\n"
+ .'- LOGIC_TABLE: permissions on logical tables',
+ 'type' => 'string',
+ 'example' => 'DATABASE',
+ ],
+ 'TableId' => [
+ 'description' => 'The ID of the table.',
+ 'type' => 'string',
+ 'example' => '13434',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.',
+ 'type' => 'string',
+ 'example' => 'test_db@xxx:3306',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the instance.',
+ 'type' => 'string',
+ 'example' => 'instance_alias',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint that is used to connect the database.',
+ 'type' => 'string',
+ 'example' => 'rm-bp144d5ky4l4r****',
+ ],
+ 'Port' => [
+ 'description' => 'The port that is used to connect to the instance.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3306',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"UserPermissions\\": {\\n \\"UserPermission\\": [\\n {\\n \\"DbId\\": \\"1860****\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"UserId\\": \\"51****\\",\\n \\"SchemaName\\": \\"test_db\\",\\n \\"Logic\\": false,\\n \\"UserNickName\\": \\"nick_name\\",\\n \\"InstanceId\\": \\"174****\\",\\n \\"PermDetails\\": {\\n \\"PermDetail\\": [\\n {\\n \\"OriginFrom\\": \\"xxx授权\\",\\n \\"PermType\\": \\"QUERY\\",\\n \\"ExpireDate\\": \\"2020-12-12 00:00:00\\",\\n \\"CreateDate\\": \\"2019-12-12 00:00:00\\",\\n \\"UserAccessId\\": \\"758****\\",\\n \\"ExtraData\\": \\"xxx\\"\\n }\\n ]\\n },\\n \\"EnvType\\": \\"dev\\",\\n \\"ColumnName\\": \\"column_name\\",\\n \\"DbType\\": \\"polardb\\",\\n \\"DsType\\": \\"DATABASE\\",\\n \\"TableId\\": \\"13434\\",\\n \\"SearchName\\": \\"test_db@xxx:3306\\",\\n \\"Alias\\": \\"instance_alias\\",\\n \\"Host\\": \\"rm-bp144d5ky4l4r****\\",\\n \\"Port\\": 3306\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListUserPermissionsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <UserPermissions>\\n <DbId>1860****</DbId>\\n <TableName>test_table</TableName>\\n <UserId>51****</UserId>\\n <SchemaName>test_db</SchemaName>\\n <Logic>false</Logic>\\n <UserNickName>nick_name</UserNickName>\\n <InstanceId>174****</InstanceId>\\n <PermDetails>\\n <OriginFrom>xxx授权</OriginFrom>\\n <PermType>QUERY</PermType>\\n <ExpireDate>2020-12-12 00:00:00</ExpireDate>\\n <CreateDate>2019-12-12 00:00:00</CreateDate>\\n <UserAccessId>758****</UserAccessId>\\n <ExtraData>xxx</ExtraData>\\n </PermDetails>\\n <EnvType>dev</EnvType>\\n <ColumnName>column_name</ColumnName>\\n <DbType>polardb</DbType>\\n <DsType>DATABASE</DsType>\\n <TableId>13434</TableId>\\n <SearchName>test_db@xxx:3306</SearchName>\\n <Alias>instance_alias</Alias>\\n <Host>rm-bp144d5ky4l4r****</Host>\\n <Port>3306</Port>\\n </UserPermissions>\\n <Success>true</Success>\\n</ListUserPermissionsResponse>","errorExample":""}]',
+ 'title' => 'ListUserPermissions',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GrantUserPermission' => [
+ 'summary' => 'Grants permissions on an instance, a database, or a table to a user.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [GetUser](~~147098~~) or [ListUsers](~~141938~~) operation to query the ID of the user.'."\n"
+ ."\n"
+ .'> The user ID is different from the ID of your Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'DsType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The permissions on a specific type of object that you want to grant to the user. Valid values:'."\n"
+ ."\n"
+ .'* INSTANCE: permissions on instances'."\n"
+ .'* DATABASE: permissions on physical databases'."\n"
+ .'* LOGIC_DATABASE: permissions on logical databases'."\n"
+ .'* TABLE: permissions on physical tables'."\n"
+ .'* LOGIC_TABLE: permissions on logical tables'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATABASE',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You must specify this parameter if you grant permissions on an instance to the user. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '174****',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. You can call the [ListDatabases](~~141873~~) operation to query the ID of a physical database and the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n"
+ ."\n"
+ .'> The value of the DatabaseId parameter is that of the DbId parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. You must specify this parameter if you grant permissions on a database to the user. Valid values:'."\n"
+ ."\n"
+ .'* true: The database is a logical database.'."\n"
+ .'* false: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the table. You must specify this parameter if you grant permissions on a table to the user. You can call the [ListTables](~~141878~~) operation to query the table ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '132***',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You must specify this parameter if you grant permissions on a table to the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'PermTypes',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The permission type. Separate multiple permission types with commas (,). Valid values:'."\n"
+ ."\n"
+ .'* **QUERY**: the query permissions'."\n"
+ .'* **EXPORT**: the export permissions'."\n"
+ .'* **CORRECT**: the change permissions'."\n"
+ .'* **LOGIN**: the logon permissions'."\n"
+ .'* **PERF**: the query permissions on the performance details of the instance'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'QUERY',
+ ],
+ ],
+ [
+ 'name' => 'ExpireDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time when the permissions expire.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-12-12 00:00:00',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A99CD576-1E18-4E86-931E-C3CCE56DC030',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A99CD576-1E18-4E86-931E-C3CCE56DC030\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GrantUserPermissionResponse>\\n <RequestId>A99CD576-1E18-4E86-931E-C3CCE56DC030</RequestId>\\n <Success>true</Success>\\n</GrantUserPermissionResponse>","errorExample":""}]',
+ 'title' => 'GrantUserPermission',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RevokeUserPermission' => [
+ 'summary' => 'Revokes the permissions on instances, databases, and tables from a user.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to query the ID of the user.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'DsType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object on which you want to revoke permissions from a user. Valid values:'."\n"
+ ."\n"
+ .'* **INSTANCE**: instances.'."\n"
+ .'* **DATABASE**: physical databases.'."\n"
+ .'* **LOGIC_DATABASE**: logical databases.'."\n"
+ .'* **TABLE**: physical tables.'."\n"
+ .'* **LOGIC_TABLE**: logical tables.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATABASE',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database instance ID. You must specify this parameter if you revoke a permission from the database instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the ID of the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '174****',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1860****',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the database is a logical database, set this parameter to **true**.'."\n"
+ ."\n"
+ .'* If the database is a physical database, set this parameter to **false**.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'TableId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table ID. You must specify this parameter if you revoke a permission from the table. You can call the [ListTables](~~141878~~) operation to query the table ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '13****',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'PermTypes',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the permissions. Valid values:'."\n"
+ ."\n"
+ .'* **QUERY**: query permissions.'."\n"
+ .'* **EXPORT**: export permissions.'."\n"
+ .'* **CORRECT**: change permissions.'."\n"
+ .'* **LOGIN**: logon permissions.'."\n"
+ .'* **PERF**: query permissions on the performance details of an instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'CORRECT',
+ ],
+ ],
+ [
+ 'name' => 'UserAccessId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The permission ID. You can call the [ListUserPermission](~~146957~~) operation to query the permission ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '774****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'A99CD576-1E18-4E86-931E-C3CCE56D****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'MissingUserId',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UserId is mandatory for this action.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A99CD576-1E18-4E86-931E-C3CCE56D****\\",\\n \\"ErrorCode\\": \\"MissingUserId\\",\\n \\"ErrorMessage\\": \\"UserId is mandatory for this action.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RevokeUserPermissionResponse>\\n <RequestId>A99CD576-1E18-4E86-931E-C3CCE56D****</RequestId>\\n <Success>true</Success>\\n</RevokeUserPermissionResponse>","errorExample":""}]',
+ 'title' => 'RevokeUserPermission',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListAuthorizedInstancesForUser' => [
+ 'summary' => 'Queries the instances on which the specified user has permissions.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '250181',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [GetUser](~~465816~~) operation to query the user ID.'."\n"
+ ."\n"
+ .'> If IdentityType is set to USER, this parameter is required.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of databases. Valid values:'."\n"
+ ."\n"
+ .'* **MySQL**'."\n"
+ .'* **SQLServer**'."\n"
+ .'* **PostgreSQL**'."\n"
+ .'* **Oracle**'."\n"
+ .'* **DRDS**'."\n"
+ .'* **OceanBase**'."\n"
+ .'* **Mongo**'."\n"
+ .'* **Redis**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The search keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'policy_test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'B7DB89CC-017D-5503-8953-38FFE241A618',
+ ],
+ 'Instances' => [
+ 'description' => 'The list of instances on which the user has permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The instances on which the user has permissions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '21****',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint that is used to connect to the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com',
+ ],
+ 'Port' => [
+ 'description' => 'The port number that is used to connect to the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '3306',
+ ],
+ 'DbType' => [
+ 'description' => 'The database engine that the instance runs.'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'UserId' => [
+ 'description' => 'The user IDs.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'UserName' => [
+ 'description' => 'The user name.'."\n",
+ 'type' => 'string',
+ 'example' => 'user_test',
+ ],
+ 'InstanceAlias' => [
+ 'description' => 'The alias of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'DMS_TEST',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'PermissionDetail' => [
+ 'description' => 'The details of permissions. The format of the permission details varies with the permission source. For example, if the permission source is a normal permission, the following parameters are returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DsType' => [
+ 'description' => 'The type of object on which the operation is performed.'."\n",
+ 'type' => 'string',
+ 'example' => 'DATABASE',
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permission. Valid values:'."\n"
+ ."\n"
+ .'* **QUERY**: the query permission'."\n"
+ .'* **EXPORT**: the data export permission'."\n"
+ .'* **CORRECT**: the data change permission'."\n",
+ 'type' => 'string',
+ 'example' => 'CORRECT',
+ ],
+ 'ExpireDate' => [
+ 'description' => 'The time when the permission expires.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-12-06 10:00:00'."\n",
+ ],
+ 'Message' => [
+ 'description' => 'If the permission source is a permission policy, the value of this parameter includes the policy name and the operations that are allowed for the user.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7DB89CC-017D-5503-8953-38FFE241A618\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"21****\\",\\n \\"Host\\": \\"rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"UserId\\": \\"51****\\",\\n \\"UserName\\": \\"user_test\\",\\n \\"InstanceAlias\\": \\"DMS_TEST\\",\\n \\"EnvType\\": \\"product\\",\\n \\"PermissionDetail\\": {\\n \\"DsType\\": \\"DATABASE\\",\\n \\"PermType\\": \\"CORRECT\\",\\n \\"ExpireDate\\": \\"2024-12-06 10:00:00\\\\n\\",\\n \\"Message\\": \\"权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAuthorizedInstancesForUser',
+ ],
+ 'ListAuthorizedUsersForInstance' => [
+ 'summary' => 'Queries a list of users that have permissions on the specified instance.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '250296',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '174****',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used for the search.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'poc_test',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Users' => [
+ 'description' => 'The list of users that have permissions on the specified instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of users.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '51***',
+ ],
+ 'Uid' => [
+ 'description' => 'The UID of the user\'s Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '164882191****'."\n",
+ ],
+ 'UserNickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user_test',
+ ],
+ 'UserRealName' => [
+ 'description' => 'The real name of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user01',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"51***\\",\\n \\"Uid\\": \\"164882191****\\\\n\\",\\n \\"UserNickName\\": \\"user_test\\",\\n \\"UserRealName\\": \\"user01\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAuthorizedUsersForInstance',
+ ],
+ 'ListAuthorizedDatabasesForUser' => [
+ 'summary' => 'Queries the databases on which the specified user has permissions.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '250204',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [GetUser](~~465816~~) operation to query the user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of databases. Valid values:'."\n"
+ ."\n"
+ .'* **MySQL**'."\n"
+ .'* **SQLServer**'."\n"
+ .'* **PostgreSQL**'."\n"
+ .'* **Oracle**'."\n"
+ .'* **DRDS**'."\n"
+ .'* **OceanBase**'."\n"
+ .'* **Mongo**'."\n"
+ .'* **Redis**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true.**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The search keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'policy_test',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '012AE0B5-4B52-532F-BD7C-1EE9F182089B',
+ ],
+ 'Databases' => [
+ 'description' => 'The names of the databases on which the user has permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The database information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The database ID.'."\n",
+ 'type' => 'string',
+ 'example' => '254****',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc_testdb',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '235****',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true.**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DbType' => [
+ 'description' => 'The engine of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'MYSQL',
+ ],
+ 'UserId' => [
+ 'description' => 'The user IDs.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment in which the database instance is deployed.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'PermissionDetail' => [
+ 'description' => 'The details of permissions. The format of the permission details varies with the permission source. For example, if the permission source is a normal permission, the following parameters are returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DsType' => [
+ 'description' => 'The type of object on which the operation is performed.'."\n",
+ 'type' => 'string',
+ 'example' => 'DATABASE',
+ ],
+ 'PermType' => [
+ 'description' => 'The type of the permission. Valid values:'."\n"
+ ."\n"
+ .'* **QUERY**: the query permission'."\n"
+ .'* **EXPORT**: the data export permission'."\n"
+ .'* **CORRECT**: the data change permission'."\n",
+ 'type' => 'string',
+ 'example' => 'CORRECT',
+ ],
+ 'ExpireDate' => [
+ 'description' => 'The time when the permissions expire.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-12-06 10:00:00',
+ ],
+ 'Message' => [
+ 'description' => 'If the permission source is a permission policy, the value of this parameter includes the policy name and the operations that are allowed for the user.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"012AE0B5-4B52-532F-BD7C-1EE9F182089B\\",\\n \\"Databases\\": [\\n {\\n \\"DbId\\": \\"254****\\",\\n \\"SchemaName\\": \\"poc_testdb\\",\\n \\"SearchName\\": \\"poc\\",\\n \\"InstanceId\\": \\"235****\\",\\n \\"Logic\\": false,\\n \\"DbType\\": \\"MYSQL\\",\\n \\"UserId\\": \\"51****\\",\\n \\"EnvType\\": \\"product\\",\\n \\"PermissionDetail\\": {\\n \\"DsType\\": \\"DATABASE\\",\\n \\"PermType\\": \\"CORRECT\\",\\n \\"ExpireDate\\": \\"2024-12-06 10:00:00\\",\\n \\"Message\\": \\"权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAuthorizedDatabasesForUser',
+ ],
+ 'ListAuthorizedUsersForDatabase' => [
+ 'summary' => 'Queries a list of users that have permissions on the specified database.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '250285',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '135***',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true.**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used for the search.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'poc_test',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'Users' => [
+ 'description' => 'The list of users that have permissions on the specified instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The user IDs.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'UserNickName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user_test',
+ ],
+ 'Uid' => [
+ 'description' => 'The UID of the user\'s Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '164882191****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"51****\\",\\n \\"UserNickName\\": \\"user_test\\",\\n \\"Uid\\": \\"164882191****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAuthorizedUsersForDatabase',
+ ],
+ 'CreateStandardGroup' => [
+ 'summary' => 'Creates a security rule set.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_group',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_rule',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database engine. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The information about the created security rule set.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'title' => '',
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_group',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_rule',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'LastMenderId' => [
+ 'description' => 'The ID of the user who creates the security rule set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The control mode. Valid values:'."\n"
+ ."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n"
+ .'* **COMMON**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ 'GroupId' => [
+ 'description' => 'The security rule set ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41****'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"StandardGroup\\": {\\n \\"GroupName\\": \\"金融线-生产\\",\\n \\"Description\\": \\"金融线生产环境实例规则\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"LastMenderId\\": 0,\\n \\"GroupMode\\": \\"COMMON\\",\\n \\"GroupId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateStandardGroupResponse>\\n <RequestId>8EB6AE45-B52E-58DA-A400-58F4F31373DA</RequestId>\\n <StandardGroup>\\n <GroupName>金融线-生产</GroupName>\\n <Description>金融线生产环境实例规则</Description>\\n <LastMenderId>51****</LastMenderId>\\n <GroupMode>COMMON</GroupMode>\\n <DbType>mysql</DbType>\\n </StandardGroup>\\n <Success>true</Success>\\n</CreateStandardGroupResponse>","errorExample":""}]',
+ 'title' => 'CreateStandardGroup',
+ ],
+ 'ListStandardGroups' => [
+ 'summary' => 'Queries security rule sets.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'StandardGroupList' => [
+ 'description' => 'The security rule sets returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'title' => '',
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_group',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_rule',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database engine. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'LastMenderId' => [
+ 'description' => 'The ID of the user who queries the security sets.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The control mode. Valid values:'."\n"
+ ."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n"
+ .'* **COMMON**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the security rule set.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"StandardGroupList\\": [\\n {\\n \\"GroupName\\": \\"金融线-生产\\",\\n \\"Description\\": \\"金融线生产环境实例规则\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"LastMenderId\\": 0,\\n \\"GroupMode\\": \\"COMMON\\",\\n \\"GroupId\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListStandardGroupsResponse>\\n <RequestId>34E01EDD-6A16-4CF0-9541-C644D1BE01AA</RequestId>\\n <Success>true</Success>\\n <StandardGroupList>\\n <GroupName>金融线-生产</GroupName>\\n <Description>金融线生产环境实例规则</Description>\\n <DbType>mysql</DbType>\\n <LastMenderId>51****</LastMenderId>\\n <GroupMode>COMMON</GroupMode>\\n <GroupId>41****</GroupId>\\n </StandardGroupList>\\n</ListStandardGroupsResponse>","errorExample":""}]',
+ 'title' => 'ListStandardGroups',
+ ],
+ 'UpdateStandardGroup' => [
+ 'summary' => 'Modifies the name and description of a specific security rule set.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '规则集ID，可通过 ListStandardGroups 获取',
+ 'description' => 'The security rule set ID. You can call the [ListStandardGroups](~~465940~~) operation to obtain the ID of the security rule set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '242***',
+ ],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '安全规则名称',
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'poc_test',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '安全规则描述',
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Production Environment test rules',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '23****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The information about the security rule set.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'title' => '',
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc_test',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'Production Environment test rules',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database for which the security rules are used.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'LastMenderId' => [
+ 'description' => 'The ID of the user who last modified the security rules.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****'."\n",
+ ],
+ 'GroupMode' => [
+ 'description' => 'The control mode. Valid values:'."\n"
+ ."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n"
+ .'* **COMMON**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ 'GroupId' => [
+ 'description' => 'The security rule set ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41****'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"StandardGroup\\": {\\n \\"GroupName\\": \\"poc_test\\",\\n \\"Description\\": \\"生产环境测试规则\\\\n\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"LastMenderId\\": 0,\\n \\"GroupMode\\": \\"COMMON\\",\\n \\"GroupId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateStandardGroup',
+ ],
+ 'DeleteStandardGroup' => [
+ 'summary' => 'Deletes a security rule set.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '规则集ID，可通过 ListStandardGroups 获取',
+ 'description' => 'The security rule set ID. You can call the [ListStandardGroups](~~465940~~) operation to obtain the ID of the security rule set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '242***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '23****'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C5B8E84B-42B6-4374-AD5A-6264E1753378',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B8E84B-42B6-4374-AD5A-6264E1753325\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteStandardGroup',
+ 'description' => 'Before you call this API operation, make sure that the security rule set is not associated with an instance.'."\n",
+ ],
+ 'GetStandardGroup' => [
+ 'summary' => 'Queries the information about security rule sets of a tenant. The information includes the name and description of security rules, and instances associated with security rules.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '规则集ID，可通过 ListStandardGroups 获取',
+ 'description' => 'The security rule set ID. You can call the [ListStandardGroups](~~465940~~) operation to obtain the ID of the security rule set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '242***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '23****',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'BF7E9543-F431-566A-991A-B5C493EA36C2',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError'."\n",
+ ],
+ 'StandardGroup' => [
+ 'description' => 'The information about the security rule set.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => [
+ 'title' => '',
+ 'description' => 'The name of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc_test',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the security rule set.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'DbType' => [
+ 'description' => 'The engine type.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'LastMenderId' => [
+ 'description' => 'The ID of the user who last modified the security rules.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****',
+ ],
+ 'GroupMode' => [
+ 'description' => 'The control mode. Valid values:'."\n"
+ ."\n"
+ .'* **NONE_CONTROL**: Flexible Management'."\n"
+ .'* **STABLE**: Stable Change'."\n"
+ .'* **COMMON**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMON',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the security rule set.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF7E9543-F431-566A-991A-B5C493EA36C3\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\\\n\\",\\n \\"StandardGroup\\": {\\n \\"GroupName\\": \\"poc_test\\",\\n \\"Description\\": \\"生产环境测试规则\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"LastMenderId\\": 0,\\n \\"GroupMode\\": \\"COMMON\\",\\n \\"GroupId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'GetStandardGroup',
+ ],
+ 'AddDesensitizationRule' => [
+ 'summary' => 'Adds a masking rule.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the rule.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'desensitization algorithm test',
+ ],
+ ],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The masking algorithm.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* PLAINTEXT'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* TRANSFORM'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* ENCRYPT'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* REPLACE'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* HASH'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* MASK'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 'PLAINTEXT' => '',
+ 'TRANSFORM' => '',
+ 'ENCRYPT' => '',
+ 'REPLACE' => '',
+ 'HASH' => '',
+ 'MASK' => '',
+ ],
+ 'example' => 'HASH',
+ ],
+ ],
+ [
+ 'name' => 'RuleDescription',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'hash algorithm',
+ ],
+ ],
+ [
+ 'name' => 'FunctionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the masking algorithm.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* FIX_POS : masks characters in the specified position.'."\n"
+ .'* DATE_ROUNDING: rounds the date.'."\n"
+ .'* PLAINTEXT: does not mask data.'."\n"
+ .'* SHA1: masks characters by using the secure hash algorithm 1 (SHA-1)'."\n"
+ .'* HMAC: masks characters by using the hash-based message authentication code (HMAC).'."\n"
+ .'* STRING_TRANSFORM: shift characters.'."\n"
+ .'* NUMBER_ROUNDING: rounds numbers.'."\n"
+ .'* AES: masks characters by using the advanced encryption standard (AES) algorithm.'."\n"
+ .'* SHA256: masks characters by using SHA-256 algorithm.'."\n"
+ .'* DES: masks characters by using the data encryption standard (DES) algorithm.'."\n"
+ .'* MAP_REPLACE: masks the mapped data.'."\n"
+ .'* FIX_CHAR: masks fixed characters.'."\n"
+ .'* DEFAULT: masks all characters.'."\n"
+ .'* RANDOM_REPLACE: randomly replaces characters.'."\n"
+ .'* MD5: masks characters by using the MD5 algorithm.',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 'FIX_POS' => '',
+ 'DATE_ROUNDING' => '',
+ 'PLAINTEXT' => '',
+ 'SHA1' => 'SHA1',
+ 'HMAC' => 'HMAC',
+ 'STRING_TRANSFORM' => '',
+ 'NUMBER_ROUNDING' => '',
+ 'AES' => 'AES',
+ 'SHA256' => 'SHA256',
+ 'DES' => 'DES',
+ 'MAP_REPLACE' => '',
+ 'FIX_CHAR' => '',
+ 'DEFAULT' => '',
+ 'RANDOM_REPLACE' => '',
+ 'MD5' => 'MD5',
+ ],
+ 'example' => 'MD5',
+ ],
+ ],
+ [
+ 'name' => 'FunctionParams',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'description' => 'The parameters of the algorithm.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The value of the parameter.'."\n",
+ 'example' => '{paramName: salt, paramValue: 1}',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RuleId' => [
+ 'description' => 'The ID generated for the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '35***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"RuleId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<AddDesensitizationRuleResponse>\\n <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</AddDesensitizationRuleResponse>","errorExample":""}]',
+ 'title' => 'AddDesensitizationRule',
+ ],
+ 'ListDesensitizationRule' => [
+ 'summary' => 'Queries a list of masking rules.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. The maximum value is 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The algorithm used for masking.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'HASH',
+ ],
+ ],
+ [
+ 'name' => 'FuncType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the masking algorithm.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MD5',
+ ],
+ ],
+ [
+ 'name' => 'RuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the masking rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default desensitization rule test',
+ ],
+ ],
+ [
+ 'name' => 'RuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
+ 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233F8F2',
+ ],
+ 'ErrorCode' => [
+ 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DesensitizationRuleList' => [
+ 'description' => 'The list of masking rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'default desensitization rule test',
+ ],
+ 'RuleType' => [
+ 'description' => 'The algorithm used for masking.'."\n",
+ 'type' => 'string',
+ 'example' => 'HASH',
+ ],
+ 'RuleDesc' => [
+ 'description' => 'The description of the rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'hash desensitization algorithm',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The algorithm type.'."\n",
+ 'type' => 'string',
+ 'example' => 'MD5',
+ ],
+ 'FuncParams' => [
+ 'description' => 'The parameter.'."\n",
+ 'type' => 'string',
+ 'example' => '{paramName: salt, paramValue: 1}',
+ ],
+ 'FuncSample' => [
+ 'description' => 'The example.'."\n",
+ 'type' => 'string',
+ 'example' => '[{paramName: testStr, paramValue: 1}]',
+ ],
+ 'LastModifierId' => [
+ 'description' => 'The ID of the user who last modified the masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => '2',
+ ],
+ 'LastModifierName' => [
+ 'description' => 'The name of the user who last modified the masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'test user',
+ ],
+ 'ReferenceCount' => [
+ 'description' => 'The number of times that the masking was used.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RuleId' => [
+ 'description' => 'The ID of the masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '23',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233F8F2\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DesensitizationRuleList\\": [\\n {\\n \\"RuleName\\": \\"脱敏规则测试\\",\\n \\"RuleType\\": \\"HASH\\",\\n \\"RuleDesc\\": \\"哈希脱敏算法\\",\\n \\"FunctionType\\": \\"MD5\\",\\n \\"FuncParams\\": \\"{paramName: salt, paramValue: 1}\\",\\n \\"FuncSample\\": \\"[{paramName: testStr, paramValue: 1}]\\",\\n \\"LastModifierId\\": \\"2\\",\\n \\"LastModifierName\\": \\"测试用户\\",\\n \\"ReferenceCount\\": 1,\\n \\"RuleId\\": 23\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDesensitizationRuleResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>E76DD2E7-EBAC-5724-B163-19AAC233F8F2</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n <DesensitizationRuleList>\\n <RuleName>脱敏规则测试</RuleName>\\n <RuleType>HASH</RuleType>\\n <RuleDesc>哈希脱敏算法</RuleDesc>\\n <FunctionType>MD5</FunctionType>\\n <FuncParams>{paramName: salt, paramValue: 1}</FuncParams>\\n <FuncSample>[{paramName: testStr, paramValue: 1}]</FuncSample>\\n <LastModifierId>2</LastModifierId>\\n <LastModifierName>测试用户</LastModifierName>\\n <ReferenceCount>1</ReferenceCount>\\n <RuleId>23</RuleId>\\n </DesensitizationRuleList>\\n</ListDesensitizationRuleResponse>","errorExample":""}]',
+ 'title' => 'ListDesensitizationRule',
+ 'extraInfo' => "\n",
+ ],
+ 'ModifyDesensitizationStrategy' => [
+ 'summary' => 'Modifies the masking rule bound to a specified field.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. You can call the [ListDatabases](~~141873~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'IsLogic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a physical database.'."\n"
+ .'* **false**: The database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the database name.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the database is a physical database, you can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the database name.'."\n"
+ ."\n"
+ .'* If the database is a logical database, you can call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation to obtain the name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_schema',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the table name.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to obtain the table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the field name.'."\n"
+ ."\n"
+ .'> You can also call the [ListColumns](~~141870~~) operation to obtain the field name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'RuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '53',
+ ],
+ ],
+ [
+ 'name' => 'IsReset',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to reset the masking rule. Valid value:'."\n"
+ ."\n"
+ .'* **true**: Reset the masking rule.'."\n"
+ .'* **false**: Do not reset the masking rule. This is the default value.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'IsDefault',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The desensitization algorithm of the field setting. The default value is false. The values are as follows:'."\n"
+ ."\n"
+ .'- **true**: default desensitization algorithm.'."\n"
+ ."\n"
+ .'- **false** :semi-desensitization algorithm.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) in the topic "Manage DMS tenants."'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The status code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": false,\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyDesensitizationStrategyResponse>\\n <RequestId>283C461F-11D8-48AA-B695-DF092DA32AF3</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>false</Success>\\n <Result>true</Result>\\n</ModifyDesensitizationStrategyResponse>","errorExample":""}]',
+ 'title' => 'ModifyDesensitizationStrategy',
+ 'extraInfo' => "\n",
+ ],
+ 'ListClassificationTemplates' => [
+ 'summary' => 'Queries the classification templates.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '90260530-565C-42B9-A6E8-893481FE6AB6',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'TemplateList' => [
+ 'description' => 'The list of templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'title' => '分类分级模板ID',
+ 'description' => 'The ID of the classification template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3**',
+ ],
+ 'Name' => [
+ 'title' => '分类分级模板名称',
+ 'description' => 'The name of the classification template.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TemplateType' => [
+ 'title' => '分类分级模板类型'."\n"
+ .'- INNER：内置'."\n"
+ .'- USER_DEFINE：自定义',
+ 'description' => 'The type of the classification template. Valid values:'."\n"
+ ."\n"
+ .'* **INNER**: built-in template'."\n"
+ .'* **USER_DEFINE**: custom template'."\n",
+ 'type' => 'string',
+ 'example' => 'USER_DEFINE',
+ ],
+ 'Remark' => [
+ 'title' => '备注信息',
+ 'description' => 'The remarks.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"90260530-565C-42B9-A6E8-893481FE6AB6\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"TemplateList\\": [\\n {\\n \\"TemplateId\\": 0,\\n \\"Name\\": \\"test\\",\\n \\"TemplateType\\": \\"USER_DEFINE\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListClassificationTemplatesResponse>\\n <RequestId>90260530-565C-42B9-A6E8-893481FE6AB6</RequestId>\\n <Success>true</Success>\\n <TemplateList>\\n <Name>test</Name>\\n <TemplateType>USER_DEFINE</TemplateType>\\n <Remark>test</Remark>\\n </TemplateList>\\n</ListClassificationTemplatesResponse>","errorExample":""}]',
+ 'title' => 'ListClassificationTemplates',
+ ],
+ 'ListSensitiveDataAuditLog' => [
+ 'summary' => 'Queries the audit logs for sensitive information.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range for which you want to query the audit logs for sensitive information. Specify the time in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2022-11-18 10:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range for which you want to query the audit logs for sensitive information. Specify the time in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2022-11-18 11:00:00',
+ ],
+ ],
+ [
+ 'name' => 'ModuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The function module whose audit logs you want to query for sensitive data. If you do not specify this parameter, all audit logs are queried. Valid values:'."\n"
+ ."\n"
+ .'* **SQL_CONSOLE**: data query'."\n"
+ .'* **SQL_CONSOLE_EXPORT**: query result export'."\n"
+ .'* **DATA_CHANGE**: data change'."\n"
+ .'* **DATA_EXPORT**: data export'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SQL_CONSOLE',
+ ],
+ ],
+ [
+ 'name' => 'OpUserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The username of the requester.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ExampleOpUserName',
+ ],
+ ],
+ [
+ 'name' => 'DbName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database that stores the sensitive data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ExampleDbName',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table that stores the sensitive data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ExampleTableName',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the column that contains sensitive data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ExampleColumnName',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Example: 100'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '100',
+ 'default' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E0D21075-CD3E-4D98-8264-FD8AD04A63B6',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SensitiveDataAuditLogList' => [
+ 'description' => 'The audit logs for sensitive data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserName' => [
+ 'description' => 'The username of the requester.'."\n",
+ 'type' => 'string',
+ 'example' => 'ExampleUserName',
+ ],
+ 'UserId' => [
+ 'description' => 'The user ID of the requester.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1**',
+ ],
+ 'ModuleName' => [
+ 'description' => 'The name of the function module whose audit logs were queried.'."\n",
+ 'type' => 'string',
+ 'example' => 'SQL_CONSOLE',
+ ],
+ 'DbDisplayName' => [
+ 'description' => 'The name of the database that stores the sensitive data.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]:3306',
+ ],
+ 'OpTime' => [
+ 'description' => 'The time when the operation was performed. The time is in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-11-18 10:01:00',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'TargetName' => [
+ 'description' => 'The details of the object on which the operation was performed. The value of this parameter is in one of the following formats:'."\n"
+ ."\n"
+ .'* Object name - object ID'."\n"
+ .'* Object name (object ID)'."\n",
+ 'type' => 'string',
+ 'example' => 'Ticket - 1\\*\\*\\*\\*'."\n",
+ ],
+ 'SensitiveDataLog' => [
+ 'description' => 'The logs for sensitive data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table that stores the sensitive data.'."\n",
+ 'type' => 'string',
+ 'example' => 'ExampleTableName',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the column that contains sensitive data.'."\n",
+ 'type' => 'string',
+ 'example' => 'ExampleColumnName',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The sensitivity level of the data. Valid values:'."\n"
+ ."\n"
+ .'* **Low**'."\n"
+ .'* **Medium**'."\n"
+ .'* **High**'."\n",
+ 'type' => 'string',
+ 'example' => 'Low'."\n",
+ ],
+ 'ColumnPermissionType' => [
+ 'description' => 'The permission that the user has on the column. Valid values:'."\n"
+ ."\n"
+ .'* **No permission**'."\n"
+ .'* **Partial redaction**'."\n"
+ .'* **Plaintext**'."\n"
+ .'* **Change**'."\n"
+ .'* **Enable data masking**'."\n"
+ .'* **Disable data masking**'."\n",
+ 'type' => 'string',
+ 'example' => 'Change'."\n",
+ ],
+ 'DesensitizationRule' => [
+ 'description' => 'The algorithm used for data masking.'."\n",
+ 'type' => 'string',
+ 'example' => 'Default - Full redaction'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E0D21075-CD3E-4D98-8264-FD8AD04A63B6\\",\\n \\"TotalCount\\": 100,\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"SensitiveDataAuditLogList\\": [\\n {\\n \\"UserName\\": \\"ExampleUserName\\",\\n \\"UserId\\": 0,\\n \\"ModuleName\\": \\"SQL_CONSOLE\\",\\n \\"DbDisplayName\\": \\"[email protected]:3306\\",\\n \\"OpTime\\": \\"2022-11-18 10:01:00\\",\\n \\"InstanceId\\": 0,\\n \\"TargetName\\": \\"工单 - 1****\\",\\n \\"SensitiveDataLog\\": [\\n {\\n \\"TableName\\": \\"ExampleTableName\\",\\n \\"ColumnName\\": \\"ExampleColumnName\\",\\n \\"SecurityLevel\\": \\"低敏感\\",\\n \\"ColumnPermissionType\\": \\"变更权限\\",\\n \\"DesensitizationRule\\": \\"系统默认-全遮掩\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSensitiveDataAuditLogResponse>\\n <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>\\n <TotalCount>100</TotalCount>\\n <Success>true</Success>\\n <SensitiveDataAuditLogList>\\n <UserName>ExampleUserName</UserName>\\n <ModuleName>SQL_CONSOLE</ModuleName>\\n <DbDisplayName>[email protected]:3306</DbDisplayName>\\n <OpTime>2022-11-18 10:01:00</OpTime>\\n <TargetName>工单 - 1****</TargetName>\\n <SensitiveDataLog>\\n <TableName>ExampleTableName</TableName>\\n <ColumnName>ExampleColumnName</ColumnName>\\n <SecurityLevel>低敏感</SecurityLevel>\\n <ColumnPermissionType>变更权限</ColumnPermissionType>\\n <DesensitizationRule>系统默认-全遮掩</DesensitizationRule>\\n </SensitiveDataLog>\\n </SensitiveDataAuditLogList>\\n</ListSensitiveDataAuditLogResponse>","errorExample":""}]',
+ 'title' => 'ListSensitiveDataAuditLog',
+ ],
+ 'ListSensitiveColumns' => [
+ 'summary' => 'Queries sensitive fields in a table of a database.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. You can call the [SearchDatabase](~~141876~~) operation to query the name of the database.'."\n"
+ ."\n"
+ .'> You can also call the [ListDatabases](~~141873~~) operation to query the name of a physical database and the [ListLogicDatabases](~~141874~~) operation to query the name of a logical database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test_schema',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListTables](~~141878~~) operation to query the ID of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. You can call the [ListColumns](~~141870~~) operation to query the name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'SecurityLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sensitivity level of the field. Valid values:'."\n"
+ ."\n"
+ .'* SENSITIVE: medium sensitivity level'."\n"
+ .'* CONFIDENTIAL: high sensitivity level'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SENSITIVE',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabase](~~141876~~) operation to query the ID of the database.'."\n"
+ ."\n"
+ .'> You can also call the [ListDatabases](~~141873~~) operation to query the ID of the physical database and the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1860',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* true: The database is a logical database.'."\n"
+ .'* false: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of returned entries.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '09D82FD7-F87F-59EF-AA82-AEF71B09E306',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'SensitiveColumnList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SensitiveColumn' => [
+ 'description' => 'The sensitive fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_column',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_table',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The sensitivity level of the field. Valid values:'."\n"
+ ."\n"
+ .'* SENSITIVE'."\n"
+ .'* CONFIDENTIAL'."\n",
+ 'type' => 'string',
+ 'example' => 'SENSITIVE',
+ ],
+ 'ColumnCount' => [
+ 'description' => 'The number of sensitive fields.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_schema',
+ ],
+ 'FunctionType' => [
+ 'description' => 'The type of the de-identification algorithm. Valid values:'."\n"
+ ."\n"
+ .'* DEFAULT: All characters are masked. This is the default value.'."\n"
+ .'* FIX_POS: The characters at specific positions are masked.'."\n"
+ .'* FIX_CHAR: Specific characters are masked.'."\n",
+ 'type' => 'string',
+ 'example' => 'DEFAULT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"09D82FD7-F87F-59EF-AA82-AEF71B09E306\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"SensitiveColumnList\\": {\\n \\"SensitiveColumn\\": [\\n {\\n \\"ColumnName\\": \\"test_column\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"SecurityLevel\\": \\"SENSITIVE\\",\\n \\"ColumnCount\\": 1,\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"FunctionType\\": \\"DEFAULT\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListSensitiveColumnsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>09D82FD7-F87F-59EF-AA82-AEF71B09E306</RequestId>\\n <SensitiveColumnList>\\n <ColumnName>test_column</ColumnName>\\n <TableName>test_table</TableName>\\n <SecurityLevel>SENSITIVE</SecurityLevel>\\n <ColumnCount>1</ColumnCount>\\n <SchemaName>test_schema</SchemaName>\\n <FunctionType>DEFAULT</FunctionType>\\n </SensitiveColumnList>\\n <Success>true</Success>\\n</ListSensitiveColumnsResponse>","errorExample":""}]',
+ 'title' => 'ListSensitiveColumns',
+ ],
+ 'ListSensitiveColumnsDetail' => [
+ 'summary' => 'Queries the details of a sensitive field.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the database.'."\n"
+ ."\n"
+ .'> * You can also call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the name of a physical database.'."\n"
+ .'> * You can also call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation to obtain the name of a logical database.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'SchemaName_test',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the table.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to obtain the name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the field.'."\n"
+ ."\n"
+ .'> You can also call the [ListColumns](~~141870~~) operation to obtain the name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ColumnName_test',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* To obtain the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To obtain the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1860****',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7629888F-C9FB-4D16-A7D3-B443FE06FBD4',
+ ],
+ 'SensitiveColumnsDetailList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SensitiveColumnsDetail' => [
+ 'description' => 'The details of the sensitive field.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1860****',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'ColumnName_test',
+ ],
+ 'ColumnDescription' => [
+ 'description' => 'The description of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'DbType' => [
+ 'description' => 'The type of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'varchar(32)',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database.'."\n"
+ .'* **false**: The database is not a logical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'SchemaName_test',
+ ],
+ 'SearchName' => [
+ 'description' => 'The name that is used to search for the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test@xxx:3306',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7629888F-C9FB-4D16-A7D3-B443FE06FBD4\\",\\n \\"SensitiveColumnsDetailList\\": {\\n \\"SensitiveColumnsDetail\\": [\\n {\\n \\"DbId\\": 0,\\n \\"ColumnName\\": \\"ColumnName_test\\",\\n \\"ColumnDescription\\": \\"test\\",\\n \\"TableName\\": \\"test\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"ColumnType\\": \\"varchar(32)\\",\\n \\"Logic\\": false,\\n \\"SchemaName\\": \\"SchemaName_test\\",\\n \\"SearchName\\": \\"test@xxx:3306\\",\\n \\"EnvType\\": \\"product\\"\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListSensitiveColumnsDetailResponse>\\n <RequestId>7629888F-C9FB-4D16-A7D3-B443FE06FBD4</RequestId>\\n <SensitiveColumnsDetailList>\\n <ColumnName>ColumnName_test</ColumnName>\\n <ColumnDescription>test</ColumnDescription>\\n <TableName>test</TableName>\\n <DbType>mysql</DbType>\\n <ColumnType>varchar(32)</ColumnType>\\n <Logic>false</Logic>\\n <SchemaName>SchemaName_test</SchemaName>\\n <SearchName>test@xxx:3306</SearchName>\\n <EnvType>product</EnvType>\\n </SensitiveColumnsDetailList>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</ListSensitiveColumnsDetailResponse>","errorExample":""}]',
+ 'title' => 'ListSensitiveColumnsDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ChangeColumnSecLevel' => [
+ 'summary' => 'Adjusts the sensitivity level of fields.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '43253',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database. You can call the [SearchDatabase](~~141876~~) operation to obtain the ID of the database.'."\n"
+ ."\n"
+ .'> You can also call the [ListDatabases](~~141873~~) operation to obtain the ID of a physical database and the [ListLogicDatabases](~~141874~~) operation to obtain the ID of a logical database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '325',
+ ],
+ ],
+ [
+ 'name' => 'IsLogic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* true: The database is a physical database.'."\n"
+ .'* false: The database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the database.'."\n"
+ ."\n"
+ .'* You can also call the [SearchDatabase](~~141876~~) operation to obtain the name of the database.'."\n"
+ .'* You can also call the [ListDatabases](~~141873~~) operation to obtain the name of a physical database and the [ListLogicDatabases](~~141874~~) operation to obtain the name of a logical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_schema',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the table.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to obtain the name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. You can call the [ListSensitiveColumns](~~188103~~) operation to obtain the name of the field.'."\n"
+ ."\n"
+ .'> You can also call the [ListColumns](~~141870~~) operation to obtain the name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'NewLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '新的敏感等级',
+ 'description' => 'The new sensitivity level of the field that you want to specify. Valid values:'."\n"
+ ."\n"
+ .'* INNER: low sensitivity level'."\n"
+ .'* SENSITIVE: medium sensitivity level'."\n"
+ .'* CONFIDENTIAL: high sensitivity level'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SENSITIVE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<ChangeColumnSecLevelResponse>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <Success>false</Success>\\n</ChangeColumnSecLevelResponse>","errorExample":""}]',
+ 'title' => 'ChangeColumnSecLevel',
+ ],
+ 'ChangeColumnSecurityLevel' => [
+ 'summary' => 'Changes the security level of a column.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10****',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID. The database can be a physical database or a logical database.'."\n"
+ ."\n"
+ .'* The ID of a physical database: You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the physical database ID.'."\n"
+ .'* To obtain the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '325**',
+ ],
+ ],
+ [
+ 'name' => 'IsLogic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name. You can call the [ListSensitiveColumns](~~188103~~) or [SearchDatabase](~~141876~~) operation to query the database name.'."\n"
+ ."\n"
+ .'> You can call the [ListDatabases](~~141873~~) operation to query the name of a physical database and call the [ListLogicDatabases](~~141874~~) operation to query the name of a logical database.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_schema',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListSensitiveColumns](~~188103~~) or [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field. You can call the [ListSensitiveColumns](~~188103~~) or [ListColumns](~~141870~~) operation to query the column name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'NewSensitivityLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new security level of the column. The valid values are the same as the sensitivity levels of the classification template that is associated with the instance. You can call the [ListSensitivityLevel](~~2539519~~) operation to obtain the sensitivity levels of the classification template.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'S2',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E103C5F9-DE47-53F2-BF34-D71DF38F****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E103C5F9-DE47-53F2-BF34-D71DF38F****\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ChangeColumnSecurityLevel',
+ ],
+ 'GetClassificationTemplate' => [
+ 'summary' => 'Queries the information about the classification and grading template associated with an instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '169****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '23***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ClassificationResourceTemplateMap' => [
+ 'description' => 'The information about the classification template that is associated to the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'description' => 'The ID of the classification and grading template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ 'TemplateType' => [
+ 'description' => 'The type of the classification and grading template. Valid values:'."\n"
+ ."\n"
+ .'* **INNER**: a built-in template.'."\n"
+ .'* **USER_DEFINE**: a custom template.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'USER_DEFINE' => 'USER_DEFINE',
+ 'INNER' => 'INNER',
+ ],
+ 'example' => 'INNER',
+ ],
+ 'ResourceId' => [
+ 'description' => 'The ID of the resource. The supported resource type is INSTANCE. The resource ID corresponds to the value of InstanceId. You can call the [ListInstances](~~141936~~) operation to obtain the value of InstanceId.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24****',
+ ],
+ 'ResourceType' => [
+ 'description' => 'The resource type. The value is fixed as **INSTANCE**.'."\n",
+ 'type' => 'string',
+ 'example' => 'INSTANCE',
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ClassificationResourceTemplateMap\\": {\\n \\"TemplateId\\": 0,\\n \\"TemplateType\\": \\"INNER\\",\\n \\"ResourceId\\": 0,\\n \\"ResourceType\\": \\"INSTANCE\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GetClassificationTemplate',
+ ],
+ 'ListSensitivityLevel' => [
+ 'summary' => 'Queries the sensitivity levels of a classification template.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~) in the topic "Manage DMS tenants."'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '20***',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the ID of the classification template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '15**',
+ ],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the classification template. You can call the [ListClassificationTemplates](~~460613~~) operation to query the type of the classification template.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* USER_DEFINE: a custom template.'."\n"
+ .'* INNER: a built-in template.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'USER_DEFINE' => '',
+ 'INNER' => '',
+ ],
+ 'example' => 'INNER',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The status code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'SensitivityLevelList' => [
+ 'description' => 'The sensitivity levels.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the sensitive level.'."\n",
+ 'type' => 'string',
+ 'example' => 'S2',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the classification template.'."\n",
+ 'type' => 'string',
+ 'example' => '1070',
+ ],
+ 'TemplateType' => [
+ 'description' => 'The type of the classification template. Valid values:'."\n"
+ ."\n"
+ .'* **INNER**: a built-in template.'."\n"
+ .'* **USER_DEFINE**: a custom template.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'USER_DEFINE' => '',
+ 'INNER' => '',
+ ],
+ 'example' => 'INNER',
+ 'enum' => [
+ 'INNER',
+ 'USER_DEFINE',
+ ],
+ ],
+ 'IsPlain' => [
+ 'description' => 'Indicates whether the fields of the sensitive level are displayed in plaintext.',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'true' => 'true',
+ 'false' => 'false',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"SensitivityLevelList\\": [\\n {\\n \\"Name\\": \\"S2\\",\\n \\"TemplateId\\": \\"1070\\",\\n \\"TemplateType\\": \\"INNER\\",\\n \\"IsPlain\\": true\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListSensitivityLevel',
+ ],
+ 'ListSensitiveColumnInfo' => [
+ 'summary' => 'Queries the information about a sensitive field. The information includes the masking algorithm ID, masking algorithm name, and field security level.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '217034',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsG96PX9',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the instance. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '183****',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name. You can also call the [SearchDatabase](~~141876~~) operation to query the name of the database.'."\n"
+ ."\n"
+ .'> You can also call the [ListDatabases](~~141873~~) operation to query the value of the SchemaName parameter of a physical database, or the [ListLogicDatabases](~~141874~~) operation to query the value of the SchemaName parameter of a logical database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_schema',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListSensitiveColumns](~~188103~~) operation to query the table name.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the sensitive field. You can call the [ListSensitiveColumns](~~188103~~) operation to query the name of the sensitive field.'."\n"
+ ."\n"
+ .'> You can also call the [ListColumns](~~141870~~) operation to query the name of the sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_column',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'SensitiveColumnList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SensitiveColumn' => [
+ 'description' => 'The details of the sensitive field.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '183****',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_schema',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_table',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the sensitive field.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_column',
+ ],
+ 'CategoryName' => [
+ 'description' => 'The name of the category.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'IsPlain' => [
+ 'description' => 'Indicates whether the sensitive field is displayed in plaintext.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'False',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The sensitivity level of the field. Valid values:'."\n"
+ ."\n"
+ .'* Low'."\n"
+ .'* Medium'."\n"
+ .'* High'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'UserSensitivityLevel' => [
+ 'description' => 'The user-defined sensitivity level.'."\n",
+ 'type' => 'string',
+ 'example' => 'S1',
+ ],
+ 'SampleData' => [
+ 'description' => 'The sample data.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'DefaultDesensitizationRule' => [
+ 'description' => 'The information about the default masking algorithm.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => [
+ 'description' => 'The masking algorithm ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '101**',
+ ],
+ 'RuleName' => [
+ 'description' => 'The masking algorithm name.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'SemiDesensitizationRuleList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SemiDesensitizationRule' => [
+ 'description' => 'The list of partial masking algorithms.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the partial masking algorithm.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => [
+ 'description' => 'The ID of the partial masking algorithm.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10***',
+ ],
+ 'RuleName' => [
+ 'description' => 'The partial masking algorithm name.'."\n",
+ 'type' => 'string',
+ 'example' => 'test01',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries that are returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"SensitiveColumnList\\": {\\n \\"SensitiveColumn\\": [\\n {\\n \\"InstanceId\\": 0,\\n \\"SchemaName\\": \\"test_schema\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"ColumnName\\": \\"test_column\\",\\n \\"CategoryName\\": \\"默认分类\\",\\n \\"IsPlain\\": true,\\n \\"SecurityLevel\\": \\"低\\",\\n \\"UserSensitivityLevel\\": \\"S1\\",\\n \\"SampleData\\": \\"西安市\\",\\n \\"DefaultDesensitizationRule\\": {\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"test\\"\\n },\\n \\"SemiDesensitizationRuleList\\": {\\n \\"SemiDesensitizationRule\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"test01\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"TotalCount\\": 1\\n}","type":"json"}]',
+ 'title' => 'ListSensitiveColumnInfo',
+ ],
+ 'CreateProxy' => [
+ 'summary' => 'Enables the secure access proxy feature for a database instance.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '43589',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKBRCZC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database instance. You can call the [ListInstances](https://www.alibabacloud.com/help/en/data-management-service/latest/listinstances) or [GetInstance](https://www.alibabacloud.com/help/en/data-management-service/latest/getinstance) operation to query the database instance ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '183****',
+ ],
+ ],
+ [
+ 'name' => 'Username',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The username of the database account.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'username',
+ ],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the database account.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '******',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '4FFD154E-F57F-5374-B568-D6276F15****',
+ ],
+ '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',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'the instance proxy already exists.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'ProxyId' => [
+ 'description' => 'The ID of the secure access proxy.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4**',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4FFD154E-F57F-5374-B568-D6276F15****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"实例代理已存在\\",\\n \\"ErrorCode\\": \\"InvalidParameterValid\\",\\n \\"ProxyId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateProxyResponse>\\n <RequestId>4FFD154E-F57F-5374-B568-D6276F15****</RequestId>\\n <ProxyId>4**</ProxyId>\\n <Success>true</Success>\\n</CreateProxyResponse>","errorExample":""}]',
+ 'title' => 'CreateProxy',
+ 'description' => '- The database instance runs the MySQL or MariaDB database engine. For example, the database instance can be an ApsaraDB RDS for MySQL instance, a PolarDB for MySQL cluster, a Distributed Relational Database Service (DRDS) cluster, or an AnalyticDB for MySQL cluster. The database instance can also be a self-managed MySQL or MariaDB database, or a MySQL or MariaDB database in a third-party cloud.'."\n"
+ .'- The database instance resides in the China (Hangzhou) or China (Beijing) region.'."\n"
+ .'- You are a Data Management (DMS) administrator, a database administrator (DBA), or the owner of the database instance.',
+ ],
+ 'DeleteProxy' => [
+ 'summary' => 'You can call this operation to disable the data security protection proxy of a DB instance.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security protection agent. You can call the [ListProxies](https://www.alibabacloud.com/help/en/data-management-service/latest/listproxies) or [GetProxy](https://www.alibabacloud.com/help/en/data-management-service/latest/getproxy) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) or [ListUserTenants](https://www.alibabacloud.com/help/en/data-management-service/latest/listusertenants) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned to the query task.',
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProxyResponse>\\n <RequestId>EEC84F7F-E60E-5513-8DE6-F22EF368BD4D</RequestId>\\n <Success>true</Success>\\n</DeleteProxyResponse>","errorExample":""}]',
+ 'title' => 'DeleteProxy',
+ 'description' => 'After you disable this feature, your DB instance loses the JDBC protocol. All authorization information is recycled.',
+ ],
+ 'ListProxies' => [
+ 'summary' => 'Queries the proxies that are generated by the secure access proxy feature.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5812180E-555F-5F90-BE4F-280576F4****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'User can not access to Tenant [123445]',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ProxyList' => [
+ 'description' => 'The proxies that are generated by the secure access proxy feature.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The proxy that is generated by the secure access proxy feature.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ProxyId' => [
+ 'description' => 'The ID of the secure access proxy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4**',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who enabled the secure access proxy feature.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'CreatorName' => [
+ 'description' => 'The nickname of the user who enabled the secure access proxy feature.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '183****',
+ ],
+ 'PrivateEnable' => [
+ 'description' => 'Indicates whether the internal endpoint is enabled. Default value: **true**.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PrivateHost' => [
+ 'description' => 'The internal endpoint.'."\n",
+ 'type' => 'string',
+ 'example' => 'dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com',
+ ],
+ 'PublicEnable' => [
+ 'description' => 'Indicates whether the public endpoint is enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The public endpoint is enabled.'."\n"
+ .'* **false**: The public endpoint is disabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'PublicHost' => [
+ 'description' => 'The public endpoint. A public endpoint is returned no matter whether the public endpoint is enabled or disabled.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the value of the PublicEnable parameter is **true**, a valid public endpoint that can be resolved by using Alibaba Cloud DNS (DNS) is returned.'."\n"
+ ."\n"
+ .'* If the value of the PublicEnable parameter is **false**, an invalid public endpoint that cannot be resolved by using DNS is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com',
+ ],
+ 'HttpsPort' => [
+ 'description' => 'The number of the port that was used by HTTPS clients to connect to the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '443',
+ ],
+ 'ProtocolType' => [
+ 'title' => '数据库协议类型，例如：MYSQL',
+ 'description' => 'The type of the database. Example: MYSQL.'."\n",
+ 'type' => 'string',
+ 'example' => 'MYSQL',
+ ],
+ 'ProtocolPort' => [
+ 'title' => '数据库协议连接端口号',
+ 'description' => 'The number of the port that is used to connect the database instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'RegionId' => [
+ 'title' => '区域',
+ 'description' => 'The ID of the region.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5812180E-555F-5F90-BE4F-280576F4****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"User can not access to Tenant [123445]\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ProxyList\\": [\\n {\\n \\"ProxyId\\": 0,\\n \\"CreatorId\\": 0,\\n \\"CreatorName\\": \\"test_name\\",\\n \\"InstanceId\\": 0,\\n \\"PrivateEnable\\": true,\\n \\"PrivateHost\\": \\"dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com\\",\\n \\"PublicEnable\\": false,\\n \\"PublicHost\\": \\"dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com\\",\\n \\"HttpsPort\\": 443,\\n \\"ProtocolType\\": \\"MYSQL\\",\\n \\"ProtocolPort\\": 3306,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProxiesResponse>\\n <ProxyList>\\n <PublicHost>dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com</PublicHost>\\n <PrivateHost>dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com</PrivateHost>\\n <InstanceId>183****</InstanceId>\\n <ProxyId>4**</ProxyId>\\n <CreatorId>12****</CreatorId>\\n <MysqlPort>3306</MysqlPort>\\n <PrivateEnable>true</PrivateEnable>\\n <CreatorName>test_name</CreatorName>\\n <PublicEnable>false</PublicEnable>\\n <HttpsPort>443</HttpsPort>\\n </ProxyList>\\n <ProxyList>\\n <PublicHost>dphzmy-vwjxfkclz17bb7y****.proxy.dms.aliyuncs.com</PublicHost>\\n <PrivateHost>dphzmy-vwjxfkclz17b****.proxy.dms.aliyuncs.com</PrivateHost>\\n <InstanceId>164****</InstanceId>\\n <ProxyId>4*</ProxyId>\\n <CreatorId>47****</CreatorId>\\n <MysqlPort>3306</MysqlPort>\\n <PrivateEnable>true</PrivateEnable>\\n <CreatorName>test1_name</CreatorName>\\n <PublicEnable>true</PublicEnable>\\n <HttpsPort>443</HttpsPort>\\n </ProxyList>\\n <RequestId>5812180E-555F-5F90-BE4F-280576F4****</RequestId>\\n <Success>true</Success>\\n</ListProxiesResponse>","errorExample":""}]',
+ 'title' => 'ListProxies',
+ ],
+ 'GetProxy' => [
+ 'summary' => 'Queries the details of a secure access proxy.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the secure access proxy. You can call the [ListProxies](~~295371~~) operation to query the ID of the secure access proxy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '4**',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F49D4598-2B3C-5723-865E-2CCB818E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'The condition cannot be empty!',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ProxyId' => [
+ 'description' => 'The ID of the secure access proxy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4**',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who enabled the secure access proxy feature.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'CreatorName' => [
+ 'description' => 'The nickname of the user who enabled the secure access proxy feature.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '183****',
+ ],
+ 'PrivateEnable' => [
+ 'description' => 'Indicates whether the internal endpoint was enabled. Default value: **true**.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PrivateHost' => [
+ 'description' => 'The internal endpoint.'."\n",
+ 'type' => 'string',
+ 'example' => 'dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com',
+ ],
+ 'PublicEnable' => [
+ 'description' => 'Indicates whether the public endpoint was enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The public endpoint was enabled.'."\n"
+ .'* **false**: The public endpoint was disabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'PublicHost' => [
+ 'description' => 'The public endpoint. A public endpoint is returned no matter whether the public endpoint is enabled or disabled.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the value of the PublicEnable parameter is **true**, a valid public endpoint that can be resolved by using Alibaba Cloud DNS is returned.'."\n"
+ ."\n"
+ .'* If the value of the PublicEnable parameter is **false**, an invalid public endpoint that cannot be resolved by using Alibaba Cloud DNS is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com',
+ ],
+ 'HttpsPort' => [
+ 'description' => 'The port number used by the HTTPS protocol.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '443',
+ ],
+ 'ProtocolType' => [
+ 'title' => '数据库协议类型，例如：MYSQL',
+ 'description' => 'The protocol type of the database. Example: MYSQL.'."\n",
+ 'type' => 'string',
+ 'example' => 'MYSQL',
+ ],
+ 'ProtocolPort' => [
+ 'title' => '数据库协议连接端口号',
+ 'description' => 'The port number used by the protocol.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3306',
+ ],
+ 'RegionId' => [
+ 'title' => '区域',
+ 'description' => 'The ID of the region in which the instance resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F49D4598-2B3C-5723-865E-2CCB818E****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The condition cannot be empty!\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ProxyId\\": 0,\\n \\"CreatorId\\": 0,\\n \\"CreatorName\\": \\"test_name\\",\\n \\"InstanceId\\": 0,\\n \\"PrivateEnable\\": true,\\n \\"PrivateHost\\": \\"dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com\\",\\n \\"PublicEnable\\": true,\\n \\"PublicHost\\": \\"dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com\\",\\n \\"HttpsPort\\": 443,\\n \\"ProtocolType\\": \\"MYSQL\\",\\n \\"ProtocolPort\\": 3306,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProxyResponse>\\n <PublicHost>dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com</PublicHost>\\n <PrivateHost>dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com</PrivateHost>\\n <RequestId>F49D4598-2B3C-5723-865E-2CCB818E****</RequestId>\\n <InstanceId>183****</InstanceId>\\n <ProxyId>4**</ProxyId>\\n <CreatorId>12****</CreatorId>\\n <Success>true</Success>\\n <MysqlPort>3306</MysqlPort>\\n <CreatorName>test_name</CreatorName>\\n <HttpsPort>443</HttpsPort>\\n</GetProxyResponse>","errorExample":""}]',
+ 'title' => 'GetProxy',
+ ],
+ 'CreateProxyAccess' => [
+ 'summary' => 'Grants a user the permissions to access a database instance by using the secure access proxy feature.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '43700',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKBRCZC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [ListUsers](https://www.alibabacloud.com/help/en/data-management-service/latest/listusers) or [GetUser](https://www.alibabacloud.com/help/en/data-management-service/latest/getuser) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ProxyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security protection agent. You can call the [ListProxies](https://www.alibabacloud.com/help/en/data-management-service/latest/listproxies) or [GetProxy](https://www.alibabacloud.com/help/en/data-management-service/latest/getproxy) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'IndepAccount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database account.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xxx',
+ ],
+ ],
+ [
+ 'name' => 'IndepPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password that is used to log on to the database.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xxx',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) or [ListUserTenants](https://www.alibabacloud.com/help/en/data-management-service/latest/listusertenants) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned to the query task.',
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'ProxyAccessId' => [
+ 'description' => 'The ID of the security protection authorization. After the security protection agent authorizes the target user, the system automatically generates a security protection authorization ID. The ID is globally unique.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"ProxyAccessId\\": 1\\n}","errorExample":""},{"type":"xml","example":"<CreateProxyAccessResponse>\\n <RequestId>22A0495C-566D-5A90-A51A-7E737AD5980A</RequestId>\\n <ProxyAccessId>1</ProxyAccessId>\\n <Success>true</Success>\\n</CreateProxyAccessResponse>","errorExample":""}]',
+ 'title' => 'CreateProxyAccess',
+ 'description' => '- The data security protection feature is enabled for the instance.'."\n"
+ .'- Your user role is the administrator role, DBA role, or the owner of data security protection for the current instance.',
+ ],
+ 'DeleteProxyAccess' => [
+ 'summary' => 'Revokes the permissions to access a database instance by using the secure access proxy feature from a user.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '43701',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKBRCZC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyAccessId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security protection authorization. After the security protection agent authorizes the target user, the system automatically generates a security protection authorization ID. The ID is globally unique. You can call the [ListProxyAccesses](https://www.alibabacloud.com/help/en/data-management-service/latest/listproxyaccesses) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) or [ListUserTenants](https://www.alibabacloud.com/help/en/data-management-service/latest/listusertenants) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned to the query task.',
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProxyAccessResponse>\\n <RequestId>7640A4CB-B988-5CDB-B428-11952D7E7682</RequestId>\\n <Success>true</Success>\\n</DeleteProxyAccessResponse>","errorExample":""}]',
+ 'title' => 'DeleteProxyAccess',
+ ],
+ 'ListProxyAccesses' => [
+ 'summary' => 'Queries information about users that are authorized to access a database instance by using the secure access proxy feature.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the secure access proxy. '."\n"
+ ."\n"
+ .'> You can call the [ListProxies](https://www.alibabacloud.com/help/en/data-management-service/latest/listproxies) operation to query the ID of the secure access proxy.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '47',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. '."\n"
+ ."\n"
+ .'> You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) operation to query the ID of the tenant.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'E53D178A-85E9-5E1F-88B6-3CB1FCF2****',
+ ],
+ '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',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.',
+ 'type' => 'string',
+ 'example' => 'ProxyId is mandatory for this action.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'MissingProxyId',
+ ],
+ 'ProxyAccessList' => [
+ 'description' => 'The information about the users that are authorized to access the database instance by using the secure access proxy feature.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProxyAccessId' => [
+ 'description' => 'The ID that DMS generates after the user is authorized to access the database instance by using the secure access proxy feature. The ID is unique in DMS.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '****',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the user is authorized to access the database instance by using the secure access proxy feature.',
+ 'type' => 'string',
+ 'example' => '2021-03-31 10:34:18',
+ ],
+ 'AccessId' => [
+ 'description' => 'The username of the database account that is authorized to access the database instance by using the secure access proxy feature.',
+ 'type' => 'string',
+ 'example' => 'MXPL8HalI22m****',
+ ],
+ 'OriginInfo' => [
+ 'description' => 'The method that is used to authorize the user to access the database instance by using the secure access proxy feature. Valid values: '."\n"
+ ."\n"
+ .'- **Authorization by the Alibaba Cloud Account ()**: The information in the parentheses () indicates the user ID (UID) of the Alibaba Cloud account.'."\n"
+ .'- **Authorization by submitting the ticket ()**:The information in the parentheses () indicates the number of the ticket that the user submits to apply for permissions.',
+ 'type' => 'string',
+ 'example' => 'Authorization by the Alibaba Cloud Account(29490401597700****)',
+ ],
+ 'IndepAccount' => [
+ 'description' => 'The username of the independent database account.',
+ 'type' => 'string',
+ 'example' => '****',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '26****',
+ ],
+ 'UserUid' => [
+ 'description' => 'The UID of the Alibaba Cloud account.',
+ 'type' => 'string',
+ 'example' => '25936669186260****',
+ ],
+ 'UserName' => [
+ 'description' => 'The nickname of the user.',
+ 'type' => 'string',
+ 'example' => 'user',
+ ],
+ 'ProxyId' => [
+ 'description' => 'The ID of the secure access proxy.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '47',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the database instance.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '164****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E53D178A-85E9-5E1F-88B6-3CB1FCF2****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"ProxyId is mandatory for this action.\\",\\n \\"ErrorCode\\": \\"MissingProxyId\\",\\n \\"ProxyAccessList\\": [\\n {\\n \\"ProxyAccessId\\": 0,\\n \\"GmtCreate\\": \\"2021-03-31 10:34:18\\",\\n \\"AccessId\\": \\"MXPL8HalI22m****\\",\\n \\"OriginInfo\\": \\"责任人授权（29490401597700****）\\",\\n \\"IndepAccount\\": \\"****\\",\\n \\"UserId\\": 0,\\n \\"UserUid\\": \\"25936669186260****\\",\\n \\"UserName\\": \\"user\\",\\n \\"ProxyId\\": 47,\\n \\"InstanceId\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProxyAccessesResponse>\\n <RequestId>E53D178A-85E9-5E1F-88B6-3CB1FCF2****</RequestId>\\n <Success>true</Success>\\n <ProxyAccessList>\\n <GmtCreate>2021-03-31 10:34:18</GmtCreate>\\n <UserName>user</UserName>\\n <AccessId>MXPL8HalI22m****</AccessId>\\n <InstanceId>164****</InstanceId>\\n <UserId>26****</UserId>\\n <UserUid>25936669186260****</UserUid>\\n <ProxyId>47</ProxyId>\\n <ProxyAccessId>**</ProxyAccessId>\\n <OriginInfo>责任人授权(29490401597700****)</OriginInfo>\\n </ProxyAccessList>\\n <ProxyAccessList>\\n <GmtCreate>2021-03-30 10:44:15</GmtCreate>\\n <UserName>user1</UserName>\\n <AccessId>8t1RshbwmWOQ****</AccessId>\\n <InstanceId>164****</InstanceId>\\n <UserId>47****</UserId>\\n <UserUid>188097248834****</UserUid>\\n <ProxyId>47</ProxyId>\\n <ProxyAccessId>**</ProxyAccessId>\\n <OriginInfo>责任人授权(29490401597700****)</OriginInfo>\\n </ProxyAccessList>\\n</ListProxyAccessesResponse>","errorExample":""}]',
+ 'title' => 'ListProxyAccesses',
+ ],
+ 'InspectProxyAccessSecret' => [
+ 'summary' => 'You can call this operation to obtain the authorization password of the security protection agent InspectProxyAccessSecret.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyAccessId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security protection authorization. After the security protection agent authorizes the target user, the system automatically generates a security protection authorization ID. The ID is globally unique. You can call the [ListProxyAccesses](https://www.alibabacloud.com/help/en/data-management-service/latest/listproxyaccesses) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](https://www.alibabacloud.com/help/en/data-management-service/latest/getuseractivetenant) or [ListUserTenants](https://www.alibabacloud.com/help/en/data-management-service/latest/listusertenants) operation to obtain this parameter.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned to the query task.',
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'AccessSecret' => [
+ 'description' => 'The authorization password of the security protection agent.',
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"AccessSecret\\": \\"xxx\\"\\n}","errorExample":""},{"type":"xml","example":"<InspectProxyAccessSecretResponse>\\n <AccessSecret>nxxxxxxuxxxxxxxi</AccessSecret>\\n <RequestId>E6F2971A-CDCC-5451-86EB-328868715619</RequestId>\\n <Success>true</Success>\\n</InspectProxyAccessSecretResponse>","errorExample":""}]',
+ 'title' => 'InspectProxyAccessSecret',
+ ],
+ 'GetProxyAccess' => [
+ 'summary' => 'Queries the authorization information about the secure access proxy feature.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProxyAccessId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID that Data Management (DMS) generates after the user is authorized to enable the secure access proxy feature for an instance. The ID is unique in DMS. You can call the [ListProxyAccesses](~~295386~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The schema of the response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '3CDB8601-AD74-4A47-8114-08E08CD6****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified user not exists.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UserNotExist',
+ ],
+ 'ProxyAccess' => [
+ 'description' => 'The authorization information about the secure access proxy feature.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ProxyAccessId' => [
+ 'description' => 'The ID that DMS generates after the user is authorized to enable the secure access proxy feature for an instance. The ID is unique in DMS. You can call the [ListProxyAccesses](~~295386~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2002',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the user is authorized to enable the secure access proxy feature for an instance.'."\n",
+ 'type' => 'string',
+ 'example' => '1643034647',
+ ],
+ 'AccessId' => [
+ 'description' => 'The username of the database account that is authorized to enable the secure access proxy feature for an instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'hObpgEXoca42q***',
+ ],
+ 'OriginInfo' => [
+ 'description' => 'The method that is used to authorize the user to enable the secure access proxy feature for an instance. Valid values:'."\n"
+ ."\n"
+ .'* **Authorization by the Alibaba Cloud Account ()**: The information in the parentheses () indicates the ID of the Alibaba Cloud account.'."\n"
+ .'* **Authorization by submitting the ticket ()**:The information in the parentheses () indicates the number of the ticket that the user submits to apply for permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'Authorization by the Alibaba Cloud account (29490401597700\\*\\*\\*\\*)'."\n",
+ ],
+ 'IndepAccount' => [
+ 'description' => 'The username of the independent database account.'."\n",
+ 'type' => 'string',
+ 'example' => '***',
+ ],
+ 'UserId' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'UserUid' => [
+ 'description' => 'The ID of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '25936669186260****',
+ ],
+ 'UserName' => [
+ 'description' => 'The nickname of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user',
+ ],
+ 'ProxyId' => [
+ 'description' => 'The ID of the secure access proxy.'."\n"
+ ."\n"
+ .'> You can call the [ListProxies](~~295371~~) operation to query the ID of the secure access proxy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1905',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance for which the secure access proxy feature is enabled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1922545',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CDB8601-AD74-4A47-8114-08E08CD6****\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The specified user not exists.\\",\\n \\"ErrorCode\\": \\"UserNotExist\\",\\n \\"ProxyAccess\\": {\\n \\"ProxyAccessId\\": 2002,\\n \\"GmtCreate\\": \\"1643034647\\",\\n \\"AccessId\\": \\"hObpgEXoca42q***\\",\\n \\"OriginInfo\\": \\"责任人授权（29490401597700****）\\",\\n \\"IndepAccount\\": \\"***\\",\\n \\"UserId\\": 0,\\n \\"UserUid\\": \\"25936669186260****\\",\\n \\"UserName\\": \\"user\\",\\n \\"ProxyId\\": 1905,\\n \\"InstanceId\\": 1922545\\n }\\n}","type":"json"}]',
+ 'title' => 'GetProxyAccess',
+ ],
+ 'GrantTemplateAuthority' => [
+ 'summary' => 'Grants permissions on resources to users by using a permission template.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1563',
+ ],
+ ],
+ [
+ 'name' => 'UserIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of users to which you want to grant permissions on resources by using the permission template.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '[12***,34***,56***]',
+ ],
+ ],
+ [
+ 'name' => 'ExpireDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time when the permission expires. Specify the time in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2023-03-08 17:58:53',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The reason why you want to grant permissions on resources to the users by using the permission template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Business test.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '34E01EDD-6A16-4CF0-9541-C644D1BE01AA',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Result' => [
+ 'description' => 'Indicates whether the permissions on resources were granted to the users by using the permission template.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34E01EDD-6A16-4CF0-9541-C644D1BE01AA\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => 'GrantTemplateAuthority',
+ 'description' => 'You must be a database administrator (DBA) or a Data Management (DMS) administrator. For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'RevokeTemplateAuthority' => [
+ 'summary' => 'Revokes permissions on resources from Data Management (DMS) users by using a permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1563',
+ ],
+ ],
+ [
+ 'name' => 'UserIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of users from whom you want to revoke permissions by using a permission template.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '[12***,34***,56***]',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Result' => [
+ 'description' => 'Indicates whether the permissions were revoked from the users.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RevokeTemplateAuthority',
+ 'description' => 'You must be a database administrator (DBA) or a DMS administrator. For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'CreateAuthorityTemplate' => [
+ 'summary' => 'Creates a permission template',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the permission template.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Test template.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the permission template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This template is used for business testing.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'AuthorityTemplateView' => [
+ 'description' => 'The details of the permission template.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1563',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test template.'."\n",
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'This template is used for business testing.'."\n",
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the permission template was created. The time is in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-01-11 14:17:33',
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"AuthorityTemplateView\\": {\\n \\"TemplateId\\": 1563,\\n \\"Name\\": \\"测试模板。\\",\\n \\"CreatorId\\": 0,\\n \\"Description\\": \\"此模板用于业务测试。\\",\\n \\"CreateTime\\": \\"2023-01-11 14:17:33\\"\\n },\\n \\"Success\\": true,\\n \\"Tid\\": 0\\n}","type":"json"}]',
+ 'title' => 'CreateAuthorityTemplate',
+ 'description' => 'You are a database administrator (DBA) or a Data Management (DMS) administrator. For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'UpdateAuthorityTemplate' => [
+ 'summary' => 'Modifies a permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1563',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the permission template.'."\n"
+ ."\n"
+ .'> You must specify the Name or Description parameter. Otherwise, the API call fails.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Test template.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the permission template.'."\n"
+ ."\n"
+ .'> You must specify the Name or Description parameter. Otherwise, the API call fails.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'This template is used for business testing.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'AuthorityTemplateView' => [
+ 'description' => 'The details of the permission template.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1563',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test template.'."\n",
+ ],
+ 'Description' => [
+ 'description' => 'The description of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'This template is used for business testing.'."\n",
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"AuthorityTemplateView\\": {\\n \\"TemplateId\\": 1563,\\n \\"CreatorId\\": 0,\\n \\"Name\\": \\"测试模板。\\",\\n \\"Description\\": \\"此模板用于业务测试。\\"\\n },\\n \\"Success\\": true,\\n \\"Tid\\": 0\\n}","type":"json"}]',
+ 'title' => 'UpdateAuthorityTemplate',
+ 'description' => 'You are a database administrator (DBA) or a Data Management (DMS) administrator. For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'AddAuthorityTemplateItems' => [
+ 'summary' => 'Adds instances, databases, and tables to the specified permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms6MV762',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template. You can call the [CreateAuthorityTemplate](~~600705~~) operation to obtain the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'Items',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The resources that you want to add to the permission template.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The instance ID. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the instance ID.'."\n"
+ ."\n"
+ .'> This parameter is required if the ResourceType parameter is set to INSTANCE.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '237****',
+ ],
+ 'DbId' => [
+ 'description' => 'The database ID. Databases are divided into physical databases and logical databases.'."\n"
+ ."\n"
+ .'* To query the ID of a physical database, call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ .'* To query the ID of a logical database, call the [ListLogicDatabases](~~141874~~) or [SearchDatabase](~~141876~~) operation.'."\n"
+ ."\n"
+ .'> This parameter is required if the ResourceType parameter is set to META_DB, LOGIC_DB, META_TABLE, or LOGIC_TABLE.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2478****',
+ ],
+ 'TableName' => [
+ 'description' => 'The table name. You can call the [ListTables](~~141878~~) operation to query the name of the table.'."\n"
+ ."\n"
+ .'> This parameter is required if the ResourceType parameter is set to META_TABLE or LOGIC_TABLE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_table',
+ ],
+ 'ResourceType' => [
+ 'description' => 'The type of the resource from which you want to remove tags. Valid values:'."\n"
+ ."\n"
+ .'* **INSTANCE**: instance'."\n"
+ .'* **LOGIC_DB**: logical database'."\n"
+ .'* **META_DB**: physical database'."\n"
+ .'* **LOGIC_TABLE**: logical table'."\n"
+ .'* **LOGIC_TABLE**: physical table'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'INSTANCE',
+ ],
+ 'PermissionTypes' => [
+ 'description' => 'The permission types.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The permissions type.'."\n"
+ ."\n"
+ .'* **QUERY**: the query permission'."\n"
+ .'* **EXPORT**: the data export permission'."\n"
+ .'* **CORRECT**: the data change permission'."\n"
+ .'* **LOGIN**: the logon permission'."\n"
+ .'* **PERF**: the performance query permission'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'QUERY,CORRECT',
+ ],
+ 'required' => false,
+ 'enumValueTitles' => [],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '3D3FB827-E667-50DB-AD59-C83F8237FECB',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed. The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the resource is added to the permission template.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D3FB827-E667-50DB-AD59-C83F8237FECB\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AddAuthorityTemplateItems',
+ ],
+ 'GetAuthorityTemplateItem' => [
+ 'summary' => 'Queries the resources in a permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '165972',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms6MV762',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1563',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E46EA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'AuthorityTemplateItemList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuthorityTemplateItem' => [
+ 'description' => 'The permission templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ItemId' => [
+ 'description' => 'The ID of the resource.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1563',
+ ],
+ 'ModifierId' => [
+ 'description' => 'The ID of the user who modifies the resource.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51***',
+ ],
+ 'ResourceType' => [
+ 'description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'* **INSTANCE**: instance'."\n"
+ .'* **LOGIC_DB**: logical database'."\n"
+ .'* **META_DB**: physical database'."\n"
+ .'* **LOGIC_TABLE**: logical table'."\n"
+ .'* **LOGIC_TABLE**: physical table'."\n",
+ 'type' => 'string',
+ 'example' => 'INSTANCE',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '188****',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43***',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'ExampleTable',
+ ],
+ 'Attribute' => [
+ 'description' => 'The additional information. For example, permissions to log on to an instance are added to the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => '"permissionTypes": ['."\n"
+ .' "LOGIN"'."\n"
+ .' ]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B96E35F-A58E-5399-9041-09CF9A1E46EA\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"AuthorityTemplateItemList\\": {\\n \\"AuthorityTemplateItem\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"TemplateId\\": 1563,\\n \\"ModifierId\\": 0,\\n \\"ResourceType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": 0,\\n \\"DbId\\": 0,\\n \\"TableName\\": \\"ExampleTable\\",\\n \\"Attribute\\": \\"\\\\\\"permissionTypes\\\\\\": [\\\\n \\\\\\"LOGIN\\\\\\"\\\\n ]\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Tid\\": 0\\n}","type":"json"}]',
+ 'title' => 'GetAuthorityTemplateItem',
+ 'description' => 'You are a database administrator (DBA) or a Data Management (DMS) administrator. For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'GetAuthorityTemplate' => [
+ 'summary' => 'Queries the information about a permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1563',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'AuthorityTemplateView' => [
+ 'description' => 'The details of the permission template.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1563',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestTemplate'."\n",
+ ],
+ 'Description' => [
+ 'description' => 'The description of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => 'This template is used for business testing.'."\n",
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the permission template was created. The time is in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-01-01 00:00:00',
+ ],
+ 'AuthorityTemplateItemList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuthorityTemplateItem' => [
+ 'description' => 'The resource information in the permission template.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ItemId' => [
+ 'description' => 'The ID of the resource.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12***',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1563',
+ ],
+ 'ModifierId' => [
+ 'description' => 'The ID of the user who modified the resource.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51***',
+ ],
+ 'ResourceType' => [
+ 'description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'* **INSTANCE**: instance'."\n"
+ .'* **LOGIC_DB**: logical database'."\n"
+ .'* **META_DB**: physical database'."\n"
+ .'* **LOGIC_TABLE**: logical table'."\n"
+ .'* **SINGLE_TABLE**: physical table'."\n",
+ 'type' => 'string',
+ 'example' => 'INSTANCE',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '188****',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43***',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'ExampleTable',
+ ],
+ 'Attribute' => [
+ 'description' => 'Other information. For example, you can add the logon permission on an instance to the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => '"permissionTypes": ['."\n"
+ .' "LOGIN"'."\n"
+ .' ]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"AuthorityTemplateView\\": {\\n \\"TemplateId\\": 1563,\\n \\"CreatorId\\": 0,\\n \\"Name\\": \\"测试模板。\\",\\n \\"Description\\": \\"此模板用于业务测试。\\",\\n \\"CreateTime\\": \\"2023-01-01 00:00:00\\",\\n \\"AuthorityTemplateItemList\\": {\\n \\"AuthorityTemplateItem\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"TemplateId\\": 1563,\\n \\"ModifierId\\": 0,\\n \\"ResourceType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": 0,\\n \\"DbId\\": 0,\\n \\"TableName\\": \\"ExampleTable\\",\\n \\"Attribute\\": \\"\\\\\\"permissionTypes\\\\\\": [\\\\n \\\\\\"LOGIN\\\\\\"\\\\n ]\\"\\n }\\n ]\\n }\\n },\\n \\"Success\\": true,\\n \\"Tid\\": 0\\n}","type":"json"}]',
+ 'title' => 'GetAuthorityTemplate',
+ 'description' => 'You must be a Data Management (DMS) administrator or a database administrator (DBA). For more information about how to view system roles, see [View system roles](~~324212~~).'."\n",
+ ],
+ 'ListAuthorityTemplate' => [
+ 'summary' => 'Queries the information about permission templates, including the template creator, template name, and total number of templates.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for permission templates.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values:'."\n"
+ ."\n"
+ .'* 5'."\n"
+ .'* 10'."\n"
+ .'* 20'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '31853A2B-DC9D-5B39-8492-D2AC8BCF550E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ 'AuthorityTemplateViewList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AuthorityTemplateView' => [
+ 'description' => 'The permission templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2592',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '522****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the permission template.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the permission template was created. The time is in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2023-10-26 11:37:47',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of permission templates.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31853A2B-DC9D-5B39-8492-D2AC8BCF550E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Tid\\": 0,\\n \\"AuthorityTemplateViewList\\": {\\n \\"AuthorityTemplateView\\": [\\n {\\n \\"TemplateId\\": 2592,\\n \\"CreatorId\\": 0,\\n \\"Name\\": \\"权限模板测试\\",\\n \\"Description\\": \\"该模板为测试使用。\\",\\n \\"CreateTime\\": \\"2023-10-26 11:37:47\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 10\\n}","type":"json"}]',
+ 'title' => 'ListAuthorityTemplate',
+ ],
+ 'DeleteAuthorityTemplate' => [
+ 'summary' => 'Deletes a permission template.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '2592',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Tid\\": 0\\n}","type":"json"}]',
+ 'title' => 'DeleteAuthorityTemplate',
+ ],
+ 'CreateAbacPolicy' => [
+ 'summary' => 'Creates a policy to manage the permissions on DMS features and data resources managed in DMS in a fine-grained manner.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228408',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AbacPolicyName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '策略名称，租户内唯一',
+ 'description' => 'The name of the policy. The name must be unique for the tenant.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'policy_test',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyDesc',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '策略描述',
+ 'description' => 'The description of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '策略内容',
+ 'description' => 'The content of the policy. Specifies whether the authorized user can access and use the resources and features defined in the policy.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '{'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Action": "*",'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Resource": "*",'."\n"
+ .' "Condition": {'."\n"
+ .' "StringEqualsIgnoreCase": {'."\n"
+ .' "dms:DbType": ['."\n"
+ .' "redis"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "Version": "1"'."\n"
+ .'}',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'CreatePolicyResult' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"CreatePolicyResult\\": 0\\n}","type":"json"}]',
+ 'title' => 'CreateAbacPolicy',
+ 'description' => 'Currently, this feature is in the phased release phase. Only users who have phased out can use this feature and related APIs. For more information about the policy feature, see [Manage policies](~~2848565~~).'."\n",
+ ],
+ 'ListAbacPolicies' => [
+ 'summary' => 'Queries a list of policies that are created by a user.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228361',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The search keyword. Fuzzy match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'policy_test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ 'PolicyList' => [
+ 'description' => 'The details of the permission policies.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the permission policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AbacPolicyId' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'AbacPolicyName' => [
+ 'description' => 'The name of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'policy_test'."\n",
+ ],
+ 'AbacPolicyDesc' => [
+ 'description' => 'The description of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'AbacPolicyContent' => [
+ 'description' => 'The content of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Action": "*",'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Resource": "*",'."\n"
+ .' "Condition": {'."\n"
+ .' "StringEqualsIgnoreCase": {'."\n"
+ .' "dms:DbType": ['."\n"
+ .' "redis"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "Version": "1"'."\n"
+ .'}',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****'."\n",
+ ],
+ 'AbacPolicySource' => [
+ 'description' => 'The source of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER_DEFINE'."\n",
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of policies.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Tid\\": 0,\\n \\"PolicyList\\": [\\n {\\n \\"AbacPolicyId\\": 0,\\n \\"AbacPolicyName\\": \\"policy_test\\\\n\\",\\n \\"AbacPolicyDesc\\": \\"test\\",\\n \\"AbacPolicyContent\\": \\"{\\\\n \\\\\\"Statement\\\\\\": [\\\\n {\\\\n \\\\\\"Action\\\\\\": \\\\\\"*\\\\\\",\\\\n \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n \\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\",\\\\n \\\\\\"Condition\\\\\\": {\\\\n \\\\\\"StringEqualsIgnoreCase\\\\\\": {\\\\n \\\\\\"dms:DbType\\\\\\": [\\\\n \\\\\\"redis\\\\\\"\\\\n ]\\\\n }\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\",\\n \\"CreatorId\\": 0,\\n \\"AbacPolicySource\\": \\"USER_DEFINE\\\\n\\"\\n }\\n ],\\n \\"TotalCount\\": 5\\n}","type":"json"}]',
+ 'title' => 'ListAbacPolicies',
+ ],
+ 'UpdateAbacPolicy' => [
+ 'summary' => 'Updates the name, description, or content of a policy.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228488',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AbacPolicyName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略名称',
+ 'description' => 'The name of the permission policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'policy_test',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyDesc',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略描述',
+ 'description' => 'The description of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略内容',
+ 'description' => 'The content of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Action": "*",'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Resource": "*",'."\n"
+ .' "Condition": {'."\n"
+ .' "StringEqualsIgnoreCase": {'."\n"
+ .' "dms:DbType": ['."\n"
+ .' "redis"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "Version": "1"'."\n"
+ .'}',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'CE43759B-5A72-560A-BF3D-862F38B36B9E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'UpdatePolicyResult' => [
+ 'description' => 'Indicates whether the policy is updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE43759B-5A72-560A-BF3D-862F38B36B9E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"UpdatePolicyResult\\": 0\\n}","type":"json"}]',
+ 'title' => 'UpdateAbacPolicy',
+ ],
+ 'DeleteAbacPolicy' => [
+ 'summary' => 'Deletes a created permission policy.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228464',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AbacPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'DeletePolicyResult' => [
+ 'description' => 'Indicates whether the policy is deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"DeletePolicyResult\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteAbacPolicy',
+ ],
+ 'GetAbacPolicy' => [
+ 'summary' => 'Queries the details of a policy, including the name, content, and the user who created the policy.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '229515',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AbacPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'AbacPolicyName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '策略名称',
+ 'description' => 'The name of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'policy_test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '2B7844DE-A0C3-50ED-A796-8F07D377144C',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Policy' => [
+ 'description' => 'The details of the policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyName' => [
+ 'title' => '策略名',
+ 'description' => 'The name of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'policy_test',
+ ],
+ 'PolicyDesc' => [
+ 'title' => '策略描述',
+ 'description' => 'The description of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'PolicyContent' => [
+ 'title' => '策略内容',
+ 'description' => 'The content of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Action": "*",'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Resource": "*",'."\n"
+ .' "Condition": {'."\n"
+ .' "StringEqualsIgnoreCase": {'."\n"
+ .' "dms:DbType": ['."\n"
+ .' "redis"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "Version": "1"'."\n"
+ .'}',
+ ],
+ 'CreatorId' => [
+ 'title' => '策略创建人',
+ 'description' => 'The ID of the user who create the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****'."\n",
+ ],
+ 'PolicySource' => [
+ 'title' => '策略来源',
+ 'description' => 'The source of the policy. Valid values:'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'AuthorizedQuantity' => [
+ 'title' => '关联的授权数量',
+ 'description' => 'The number of users or custom roles to which the policy is attached.'."\n",
+ 'type' => 'string',
+ 'example' => '3',
+ ],
+ 'PolicyId' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B7844DE-A0C3-50ED-A796-8F07D377144C\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Policy\\": {\\n \\"PolicyName\\": \\"policy_test\\",\\n \\"PolicyDesc\\": \\"test\\",\\n \\"PolicyContent\\": \\"{\\\\n \\\\\\"Statement\\\\\\": [\\\\n {\\\\n \\\\\\"Action\\\\\\": \\\\\\"*\\\\\\",\\\\n \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n \\\\\\"Resource\\\\\\": \\\\\\"*\\\\\\",\\\\n \\\\\\"Condition\\\\\\": {\\\\n \\\\\\"StringEqualsIgnoreCase\\\\\\": {\\\\n \\\\\\"dms:DbType\\\\\\": [\\\\n \\\\\\"redis\\\\\\"\\\\n ]\\\\n }\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\",\\n \\"CreatorId\\": 0,\\n \\"PolicySource\\": \\"自定义\\",\\n \\"AuthorizedQuantity\\": \\"3\\",\\n \\"PolicyId\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'GetAbacPolicy',
+ ],
+ 'CreateAbacAuthorization' => [
+ 'summary' => 'Attaches a system policy or custom policy to a DMS user or custom role.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'abilityTreeCode' => '228501',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'IdentityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '授权对象类型',
+ 'description' => 'Principal Type. Valid values:**user**or**custom role**.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* USER'."\n"
+ .'* ROLE'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'USER',
+ 'enum' => [
+ 'USER',
+ 'ROLE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用户id',
+ 'description' => 'The ID of the user. You can call the [GetUser](~~465816~~) operation to query the user ID.'."\n"
+ ."\n"
+ .'> If IdentityType is set to USER, this parameter is required.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'RoleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '角色id',
+ 'description' => 'The ID of the role.'."\n"
+ ."\n"
+ .'> If IdentityType is set to ROLE, this parameter is required.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '31****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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 request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Result' => [
+ 'description' => 'Indicates whether the policy is attached.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'CreateAbacAuthorization',
+ ],
+ 'ListAbacAuthorizations' => [
+ 'summary' => 'Queries a list of users to which the specified policy is attached and the number of the users.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228489',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '需要搜索的权限策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'PolicySource',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '权限策略来源',
+ 'description' => 'The type of the policy. The value can be custom or system.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* USER_DEFINE'."\n"
+ .'* SYSTEM'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'USER_DEFINE',
+ 'enum' => [
+ 'USER_DEFINE',
+ 'SYSTEM',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned when the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned when the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AuthorizationList' => [
+ 'description' => 'The list of users to which the specified policy is attached.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => [
+ 'title' => '策略id',
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ 'PolicyName' => [
+ 'title' => '策略名称',
+ 'description' => 'The name of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'policy_test',
+ ],
+ 'PolicySource' => [
+ 'title' => '策略来源',
+ 'description' => 'The source of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER_DEFINE',
+ ],
+ 'AuthorizationId' => [
+ 'description' => 'The authorization ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '32****',
+ ],
+ 'IdentityId' => [
+ 'title' => '授权对象id',
+ 'description' => 'The ID of the object to which the policy is attached.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '51****'."\n",
+ ],
+ 'IdentityName' => [
+ 'title' => '授权对象名称',
+ 'description' => 'The name of the object to which the policy is attached.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_user',
+ ],
+ 'IdentityType' => [
+ 'title' => '授权对象类型',
+ 'description' => 'The type of the object to which the policy is attached.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The number of objects to which the policy is attached.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"AuthorizationList\\": [\\n {\\n \\"PolicyId\\": 0,\\n \\"PolicyName\\": \\"policy_test\\",\\n \\"PolicySource\\": \\"USER_DEFINE\\",\\n \\"AuthorizationId\\": 0,\\n \\"IdentityId\\": 0,\\n \\"IdentityName\\": \\"test_user\\",\\n \\"IdentityType\\": \\"USER\\"\\n }\\n ],\\n \\"TotalCount\\": 3\\n}","type":"json"}]',
+ 'title' => 'ListAbacAuthorizations',
+ ],
+ 'DeleteAbacAuthorization' => [
+ 'summary' => 'Detaches a policy from a user or role.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '228543',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCFVL8F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AuthorizationId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '授权id',
+ 'description' => 'The authorization ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123***',
+ ],
+ ],
+ [
+ 'name' => 'IdentityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '授权对象类型',
+ 'description' => 'The type of object to which you want to attach the policy.********'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* USER'."\n"
+ .'* ROLE'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'USER',
+ 'enum' => [
+ 'USER',
+ 'ROLE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***'."\n",
+ ],
+ ],
+ ],
+ '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 query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '207176D7-A9B3-55CE-A9DA-14E223A31913',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Result' => [
+ 'description' => 'Indicates whether the policy is detached from the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207176D7-A9B3-55CE-A9DA-14E223A31913\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteAbacAuthorization',
+ ],
+ 'ExecuteScript' => [
+ 'summary' => 'Executes SQL statements.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsCYIMWT',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the database.'."\n"
+ ."\n"
+ .'> This parameter is equivalent to the DatabaseId parameter in the SearchDatabase, ListDatabases, and GetDatabase operations. You can call one of these operations to obtain the required database ID. For more information, see [SearchDatabase](~~141876~~), [ListDatabases](~~141873~~), and [GetDatabase](~~141869~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Script',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The SQL statements to be executed. Data query language (DQL) statements, data definition language (DDL) statements, and data manipulation language (DML) statements are supported. The control mode of the instance that you want to query determines whether you can execute DDL and DML statements.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'select dt from report_daily',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To obtain the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Tenant information](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '234',
+ ],
+ ],
+ [
+ 'name' => 'RealLoginUserUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF9A04',
+ ],
+ 'Results' => [
+ 'description' => 'The results of the SQL statements that are executed, in the format of an array. Each entry in the array indicates the result of an SQL statement.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnNames' => [
+ 'description' => 'The fields that are queried after the SQL statement is executed.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'col1',
+ ],
+ ],
+ 'Rows' => [
+ 'description' => 'The rows that are queried after the SQL statement is executed.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'example' => '[{"col1": "value1", "col2":"value2"}]',
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the SQL statement is executed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Message' => [
+ 'description' => 'The error message that is returned if the SQL statement fails to be executed. For example, an error message is returned because the SQL statement is invalid.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'RowCount' => [
+ 'description' => 'The total number of entries that are returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message about the gateway.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04\\",\\n \\"Results\\": [\\n {\\n \\"ColumnNames\\": [\\n \\"col1\\"\\n ],\\n \\"Rows\\": [\\n [\\n {\\n \\"col1\\": \\"value1\\",\\n \\"col2\\": \\"value2\\"\\n }\\n ]\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"UnknownError\\",\\n \\"RowCount\\": 1\\n }\\n ],\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FE8EE2F1-4880-46BC-A704-5CF63EAF9A04</RequestId>\\n<Results>\\n <Message>UnknownError</Message>\\n <RowCount>1</RowCount>\\n <Success>true</Success>\\n</Results>\\n<Results>\\n <ColumnNames>[\\"col1\\", \\"col2\\"]</ColumnNames>\\n <Rows>[{\\"col1\\": \\"value1\\", \\"col2\\":\\"value2\\"}]</Rows>\\n</Results>\\n<ErrorCode>UnknownError</ErrorCode>\\n<ErrorMessage>UnknownError</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ExecuteScript',
+ 'description' => 'You can call this operation only for instances that are managed in Security Collaboration mode.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTaskFlowConstants' => [
+ 'summary' => 'Updates the constants for a specified task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '149649',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'DagConstants',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The constants for the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The key name of a constant for the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'poc_test',
+ ],
+ 'Value' => [
+ 'description' => 'The key value of a constant for the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'poc_test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C4CCC000-C193-5A32-B701-573F497BF729',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C4CCC000-C193-5A32-B701-573F497BF729\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowConstantsResponse>\\n <RequestId>C4CCC000-C193-5A32-B701-573F497BF729</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</UpdateTaskFlowConstantsResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowConstants',
+ ],
+ 'DeleteTaskFlow' => [
+ 'summary' => 'Deletes a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '133185',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '134137***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '9AFE13F6-A4FD-581B-BFDE-B63B1CDC2336',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9AFE13F6-A4FD-581B-BFDE-B63B1CDC2336\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTaskFlowResponse>\\n <RequestId>9AFE13F6-A4FD-581B-BFDE-B63B1CDC2336</RequestId>\\n <Success>true</Success>\\n</DeleteTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'DeleteTaskFlow',
+ ],
+ 'OfflineTaskFlow' => [
+ 'summary' => 'Unpublishes a published task flow in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '135062',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A8FE12AA-300D-5FDF-806F-C2CB99161F32',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8FE12AA-300D-5FDF-806F-C2CB99161F32\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<OfflineTaskFlowResponse>\\n <RequestId>A8FE12AA-300D-5FDF-806F-C2CB99161F32</RequestId>\\n <Success>true</Success>\\n</OfflineTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'OfflineTaskFlow',
+ ],
+ 'ListTaskFlow' => [
+ 'summary' => 'Queries a list of task flows.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '133045',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4116147E-C628-5816-8779-8EEAF8E973F4',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskFlowList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TaskFlow' => [
+ 'description' => 'The information about the task flows returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '134137****',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'CreatorNickName' => [
+ 'description' => 'The name of the user who creates the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Creator_NickName',
+ ],
+ 'DagOwnerNickName' => [
+ 'description' => 'The name of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'Owner_NickName',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the latest deployment record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12**',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow is invalid.'."\n"
+ .'* **1**: Scheduling is disabled for the task flow.'."\n"
+ .'* **2**: The task flow is waiting to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'LatestInstanceStatus' => [
+ 'description' => 'The status of the latest execution. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invalid.'."\n"
+ .'* **1**: scheduling disabled.'."\n"
+ .'* **2**: waiting to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'LatestInstanceTime' => [
+ 'description' => 'The time when the latest execution record was generated.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-04-13',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4116147E-C628-5816-8779-8EEAF8E973F4\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TaskFlowList\\": {\\n \\"TaskFlow\\": [\\n {\\n \\"Id\\": 0,\\n \\"CreatorId\\": \\"51****\\",\\n \\"CreatorNickName\\": \\"Creator_NickName\\",\\n \\"DagOwnerNickName\\": \\"Owner_NickName\\",\\n \\"DeployId\\": 0,\\n \\"Status\\": 2,\\n \\"LatestInstanceStatus\\": 0,\\n \\"LatestInstanceTime\\": \\"2022-04-13\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowResponse>\\n <RequestId>4116147E-C628-5816-8779-8EEAF8E973F4</RequestId>\\n <Success>true</Success>\\n <TaskFlowList>\\n <CreatorId>51****</CreatorId>\\n <CreatorNickName>Creator_NickName</CreatorNickName>\\n <DagOwnerNickName>Owner_NickName</DagOwnerNickName>\\n <Status>2</Status>\\n <LatestInstanceStatus>0</LatestInstanceStatus>\\n <LatestInstanceTime>2022-04-13</LatestInstanceTime>\\n </TaskFlowList>\\n</ListTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlow',
+ ],
+ 'GetTaskInstanceRelation' => [
+ 'summary' => 'Queries the task nodes of a task flow instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to obtain the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '47****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '028BF827-3801-5869-8548-F4A039256304',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NodeList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Node' => [
+ 'description' => 'The information about the nodes in the execution record of the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the execution record of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '14059',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '14059',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Spark SQL-1',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the node. For more information about the valid values for this parameter, see [NodeType parameter](~~424705~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '36',
+ ],
+ 'BusinessTime' => [
+ 'description' => 'The business time of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-09 14:37:26',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the node. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The node is waiting to be scheduled.'."\n"
+ .'* **1**: The node is running.'."\n"
+ .'* **2**: The node is suspended.'."\n"
+ .'* **3**: The node failed to run.'."\n"
+ .'* **4**: The node is run.'."\n"
+ .'* **5**: The node is complete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'Message' => [
+ 'description' => 'The description of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ExecuteTime' => [
+ 'description' => 'The amount of time consumed for running the node. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '170655',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the execution of the task flow was complete. The time is displayed in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-11 14:38:57',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"028BF827-3801-5869-8548-F4A039256304\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"NodeList\\": {\\n \\"Node\\": [\\n {\\n \\"Id\\": 14059,\\n \\"NodeId\\": 14059,\\n \\"NodeName\\": \\"Spark SQL-1\\",\\n \\"NodeType\\": 0,\\n \\"BusinessTime\\": \\"2021-11-09 14:37:26\\",\\n \\"Status\\": 4,\\n \\"Message\\": \\"test\\",\\n \\"ExecuteTime\\": 170655,\\n \\"EndTime\\": \\"2021-11-11 14:38:57\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTaskInstanceRelationResponse>\\n <RequestId>028BF827-3801-5869-8548-F4A039256304</RequestId>\\n <Success>true</Success>\\n <NodeList>\\n <Id>14059</Id>\\n <NodeId>14059</NodeId>\\n <NodeName>Spark SQL-1</NodeName>\\n <NodeType>36</NodeType>\\n <BusinessTime>2021-11-09 14:37:26</BusinessTime>\\n <Status>4</Status>\\n <Message>test</Message>\\n <ExecuteTime>170655</ExecuteTime>\\n <EndTime>2021-11-11 14:38:57</EndTime>\\n </NodeList>\\n</GetTaskInstanceRelationResponse>","errorExample":""}]',
+ 'title' => 'GetTaskInstanceRelation',
+ ],
+ 'ListTaskFlowInstance' => [
+ 'summary' => 'Queries the execution records of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '132914',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'TriggerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The mode in which the task flow is triggered. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow is automatically triggered based on periodic scheduling.'."\n"
+ .'* **1**: The task flow is manually triggered.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'StartTimeBegin',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query the execution records of the task flow. Specify the time in the yyyy-MM-DD format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2022-01-07',
+ ],
+ ],
+ [
+ 'name' => 'StartTimeEnd',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query the execution records of the task flow. Specify the time in the yyyy-MM-DD format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2022-04-08',
+ ],
+ ],
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'UseBizDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Adjust filter conditions:'."\n"
+ ."\n"
+ .'- true: StartTimeBegin and StartTimeEnd are the time range for filtering services.'."\n"
+ ."\n"
+ .'- false: StartTimeBegin and StartTimeEnd are the time range for the task to run.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The running status of the task node. Valid values:'."\n"
+ ."\n"
+ .'- **0**: Waiting for scheduling'."\n"
+ ."\n"
+ .'- **1**: Running'."\n"
+ ."\n"
+ .'- **2**: Suspend'."\n"
+ ."\n"
+ .'- **3**: Failed to run'."\n"
+ ."\n"
+ .'- **4**: Run successfully'."\n"
+ ."\n"
+ .'- **5**: Completed',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '8CFF2295-8249-5287-B888-DBD4F0D76CB0',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DAGInstanceList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DAGInstance' => [
+ 'description' => 'The information about the execution records returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the execution record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9234',
+ ],
+ 'BusinessTime' => [
+ 'description' => 'The business time of the task flow. The time is displayed in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-10 14:37:26',
+ ],
+ 'startTime' => [
+ 'description' => 'The time when the execution of the task flow was start. The time is displayed in the yyyy-MM-DD HH:mm:ss format.',
+ 'type' => 'string',
+ 'example' => '2021-11-11 14:35:57'."\n",
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the execution of the task flow was complete. The time is displayed in the yyyy-MM-DD HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-11-11 14:38:57',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '7***',
+ ],
+ 'TriggerType' => [
+ 'description' => 'The mode in which the task flow is triggered. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow is automatically triggered based on periodic scheduling.'."\n"
+ .'* **1**: The task flow is manually triggered.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'* **0**: The task flow is waiting to be scheduled.'."\n"
+ .'* **1**: The task flow is being executed.'."\n"
+ .'* **2**: The task flow is paused.'."\n"
+ .'* **3**: The task flow failed.'."\n"
+ .'* **4**: The task flow is executed.'."\n"
+ .'* **5**: The task flow is complete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'Message' => [
+ 'description' => 'The description of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'HistoryDagId' => [
+ 'description' => 'The ID of the previously published version of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2****',
+ ],
+ 'DagName' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Spark_SQL_test',
+ ],
+ 'OwnerName' => [
+ 'description' => 'The name of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ 'DagVersion' => [
+ 'description' => 'The version of the task flow.',
+ 'type' => 'string',
+ 'example' => '[]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of execution records returned.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8CFF2295-8249-5287-B888-DBD4F0D76CB0\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DAGInstanceList\\": {\\n \\"DAGInstance\\": [\\n {\\n \\"Id\\": 9234,\\n \\"BusinessTime\\": \\"2021-11-10 14:37:26\\",\\n \\"startTime\\": \\"2021-11-11 14:35:57\\\\n\\",\\n \\"EndTime\\": \\"2021-11-11 14:38:57\\",\\n \\"DagId\\": \\"7***\\",\\n \\"TriggerType\\": 1,\\n \\"Status\\": 4,\\n \\"Message\\": \\"test\\",\\n \\"HistoryDagId\\": 0,\\n \\"DagName\\": \\"Spark_SQL_test\\",\\n \\"OwnerName\\": \\"test_name\\",\\n \\"DagVersion\\": \\"[]\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowInstanceResponse>\\n <RequestId>8CFF2295-8249-5287-B888-DBD4F0D76CB0</RequestId>\\n <Success>true</Success>\\n <DAGInstanceList>\\n <Id>9234</Id>\\n <BusinessTime>2021-11-10 14:37:26</BusinessTime>\\n <EndTime>2021-11-11 14:38:57</EndTime>\\n <DagId>7***</DagId>\\n <TriggerType>1</TriggerType>\\n <Status>4</Status>\\n <Message>test</Message>\\n <DagName>Spark_SQL_test</DagName>\\n <OwnerName>test_name</OwnerName>\\n </DAGInstanceList>\\n <TotalCount>1</TotalCount>\\n</ListTaskFlowInstanceResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowInstance',
+ ],
+ 'ListDAGVersions' => [
+ 'summary' => 'Queries the published versions of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '133412',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C7775630-7901-51B9-8782-9B585EC0799A',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DagVersionList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DagVersion' => [
+ 'description' => 'The information about the published versions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DagName' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Spark SQL',
+ ],
+ 'DagOwnerId' => [
+ 'description' => 'The ID of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'DagOwnerNickName' => [
+ 'description' => 'The name of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'VersionComments' => [
+ 'description' => 'The description of the version.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_OSS',
+ ],
+ 'VersionId' => [
+ 'description' => 'The ID of the version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2****',
+ ],
+ 'LastVersionId' => [
+ 'description' => 'The ID of the previously published version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C7775630-7901-51B9-8782-9B585EC0799A\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"DagVersionList\\": {\\n \\"DagVersion\\": [\\n {\\n \\"DagName\\": \\"Spark SQL\\",\\n \\"DagOwnerId\\": \\"51****\\",\\n \\"DagOwnerNickName\\": \\"name\\",\\n \\"VersionComments\\": \\"test_OSS\\",\\n \\"VersionId\\": 0,\\n \\"LastVersionId\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDAGVersionsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>C7775630-7901-51B9-8782-9B585EC0799A</RequestId>\\n <DagVersionList>\\n <DagVersion>\\n <VersionId>2****</VersionId>\\n <DagOwnerId>51****</DagOwnerId>\\n <VersionComments>test_OSS</VersionComments>\\n <DagName>Spark SQL</DagName>\\n <DagOwnerNickName>name</DagOwnerNickName>\\n </DagVersion>\\n </DagVersionList>\\n <Success>true</Success>\\n</ListDAGVersionsResponse>","errorExample":""}]',
+ 'title' => 'ListDAGVersions',
+ ],
+ 'ReDeployLhDagVersion' => [
+ 'summary' => 'Redeploys the published versions of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '131692',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow version. You can call the [ListDAGVersions](~~424682~~) operation to obtain the ID of the task flow version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '035C92E0-2EAD-50E5-A6DD-550F5F73D7CE',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the deployment record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15990',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"035C92E0-2EAD-50E5-A6DD-550F5F73D7CE\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DeployId\\": 15990\\n}","errorExample":""},{"type":"xml","example":"<ReDeployLhDagVersionResponse>\\n <RequestId>035C92E0-2EAD-50E5-A6DD-550F5F73D7CE</RequestId>\\n <DeployId>15990</DeployId>\\n <Success>true</Success>\\n</ReDeployLhDagVersionResponse>","errorExample":""}]',
+ 'title' => 'ReDeployLhDagVersion',
+ ],
+ 'UpdateScenario' => [
+ 'summary' => 'Updates the name and description of the business scenario for a specified task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '149050',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the business scenario.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12***',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the business scenario.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business scenario - test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the business scenario.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateScenarioResponse>\\n <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>\\n <Success>true</Success>\\n</UpdateScenarioResponse>","errorExample":""}]',
+ 'title' => 'UpdateScenario',
+ ],
+ 'ResumeTaskFlowInstance' => [
+ 'summary' => 'Resumes a suspended task flow instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '149248',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'DagVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version number of the task flow. You can call the [ListDAGVersions](~~424682~~) operation to query the version number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '[]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FF2E325-763F-5E27-9157-C3CFA02F4CBF',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FF2E325-763F-5E27-9157-C3CFA02F4CBF\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ResumeTaskFlowInstanceResponse>\\n <RequestId>7FF2E325-763F-5E27-9157-C3CFA02F4CBF</RequestId>\\n <Success>true</Success>\\n</ResumeTaskFlowInstanceResponse>","errorExample":""}]',
+ 'title' => 'ResumeTaskFlowInstance',
+ 'description' => 'You can call this operation only for task flows that are suspended.'."\n",
+ ],
+ 'UpdateTaskContent' => [
+ 'summary' => 'Updates tasks in a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '149054',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the ["View information about the current tenant"](~~181330~~) section of the Manage DMS tenants topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '43****',
+ ],
+ ],
+ [
+ 'name' => 'NodeContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The node configurations after modification.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{ "dbId":12****, "sql":"select * from test_table", "dbType":"lindorm_sql" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '39557312-28D5-528F-9554-80C0700EB489',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39557312-28D5-528F-9554-80C0700EB489\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskContentResponse>\\n <RequestId>39557312-28D5-528F-9554-80C0700EB489</RequestId>\\n <Success>true</Success>\\n</UpdateTaskContentResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskContent',
+ 'description' => 'You can call this operation to modify node configurations.'."\n",
+ ],
+ 'ListTaskFlowsByPage' => [
+ 'summary' => 'Queries the details of task flows by page.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '149056',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Filter condition, application scenario ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12***',
+ ],
+ ],
+ [
+ 'name' => 'DagIdList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Filter condition, task flow ID list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Filter condition, task flow ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '45***',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used to search for task flow names.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test node'."\n",
+ ],
+ ],
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ 'default' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '6CB28697-BFE2-5739-9228-3971990E982C',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskFlowList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TaskFlow' => [
+ 'description' => 'The details of the returned task flows.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '7***',
+ ],
+ 'DagName' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'poc_task_test',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'CreatorNickName' => [
+ 'description' => 'The username of the user who created the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Creator_NickName',
+ ],
+ 'DagOwnerNickName' => [
+ 'description' => 'The username of the owner of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Owner_NickName',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the last deployment record of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '65***',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invalid'."\n"
+ .'* **1**: scheduling disabled'."\n"
+ .'* **2**: waiting to be scheduled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'LatestInstanceStatus' => [
+ 'description' => 'The status of the last execution of the task flow. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invalid'."\n"
+ .'* **1**: scheduling disabled'."\n"
+ .'* **2**: waiting to be scheduled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'LatestInstanceTime' => [
+ 'description' => 'The time when the last execution record was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-04-13',
+ ],
+ 'ScenarioId' => [
+ 'description' => 'The ID of the application scenario.',
+ 'type' => 'string',
+ 'example' => '1245',
+ ],
+ 'CronSwitch' => [
+ 'description' => 'Whether to enable scheduled scheduling.',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'CronStr' => [
+ 'description' => 'Scheduled Cron.',
+ 'type' => 'string',
+ 'example' => '0 0 1 * * ? *',
+ ],
+ 'ScheduleParam' => [
+ 'description' => 'Event scheduling configuration, JSON string format.',
+ 'type' => 'string',
+ 'example' => '{\\"triggerType\\":\\"1\\",\\"specificTime\\":\'2022-11-15 11:59\'}',
+ ],
+ 'TriggerType' => [
+ 'description' => 'The trigger type. Valid values:'."\n"
+ .'- **0**: Periodic scheduling'."\n"
+ .'- **1**: Run manually',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CronType' => [
+ 'description' => 'Scheduling cycle type. Valid values:'."\n"
+ .'- **2**: Hourly scheduling'."\n"
+ .'- **3**: Daily scheduling'."\n"
+ .'- **4**: Weekly scheduling'."\n"
+ .'- **5**: Monthly scheduling',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'CronBeginDate' => [
+ 'description' => 'The start time of scheduled scheduling. The task flow is not scheduled before this point in time.',
+ 'type' => 'string',
+ 'example' => '1970-01-01',
+ ],
+ 'CronEndDate' => [
+ 'description' => 'The end time of scheduled scheduling. The task flow is not scheduled after this point in time.',
+ 'type' => 'string',
+ 'example' => '2023-01-01',
+ ],
+ 'TimeZoneId' => [
+ 'description' => 'Time zone setting. Default value: East 8(Asia/Shanghai).',
+ 'type' => 'string',
+ 'example' => 'Asia/Shanghai',
+ ],
+ 'DagOwnerId' => [
+ 'description' => 'The user ID of the task flow owner.',
+ 'type' => 'string',
+ 'example' => '12***89',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '24',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CB28697-BFE2-5739-9228-3971990E982C\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TaskFlowList\\": {\\n \\"TaskFlow\\": [\\n {\\n \\"Id\\": 0,\\n \\"DagName\\": \\"poc_task_test\\",\\n \\"Description\\": \\"test\\",\\n \\"CreatorId\\": \\"51****\\",\\n \\"CreatorNickName\\": \\"Creator_NickName\\",\\n \\"DagOwnerNickName\\": \\"Owner_NickName\\",\\n \\"DeployId\\": 0,\\n \\"Status\\": 1,\\n \\"LatestInstanceStatus\\": 0,\\n \\"LatestInstanceTime\\": \\"2022-04-13\\",\\n \\"ScenarioId\\": \\"1245\\",\\n \\"CronSwitch\\": false,\\n \\"CronStr\\": \\"0 0 1 * * ? *\\",\\n \\"ScheduleParam\\": \\"{\\\\\\\\\\\\\\"triggerType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"specificTime\\\\\\\\\\\\\\":\'2022-11-15 11:59\'}\\",\\n \\"TriggerType\\": 0,\\n \\"CronType\\": 2,\\n \\"CronBeginDate\\": \\"1970-01-01\\",\\n \\"CronEndDate\\": \\"2023-01-01\\",\\n \\"TimeZoneId\\": \\"Asia/Shanghai\\",\\n \\"DagOwnerId\\": \\"12***89\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 24\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowsByPageResponse>\\n <RequestId>6CB28697-BFE2-5739-9228-3971990E982C</RequestId>\\n <Success>true</Success>\\n <TaskFlowList>\\n <DagName>poc_task_test</DagName>\\n <Description>test</Description>\\n <CreatorId>51****</CreatorId>\\n <CreatorNickName>Creator_NickName</CreatorNickName>\\n <DagOwnerNickName>Owner_NickName</DagOwnerNickName>\\n <Status>1</Status>\\n <LatestInstanceStatus>0</LatestInstanceStatus>\\n <LatestInstanceTime>2022-04-13</LatestInstanceTime>\\n </TaskFlowList>\\n <TotalCount>24</TotalCount>\\n</ListTaskFlowsByPageResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowsByPage',
+ ],
+ 'ListScenarios' => [
+ 'summary' => 'Queries business scenarios.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '149049',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ScenarioList' => [
+ 'description' => 'The details of the returned business scenarios.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the business scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41***',
+ ],
+ 'ScenarioName' => [
+ 'description' => 'The name of the business scenario.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who created the business scenario.'."\n",
+ 'type' => 'string',
+ 'example' => '23***',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the business scenario.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"ScenarioList\\": [\\n {\\n \\"Id\\": 0,\\n \\"ScenarioName\\": \\"test\\",\\n \\"CreatorId\\": \\"23***\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListScenariosResponse>\\n <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>\\n <Success>true</Success>\\n <ScenarioList>\\n <ScenarioName>test</ScenarioName>\\n <CreatorId>23***</CreatorId>\\n <Description>test</Description>\\n </ScenarioList>\\n</ListScenariosResponse>","errorExample":""}]',
+ 'title' => 'ListScenarios',
+ ],
+ 'UpdateTaskConfig' => [
+ 'summary' => 'Updates the advanced configuration of a task node.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '149772',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '43****',
+ ],
+ ],
+ [
+ 'name' => 'NodeConfig',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The advanced configuration for the node. The value of this parameter must be a JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{ "rerun":{ "rerunEnable":true, "rerunCount":1, "rerunInterval":10 } }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F4E2A94B-604F-43FF-93E7-F4EE3DCF412E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4E2A94B-604F-43FF-93E7-F4EE3DCF412E\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskConfigResponse>\\n <RequestId>F4E2A94B-604F-43FF-93E7-F4EE3DCF412E</RequestId>\\n <Success>true</Success>\\n</UpdateTaskConfigResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskConfig',
+ 'description' => 'You can call this operation to configure a failed task or rerun a task.'."\n",
+ 'requestParamsDescription' => 'The following sample code provides an example on how to specify the NodeConfig parameter:'."\n"
+ ."\n"
+ .'```'."\n"
+ .' '."\n"
+ .' "rerun":{ // This field is required.'."\n"
+ .' "rerunEnable":true, // Specifies whether to enable rerun.'."\n"
+ .' "rerunCount":1, // The number of reruns.'."\n"
+ .' "rerunInterval":10 // The interval between each rerun.'."\n"
+ .' '."\n"
+ .' '."\n"
+ .'```'."\n",
+ ],
+ 'ListTaskFlowConstants' => [
+ 'summary' => 'Queries the constants for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '149650',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '028BF827-3801-5869-8548-F4A039256304',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DagConstants' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DagConstant' => [
+ 'description' => 'A list of constant key-value pairs for the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The constant key.'."\n",
+ 'type' => 'string',
+ 'example' => 'example',
+ ],
+ 'Value' => [
+ 'description' => 'The constant value.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"028BF827-3801-5869-8548-F4A039256304\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DagConstants\\": {\\n \\"DagConstant\\": [\\n {\\n \\"Key\\": \\"example\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowConstantsResponse>\\n <RequestId>028BF827-3801-5869-8548-F4A039256304</RequestId>\\n <Success>true</Success>\\n <DagConstants>\\n <Key>example</Key>\\n <Value>0</Value>\\n </DagConstants>\\n</ListTaskFlowConstantsResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowConstants',
+ ],
+ 'BackFill' => [
+ 'summary' => 'Backfills data for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '149001',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'StartNodeIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The number of nodes for which you want to backfill data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The number of task nodes to be replenished.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'FilterNodeIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Filter condition, which specifies the list of node IDs in the task flow that do not need to supplement data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the node that does not need to supplement data in the task flow.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12***',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'IsTriggerSubTree',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to run descendant nodes. Default value: true.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'BackFillDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The date for the data to be backfilled. This parameter is required if you specify a date for data backfill.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2022-01-14',
+ ],
+ ],
+ [
+ 'name' => 'BackFillDateBegin',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The start date of the date range for the data to be backfilled. This parameter is required if you specify a date range for data backfill.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2022-01-14',
+ ],
+ ],
+ [
+ 'name' => 'BackFillDateEnd',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end date of the date range for the data to be backfilled. This parameter is required if you specify a date range for data backfill.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2022-09-29',
+ ],
+ ],
+ [
+ 'name' => 'Interval',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The interval at which data backfill is performed. Unit: hours. Minimum value: 1. Default value: 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '24',
+ ],
+ ],
+ [
+ 'name' => 'Asc',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The running sequence of task flows for data backfill. Valid values:'."\n"
+ ."\n"
+ .'* **0**: reverse chronological order.'."\n"
+ .'* **1**: chronological order. This is the default value.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'HistoryDagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the historical task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '16***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DagInstanceId' => [
+ 'description' => 'The ID of the execution record of the task flow.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '47****',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '43****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"DagInstanceId\\": 0,\\n \\"NodeId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<BackFillResponse>\\n <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>\\n <Success>true</Success>\\n</BackFillResponse>","errorExample":""}]',
+ 'title' => 'BackFill',
+ 'description' => 'During a data backfill, task flows are run in sequence based on their dates. You can specify whether task flows are run in chronological or reverse chronological order. After the data backfill is complete, you can specify a date or date range, and a node range to run task flows.',
+ 'requestParamsDescription' => 'The BackFillDate parameter is required if you specify a date for data backfill.'."\n"
+ ."\n"
+ .'The BackFillDateBegin and BackFillDateEnd parameters are required if you specify a date range for data backfill.'."\n",
+ ],
+ 'UpdateTaskTimeVariables' => [
+ 'summary' => 'Updates time variables for a task.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '148809',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '43****',
+ ],
+ ],
+ [
+ 'name' => 'TimeVariables',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time variables configured for the node. The value of this parameter must be a JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"variables":[ {"name":"var", "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y"} ]}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '39557312-28D5-528F-9554-80C0700EB489',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39557312-28D5-528F-9554-80C0700EB489\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskTimeVariablesResponse>\\n <RequestId>39557312-28D5-528F-9554-80C0700EB489</RequestId>\\n <Success>true</Success>\\n</UpdateTaskTimeVariablesResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskTimeVariables',
+ ],
+ 'ListTaskFlowTimeVariables' => [
+ 'summary' => 'Queries the time variables for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '148791',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'EC12A3BE-149F-5365-AF33-12CC8C963923',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TimeVariables' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TimeVariable' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'type' => 'string',
+ ],
+ 'Pattern' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC12A3BE-149F-5365-AF33-12CC8C963923\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TimeVariables\\": {\\n \\"timeVariable\\": [\\n {\\n \\"Name\\": \\"time_test\\",\\n \\"Pattern\\": \\"2018-09-26|+7h\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowTimeVariablesResponse>\\n <RequestId>EC12A3BE-149F-5365-AF33-12CC8C963923</RequestId>\\n <TimeVariables>\\n <TimeVariable>\\n <Pattern>2018-09-26|+7h</Pattern>\\n <Name>test</Name>\\n </TimeVariable>\\n <TimeVariable>\\n <Pattern>yyyy-MM-dd|+0d</Pattern>\\n <Name>test01</Name>\\n </TimeVariable>\\n </TimeVariables>\\n <Success>true</Success>\\n</ListTaskFlowTimeVariablesResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowTimeVariables',
+ ],
+ 'UpdateTaskFlowTimeVariables' => [
+ 'summary' => 'Updates the time variables for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '148792',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '43****',
+ ],
+ ],
+ [
+ 'name' => 'TimeVariables',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time variables for the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"variables":[ {"name":"var", "pattern":"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y"} ]}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '39557312-28D5-528F-9554-80C0700EB489',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39557312-28D5-528F-9554-80C0700EB489\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowTimeVariablesResponse>\\n <RequestId>39557312-28D5-528F-9554-80C0700EB489</RequestId>\\n <Success>true</Success>\\n</UpdateTaskFlowTimeVariablesResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowTimeVariables',
+ 'requestParamsDescription' => 'The value of TimeVariables must be a JSON string. Example:'."\n"
+ ."\n"
+ .'```'."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' "name":"var",// The name of the variable.'."\n"
+ .' '."\n"
+ .' The format of the variable.'."\n"
+ .' As shown in the example, the date can have one or more offsets, including minutes (m), hours (h), days (d), weeks (w), months (M), or years (y). The offsets are optional, and you can specify the offsets in a different order than described here. '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .'```'."\n",
+ ],
+ 'UpdateTaskFlowCooperators' => [
+ 'summary' => 'Updates the IDs of the users that are involved in a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '148725',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'CooperatorIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the users who are involved in the task flow to be updated.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The IDs of the users who are involved in the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D05B3EE1-B6D3-5B17-8CA6-A8054828E5B2',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D05B3EE1-B6D3-5B17-8CA6-A8054828E5B2\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowCooperatorsResponse>\\n <RequestId>D05B3EE1-B6D3-5B17-8CA6-A8054828E5B2</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</UpdateTaskFlowCooperatorsResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowCooperators',
+ ],
+ 'CreateScenario' => [
+ 'summary' => 'Creates a business scenario to group task flows by business scenario.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '149047',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the business scenario.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business scenario - test'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the business scenario.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '4E1D2B4D-3E53-4ABC-999D-1D2520B3471A',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ScenarioId' => [
+ 'description' => 'The ID of the business scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '36***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E1D2B4D-3E53-4ABC-999D-1D2520B3471A\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"ScenarioId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateScenarioResponse>\\n <RequestId>4E1D2B4D-3E53-4ABC-999D-1D2520B3471A</RequestId>\\n <ScenarioId>36***</ScenarioId>\\n <Success>true</Success>\\n</CreateScenarioResponse>","errorExample":""}]',
+ 'title' => 'CreateScenario',
+ ],
+ 'DeleteScenario' => [
+ 'summary' => 'Deletes a business scenario.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '149048',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the business scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '12***',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"12***\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteScenarioResponse>\\n <RequestId>12***</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</DeleteScenarioResponse>","errorExample":""}]',
+ 'title' => 'DeleteScenario',
+ 'description' => 'When you call this operation, make sure that no task flow is specified in the business scenario.',
+ ],
+ 'UpdateSLARules' => [
+ 'summary' => 'Updates the timeout reminder for the service level agreement (SLA) rules of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '148629',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> :To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'SlaRuleList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of SLA rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '15***',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the task node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ 'Type' => [
+ 'description' => 'The rule type. Valid values:'."\n"
+ ."\n"
+ .'* **0**: SLA rules for task flows'."\n"
+ .'* **1**: SLA rules for nodes'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '0',
+ ],
+ 'IntervalMinutes' => [
+ 'description' => 'The timeout period. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1080',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '88E053F7-347B-52DD-A186-1F340EEC0C27',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"88E053F7-347B-52DD-A186-1F340EEC0C27\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateSLARulesResponse>\\n <RequestId>88E053F7-347B-52DD-A186-1F340EEC0C27</RequestId>\\n <Success>true</Success>\\n</UpdateSLARulesResponse>","errorExample":""}]',
+ 'title' => 'UpdateSLARules',
+ 'description' => 'SLA rules take effect after task flows are deployed and published.',
+ ],
+ 'GetRuleNumLimitOfSLA' => [
+ 'summary' => 'Queries the maximum number of custom service-level agreement (SLA) rules for task orchestration.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D05B3EE1-B6D3-5B17-8CA6-A8054828E5B2',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RuleNumLimit' => [
+ 'description' => 'The maximum number of SLA rules.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D05B3EE1-B6D3-5B17-8CA6-A8054828E5B2\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"RuleNumLimit\\": 12\\n}","errorExample":""},{"type":"xml","example":"<GetRuleNumLimitOfSLAResponse>\\n <RequestId>8EE72AAA-88DE-5747-A63B-43887BFE5480</RequestId>\\n <RuleNumLimit>20</RuleNumLimit>\\n <Success>true</Success>\\n</GetRuleNumLimitOfSLAResponse>","errorExample":""}]',
+ 'title' => 'GetRuleNumLimitOfSLA',
+ ],
+ 'GetIntervalLimitOfSLA' => [
+ 'summary' => 'Queries the minimum scheduling cycle of a task flow when a service level agreement (SLA) timeout rule is configured for the task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '5B96E35F-A58E-5399-9041-09CF9A1E46EA',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'IntervalLimit' => [
+ 'description' => 'The minimum scheduling cycle. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '59',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B96E35F-A58E-5399-9041-09CF9A1E46EA\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"IntervalLimit\\": 59\\n}","errorExample":""},{"type":"xml","example":"<GetIntervalLimitOfSLAResponse>\\n <RequestId>5B96E35F-A58E-5399-9041-09CF9A1E46EA</RequestId>\\n <Success>true</Success>\\n <IntervalLimit>59</IntervalLimit>\\n</GetIntervalLimitOfSLAResponse>","errorExample":""}]',
+ 'title' => 'GetIntervalLimitOfSLA',
+ 'description' => 'The scheduling cycle of a task flow must be greater than the minimum scheduling cycle configured in the SLA rule for the task flow.',
+ ],
+ 'ListDefaultSLARules' => [
+ 'summary' => 'Queries the default service level agreement (SLA) timeout rules.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '148628',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '3E8AF4C3-A822-53A8-970C-059EE83BBD5A',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SLARuleList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SLARule' => [
+ 'description' => 'The list of SLA rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the SLA rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the task node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'RuleType' => [
+ 'description' => 'The type of the rule. Valid values:'."\n"
+ ."\n"
+ .'* **0**: an SLA rule for a task flow'."\n"
+ .'* **1**: an SLA rule for a task node'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IntervalMinutes' => [
+ 'description' => 'The timeout period. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1080',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E8AF4C3-A822-53A8-970C-059EE83BBD5A\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"SLARuleList\\": {\\n \\"SLARule\\": [\\n {\\n \\"Id\\": 1,\\n \\"DagId\\": 0,\\n \\"NodeId\\": 0,\\n \\"RuleType\\": 0,\\n \\"IntervalMinutes\\": 1080\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDefaultSLARulesResponse>\\n <RequestId>3E8AF4C3-A822-53A8-970C-059EE83BBD5A</RequestId>\\n <SLARuleList>\\n <SLARule>\\n <IntervalMinutes>1080</IntervalMinutes>\\n <RuleType>0</RuleType>\\n <Id>1</Id>\\n <DagId>0</DagId>\\n <NodeId>0</NodeId>\\n </SLARule>\\n </SLARuleList>\\n <Success>true</Success>\\n</ListDefaultSLARulesResponse>","errorExample":""}]',
+ 'title' => 'ListDefaultSLARules',
+ ],
+ 'ListTaskFlowCooperators' => [
+ 'summary' => 'Queries a list of users that are involved in a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '147902',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '54C99C70-2DFF-5A8C-A252-EBAA1EB668EC',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'CooperatorList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Cooperator' => [
+ 'description' => 'The users that are involved in the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'NickName' => [
+ 'description' => 'The alias of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'Email' => [
+ 'description' => 'The email address of the user.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'LoginName' => [
+ 'description' => 'The username.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'UserId' => [
+ 'description' => 'userId.',
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54C99C70-2DFF-5A8C-A252-EBAA1EB668EC\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"CooperatorList\\": {\\n \\"Cooperator\\": [\\n {\\n \\"NickName\\": \\"name\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"LoginName\\": \\"name\\",\\n \\"UserId\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowCooperatorsResponse>\\n <RequestId>54C99C70-2DFF-5A8C-A252-EBAA1EB668EC</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n <CooperatorList>\\n <NickName>name</NickName>\\n <Email>[email protected]</Email>\\n <LoginName>name</LoginName>\\n </CooperatorList>\\n</ListTaskFlowCooperatorsResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowCooperators',
+ ],
+ 'ListSLARules' => [
+ 'summary' => 'Queries the custom service level agreement (SLA) rules of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '148618',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '3D1A59F4-EB2B-5D24-80A5-90C446A00DE2',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SLARuleList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SLARule' => [
+ 'description' => 'The list of SLA rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the SLA rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11****',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the task node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RuleType' => [
+ 'description' => 'The type of the rule. Valid values:'."\n"
+ ."\n"
+ .'* **0**: an SLA rule for a task flow'."\n"
+ .'* **1**: an SLA rule for a task node'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IntervalMinutes' => [
+ 'description' => 'The timeout period. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1080',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3D1A59F4-EB2B-5D24-80A5-90C446A00DE2\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"SLARuleList\\": {\\n \\"SLARule\\": [\\n {\\n \\"Id\\": 2,\\n \\"DagId\\": 0,\\n \\"NodeId\\": 1,\\n \\"RuleType\\": 0,\\n \\"IntervalMinutes\\": 1080\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSLARulesResponse>\\n <RequestId>BD7055C8-798E-5AA7-8E42-9690A0C344B6</RequestId>\\n <SLARuleList>\\n <SLARule>\\n <id>2</id>\\n <DagId>11312</DagId>\\n <RuleType>0</RuleType>\\n <IntervalMinutes>1080</IntervalMinutes>\\n <NodeId>1</NodeId>\\n </SLARule>\\n </SLARuleList>\\n <Success>true</Success>\\n</ListSLARulesResponse>","errorExample":""}]',
+ 'title' => 'ListSLARules',
+ ],
+ 'GetTask' => [
+ 'summary' => 'Queries the configurations, including time variables, of a specified task node based on the task node ID.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'example' => '3***',
+ 'format' => 'int64',
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'required' => false,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'docRequired' => true,
+ 'example' => '51***',
+ 'format' => 'int64',
+ 'required' => true,
+ 'type' => 'integer',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'example' => '7838266C-E17B-58F4-B072-4DC356B58258',
+ 'type' => 'string',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'example' => 'UnknownError',
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'example' => 'UnknownError',
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'example' => 'true',
+ 'type' => 'boolean',
+ ],
+ 'Task' => [
+ 'description' => 'The task node.'."\n",
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the task flow to which the node belongs.'."\n",
+ 'example' => '7321',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'example' => 'Cross-database Spark SQL-1'."\n",
+ 'type' => 'string',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the node. For more information about the valid values for this parameter, see [NodeType parameter](~~424705~~).'."\n",
+ 'example' => 'SPARK_SQL',
+ 'type' => 'string',
+ ],
+ 'NodeContent' => [
+ 'description' => 'The configuration for the node.'."\n",
+ 'example' => '{\\"dbList\\":[{\\"instanceId\\":177****}" }',
+ 'type' => 'string',
+ ],
+ 'TimeVariables' => [
+ 'description' => 'The time variables configured for the node.'."\n",
+ 'example' => '{\\"variables\\":[{\\"name\\":\\"Today\\",\\"pattern\\":\\"yyyy-MM-dd|+1d\\"}]}',
+ 'type' => 'string',
+ ],
+ 'NodeConfig' => [
+ 'description' => 'The advanced configuration for the node.'."\n",
+ 'example' => '{\\\\"dbId\\\\":39\\*\\*\\*\\*,\\\\"dbType\\\\":\\\\"mysql\\\\",\\\\"locale\\\\":\\\\"zh\\\\",\\\\"sql\\\\":\\\\"/\\* Make sure that the following SQL statements meet your business requirements before submitting the SQL statements for execution. \\*/\\\\\\n\\\\\\nCREATE TABLE IF NOT EXISTS \\`momo_weekGather\\` (\\\\\\n\\\\\\t\\`id\\` bigint AUTO_INCREMENT DEFAULT \'0\',\\\\\\n\\\\\\t\\`age\\` bit NULL,\\\\\\n\\\\\\t\\`action\\` varchar(150) NULL,\\\\\\n\\\\\\t\\`elapse_time\\` datetime NULL,\\\\\\n\\\\\\tPRIMARY KEY (\\`id\\`)\\\\\\n) ENGINE=InnoDB\\\\\\nDEFAULT CHARACTER SET=utf8;\\\\"}'."\n",
+ 'type' => 'string',
+ ],
+ 'NodeOutput' => [
+ 'description' => 'The output variables for the node. This parameter is available only for some types of nodes.'."\n",
+ 'example' => '{ "outputs":[ "extractMethod":"json" , "variableName":"var", "description":"demo desc" } ] }',
+ 'type' => 'string',
+ ],
+ 'GraphParam' => [
+ 'description' => 'The position of the node on the Directed Acyclic Graph (DAG).'."\n",
+ 'example' => '{"{\\"x\\":0,\\"y\\":0,\\"layoutType\\":\\"Horizontal\\"}", "id": 51***}',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7838266C-E17B-58F4-B072-4DC356B58258\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Task\\": {\\n \\"DagId\\": 7321,\\n \\"NodeName\\": \\"跨库Spark SQL-1\\",\\n \\"NodeType\\": \\"SPARK_SQL\\",\\n \\"NodeContent\\": \\"{\\\\\\\\\\\\\\"dbList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":177****}\\\\\\" }\\",\\n \\"TimeVariables\\": \\"{\\\\\\\\\\\\\\"variables\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Today\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yyyy-MM-dd|+1d\\\\\\\\\\\\\\"}]}\\",\\n \\"NodeConfig\\": \\"{\\\\\\\\\\\\\\"dbId\\\\\\\\\\\\\\":39****,\\\\\\\\\\\\\\"dbType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"locale\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sql\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/* 请确认以下SQL符合您的变更需求，务必确认无误后再提交执行 */\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`id` bigint AUTO_INCREMENT DEFAULT \'0\',\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`age` bit NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`action` varchar(150) NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`elapse_time` datetime NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\tPRIMARY KEY (`id`)\\\\\\\\\\\\\\\\n) ENGINE=InnoDB\\\\\\\\\\\\\\\\nDEFAULT CHARACTER SET=utf8;\\\\\\\\\\\\\\"}\\",\\n \\"NodeOutput\\": \\"{ \\\\\\"outputs\\\\\\":[ \\\\\\"extractMethod\\\\\\":\\\\\\"json\\\\\\" , \\\\\\"variableName\\\\\\":\\\\\\"var\\\\\\", \\\\\\"description\\\\\\":\\\\\\"demo desc\\\\\\" } ] }\\",\\n \\"GraphParam\\": \\"{\\\\\\"{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"layoutType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Horizontal\\\\\\\\\\\\\\"}\\\\\\", \\\\\\"id\\\\\\": 51***}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTaskResponse>\\n <Task>\\n <NodeName>跨库Spark SQL-1</NodeName>\\n <NodeType>SPARK_SQL</NodeType>\\n <DagId>73***</DagId>\\n <NodeContent>{\\"dbId\\":39****,\\"dbType\\":\\"mysql\\",\\"locale\\":\\"zh\\",\\"sql\\":\\"\\\\n\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\n\\\\t`id` bigint AUTO_INCREMENT DEFAULT \'0\',\\\\n\\\\t`age` bit NULL,\\\\n\\\\t`action` varchar(150) NULL,\\\\n\\\\t`elapse_time` datetime NULL,\\\\n\\\\tPRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB\\\\nDEFAULT CHARACTER SET=utf8;\\"}</NodeContent>\\n <NodeConfig>{\\"rerun\\":{\\"rerunEnable\\":false}}</NodeConfig>\\n <GraphParam>{\\"x\\":0,\\"y\\":0,\\"layoutType\\":\\"Horizontal\\"}</GraphParam>\\n </Task>\\n <RequestId>7838266C-E17B-58F4-B072-4DC356B58258</RequestId>\\n <Success>true</Success>\\n</GetTaskResponse>","errorExample":""}]',
+ 'responseParamsDescription' => 'The value of TimeVariables is a JSON string. The following section provides an example of the TimeVariables value and describes the variables:'."\n"
+ ."\n"
+ .'```JSON'."\n"
+ .'{'."\n"
+ .' "variables":['."\n"
+ .' {'."\n"
+ .' "name":"var",// The name of the variable.'."\n"
+ .' /*'."\n"
+ .' Variable format'."\n"
+ .' As shown in the example, the date can have one or more offsets, including minutes (m), hours (h), days (d), weeks (w), months (M), or years (y). The offsets are optional, and you can specify the offsets in a different order than described here. '."\n"
+ .' */'."\n"
+ .' "pattern":"yyyy-MM-dd|+0d" '."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name":"test",'."\n"
+ .' "pattern":"yyyy-MM-dd|+0d"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n",
+ 'title' => 'GetTask',
+ ],
+ 'MoveTaskFlowToScenario' => [
+ 'summary' => 'Migrates a task flow to a specified business scenario.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '148613',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the business scenario to which you want to migrate your task flow. If this parameter is set to the default value or a value that is less than or equal to 0, the task flow is migrated to the default business scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D85FD18C-4322-5D49-8C14-5A10E668F86C',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D85FD18C-4322-5D49-8C14-5A10E668F86C\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<MoveTaskFlowToScenarioResponse>\\n <RequestId>D85FD18C-4322-5D49-8C14-5A10E668F86C</RequestId>\\n <Success>true</Success>\\n</MoveTaskFlowToScenarioResponse>","errorExample":""}]',
+ 'title' => 'MoveTaskFlowToScenario',
+ ],
+ 'GetTaskFlowNotification' => [
+ 'summary' => 'Queries the notification settings for task flows.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'F19D575F-EBEA-5683-AFA3-A8F6D9A7DE03',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Notification' => [
+ 'description' => 'The notification settings specified by the user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DagNotificationFail' => [
+ 'description' => 'Indicates whether notifications for failed task flows are enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**: enabled'."\n"
+ .'* **false**: disabled'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DagNotificationSuccess' => [
+ 'description' => 'Indicates whether notifications for successful task flows are enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**: enabled'."\n"
+ .'* **false**: disabled'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DagNotificationSla' => [
+ 'description' => 'Indicates whether service level agreement (SLA) global notifications for task flows are enabled. Valid values:'."\n"
+ ."\n"
+ .'* **true**: enabled'."\n"
+ .'* **false**: disabled'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F19D575F-EBEA-5683-AFA3-A8F6D9A7DE03\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Notification\\": {\\n \\"DagNotificationFail\\": true,\\n \\"DagNotificationSuccess\\": true,\\n \\"DagNotificationSla\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTaskFlowNotificationResponse>\\n <RequestId>F19D575F-EBEA-5683-AFA3-A8F6D9A7DE03</RequestId>\\n <Success>true</Success>\\n <Notification>\\n <DagNotificationSuccess>true</DagNotificationSuccess>\\n <DagNotificationSla>true</DagNotificationSla>\\n <DagNotificationFail>true</DagNotificationFail>\\n </Notification>\\n</GetTaskFlowNotificationResponse>","errorExample":""}]',
+ 'title' => 'GetTaskFlowNotification',
+ ],
+ 'UpdateTaskName' => [
+ 'summary' => 'Updates the name of a specified task.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '147910',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '449***',
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Spark-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C4604178-3BE1-5973-ACF0-7D561AEEF3A8',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C4604178-3BE1-5973-ACF0-7D561AEEF3A8\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskNameResponse>\\n <RequestId>C4604178-3BE1-5973-ACF0-7D561AEEF3A8</RequestId>\\n <Success>true</Success>\\n</UpdateTaskNameResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskName',
+ ],
+ 'UpdateTaskOutput' => [
+ 'summary' => 'Updates the output variables for a task node.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '147898',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '14059',
+ ],
+ ],
+ [
+ 'name' => 'NodeOutput',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The output variables for the task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{“outputs”:[{"row":0, "column":-1,"combiner":","}"extractMethod":"{\\"row\\":0,\\"column\\":-1,\\"combiner\\":\\",\\"}", "variableName":"var", "description":"For demo" }]}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'AB524768-8A5F-523A-91BD-1147187FCD62',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AB524768-8A5F-523A-91BD-1147187FCD62\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateTaskOutput',
+ 'description' => 'Only nodes of single-instance SQL assignment, script code, and ECS remote command have output variables.',
+ 'requestParamsDescription' => '## Single-instance SQL assignment'."\n"
+ ."\n"
+ .'- Example of NodeOutput:```'."\n"
+ .'Variable extraction settings'."\n"
+ .' '."\n"
+ .' "row":0, // Rows. -1 indicates all rows.'."\n"
+ .' "column":-1, // Columns. -1 indicates all columns.'."\n"
+ .' '."\n"
+ .' Delimiter'."\n"
+ .' If you select all rows or columns, you must specify a connector. The returned value of the variable is a string.'."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' '."\n"
+ .' "variableName":"var", // Variable name'."\n"
+ .' "description":"For demo" // Variable description'."\n"
+ .'```'."\n"
+ ."\n\n"
+ .'## Script code /ECS remote command'."\n"
+ ."\n"
+ .'- Example of NodeOutput:```'."\n"
+ .'"extractMethod":"json", // JSON'."\n"
+ .' "variableName":"var", // Variable name'."\n"
+ .' "description":"demo desc" // Variable description'."\n"
+ .'```',
+ ],
+ 'DeleteTaskFlowEdgesByCondition' => [
+ 'summary' => 'Deletes task flow edges based on multiple conditions.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '147813',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15****',
+ ],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow edge to delete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '24***',
+ ],
+ ],
+ [
+ 'name' => 'NodeFrom',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the start node on the edge to delete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ ],
+ [
+ 'name' => 'NodeEnd',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end node of the edge to delete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '21234B66-6859-5558-9E5B-006EFE915CD0',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21234B66-6859-5558-9E5B-006EFE915CD0\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTaskFlowEdgesByConditionResponse>\\n <RequestId>21234B66-6859-5558-9E5B-006EFE915CD0</RequestId>\\n <Success>true</Success>\\n</DeleteTaskFlowEdgesByConditionResponse>","errorExample":""}]',
+ 'title' => 'DeleteTaskFlowEdgesByCondition',
+ 'description' => 'This operation is used for multi-condition query. You can call it to delete the edges of a specified task flow that meet all specified conditions.'."\n",
+ ],
+ 'ListTaskFlowEdgesByCondition' => [
+ 'summary' => 'Queries the edges of the directed acyclic graph (DAG) for a task flow based on multiple conditions.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '147812',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '24***',
+ ],
+ ],
+ [
+ 'name' => 'NodeFrom',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the start node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ ],
+ [
+ 'name' => 'NodeEnd',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'D86249CD-422F-5ACF-85BA-9187C986AE0B',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Edges' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Edge' => [
+ 'description' => 'The list of task flow edges.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'NodeEnd' => [
+ 'description' => 'The ID of the end node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '44***',
+ ],
+ 'NodeFrom' => [
+ 'description' => 'The ID of the start node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '44***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D86249CD-422F-5ACF-85BA-9187C986AE0B\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Edges\\": {\\n \\"Edge\\": [\\n {\\n \\"Id\\": 0,\\n \\"NodeEnd\\": 0,\\n \\"NodeFrom\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskFlowEdgesByConditionResponse>\\n <RequestId>D86249CD-422F-5ACF-85BA-9187C986AE0B</RequestId>\\n <Edges>\\n <Edge>\\n <NodeFrom>44***</NodeFrom>\\n <NodeEnd>44***</NodeEnd>\\n <Id>24***</Id>\\n </Edge>\\n </Edges>\\n <Success>true</Success>\\n</ListTaskFlowEdgesByConditionResponse>","errorExample":""}]',
+ 'title' => 'ListTaskFlowEdgesByCondition',
+ 'description' => 'This operation is used for multi-condition query. You can call this operation to query the edges of a specified task flow that meet all specified conditions.'."\n",
+ ],
+ 'AddTaskFlowEdges' => [
+ 'summary' => 'Creates directed edges for the existing task nodes of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '146064',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'Edges',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of edges of the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeEnd' => [
+ 'description' => 'The ID of the node where the end node of the edge is located.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '44***',
+ ],
+ 'NodeFrom' => [
+ 'description' => 'The ID of the node where the start node of the edge is located.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '44***',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E5EE2B9E-2F95-57FA-B284-CB441CEE49D6',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'EdgeIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'EdgeId' => [
+ 'description' => 'The list of task flow edge IDs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the task flow edge.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5EE2B9E-2F95-57FA-B284-CB441CEE49D6\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"EdgeIds\\": {\\n \\"EdgeId\\": [\\n 0\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'AddTaskFlowEdges',
+ 'description' => 'When you add directed edges for a task node, take note of the following limits:'."\n"
+ ."\n"
+ .'1. The endpoints of the specified edge exist in the Directed Acyclic Graph (DAG) of the task flow specified by DagId.'."\n"
+ .'2. After a backward edge is added, the DAG does not contain loops.',
+ ],
+ 'UpdateTaskFlowNameAndDesc' => [
+ 'summary' => 'Updates the name and description of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '145766',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'DagName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new name that you want to specify for the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description that you want to specify for the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'F73CCB9D-0CF3-5D3D-97B0-D852A8022663',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73CCB9D-0CF3-5D3D-97B0-D852A8022663\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowNameAndDescResponse>\\n <RequestId>F73CCB9D-0CF3-5D3D-97B0-D852A8022663</RequestId>\\n <Success>true</Success>\\n</UpdateTaskFlowNameAndDescResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowNameAndDesc',
+ ],
+ 'GetTaskFlowGraph' => [
+ 'summary' => 'Queries the Directed Acyclic Graph (DAG) of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'D9D91166-A626-5F4E-9CA6-7AB10C59DBD8',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskFlowGraph' => [
+ 'description' => 'The list of DAG variables of the task flow.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DagName' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Nodes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Node' => [
+ 'description' => 'The node list of the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15***',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '44***',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the node. For more information about the valid values for this parameter, see [NodeType parameter](~~424705~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '36',
+ ],
+ 'NodeContent' => [
+ 'description' => 'The configuration of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{ODI3OTNRVC****UHVFT29"}',
+ ],
+ 'TimeVariables' => [
+ 'description' => 'The time variables for the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"variables\\":[{\\"name\\":\\"Today\\",\\"pattern\\":\\"yyyy-MM-dd|+1d\\"}]}',
+ ],
+ 'NodeConfig' => [
+ 'description' => 'The advanced configuration of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"dbId\\":39****,\\"dbType\\":\\"mysql\\",\\"locale\\":\\"zh\\",\\"sql\\":\\"/*XXXXX*/\\\\n\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\n\\\\t`id` bigint AUTO_INCREMENT DEFAULT \'0\',\\\\n\\\\t`age` bit NULL,\\\\n\\\\t`action` varchar(150) NULL,\\\\n\\\\t`elapse_time` datetime NULL,\\\\n\\\\tPRIMARY KEY (`id`)\\\\n) ENGINE=InnoDB\\\\nDEFAULT CHARACTER SET=utf8;\\"}',
+ ],
+ 'GraphParam' => [
+ 'description' => 'The position of the node in the DAG.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"x\\":541,\\"y\\":322,\\"layoutType\\":\\"Horizontal\\"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Edges' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Edge' => [
+ 'description' => 'The list of task flow edges.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15***',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the task flow edge.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24***',
+ ],
+ 'NodeEnd' => [
+ 'description' => 'The ID of the end node on the edge.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '44***',
+ ],
+ 'NodeFrom' => [
+ 'description' => 'The ID of the start node on the edge.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '44***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'- **0**: invalid'."\n"
+ .'- **1**: not scheduled'."\n"
+ .'- **2**: to be scheduled',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'CanEdit' => [
+ 'description' => 'Indicates whether the task flow is editable. Valid values:'."\n"
+ ."\n"
+ .'- **true**: editable'."\n"
+ .'- **false**: non-editable',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9D91166-A626-5F4E-9CA6-7AB10C59DBD8\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TaskFlowGraph\\": {\\n \\"DagName\\": \\"test\\",\\n \\"Nodes\\": {\\n \\"Node\\": [\\n {\\n \\"DagId\\": 0,\\n \\"NodeId\\": 0,\\n \\"NodeName\\": \\"test\\",\\n \\"NodeType\\": 0,\\n \\"NodeContent\\": \\"{ODI3OTNRVC****UHVFT29\\\\\\"}\\",\\n \\"TimeVariables\\": \\"{\\\\\\\\\\\\\\"variables\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Today\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yyyy-MM-dd|+1d\\\\\\\\\\\\\\"}]}\\",\\n \\"NodeConfig\\": \\"{\\\\\\\\\\\\\\"dbId\\\\\\\\\\\\\\":39****,\\\\\\\\\\\\\\"dbType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"locale\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sql\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/* 请确认以下SQL符合您的变更需求，务必确认无误后再提交执行 */\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`id` bigint AUTO_INCREMENT DEFAULT \'0\',\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`age` bit NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`action` varchar(150) NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\t`elapse_time` datetime NULL,\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\tPRIMARY KEY (`id`)\\\\\\\\\\\\\\\\n) ENGINE=InnoDB\\\\\\\\\\\\\\\\nDEFAULT CHARACTER SET=utf8;\\\\\\\\\\\\\\"}\\",\\n \\"GraphParam\\": \\"{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":541,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":322,\\\\\\\\\\\\\\"layoutType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Horizontal\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"Edges\\": {\\n \\"Edge\\": [\\n {\\n \\"DagId\\": 0,\\n \\"Id\\": 0,\\n \\"NodeEnd\\": 0,\\n \\"NodeFrom\\": 0\\n }\\n ]\\n },\\n \\"Status\\": 2,\\n \\"CanEdit\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTaskFlowGraphResponse>\\n <RequestId>D9D91166-A626-5F4E-9CA6-7AB10C59DBD8</RequestId>\\n <TaskFlowGraph>\\n <Status>2</Status>\\n <DagName>testSpark</DagName>\\n <CanEdit>true</CanEdit>\\n <Edges>\\n </Edges>\\n <Nodes>\\n <Node>\\n <NodeName>Lindorm Spark-1</NodeName>\\n <TimeVariables>{\\"variables\\":[{\\"name\\":\\"my_bizdate\\",\\"pattern\\":\\"yyyy-MM-dd|+6d\\"}]}</TimeVariables>\\n <NodeType>LINDORM_SPARK</NodeType>\\n <NodeId>44***</NodeId>\\n <DagId>15***</DagId>\\n <NodeContent>ODI3OTNRVC****UHVFT29</NodeContent>\\n <GraphParam>{\\"x\\":254,\\"y\\":239,\\"layoutType\\":\\"Horizontal\\"}</GraphParam>\\n </Node>\\n <Node>\\n <NodeName>Lindorm Spark-2</NodeName>\\n <NodeType>LINDORM_SPARK</NodeType>\\n <NodeId>44***</NodeId>\\n <DagId>15***</DagId>\\n <GraphParam>{\\"x\\":538,\\"y\\":161,\\"layoutType\\":\\"Horizontal\\"}</GraphParam>\\n </Node>\\n <Node>\\n <NodeName>Lindorm Spark-3</NodeName>\\n <NodeType>LINDORM_SPARK</NodeType>\\n <NodeId>44***</NodeId>\\n <DagId>15***</DagId>\\n <GraphParam>{\\"x\\":541,\\"y\\":322,\\"layoutType\\":\\"Horizontal\\"}</GraphParam>\\n </Node>\\n </Nodes>\\n </TaskFlowGraph>\\n <Success>true</Success>\\n</GetTaskFlowGraphResponse>","errorExample":""}]',
+ 'title' => 'GetTaskFlowGraph',
+ ],
+ 'UpdateTaskFlowEdges' => [
+ 'summary' => 'Updates the start node and end node of multiple edges at a time for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '146068',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The task flow ID. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'Edges',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of updated task flow edges.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '24***',
+ ],
+ 'NodeEnd' => [
+ 'description' => 'The ID of the end node of the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '44***',
+ ],
+ 'NodeFrom' => [
+ 'description' => 'The ID of the start node of the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '44***',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '93FC1AE1-EC54-52B1-B146-650180FB82E8',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93FC1AE1-EC54-52B1-B146-650180FB82E8\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UpdateTaskFlowEdges',
+ 'description' => '###'."\n"
+ ."\n"
+ .'The edges can be updated only when the following conditions are met:'."\n"
+ ."\n"
+ .'1. The specified edge exists in the directed acyclic graph (DAG) of the task flow specified by DagId.'."\n"
+ .'2. The specified edge nodes exist in the DAG of the task flow specified by DagId.'."\n"
+ .'3. After the update, rings do not exist in the DAG.'."\n",
+ ],
+ 'UpdateTaskFlowOwner' => [
+ 'summary' => 'Changes the owner of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '145744',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'NewOwnerId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'description' => 'The user ID of the new owner. You can call the [GetUser](~~147098~~) or [ListUsers](~~141938~~) operation to query the user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '482C61C1-2537-5BFB-8E58-34D9F17AD3C3',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"482C61C1-2537-5BFB-8E58-34D9F17AD3C3\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowOwnerResponse>\\n <RequestId>482C61C1-2537-5BFB-8E58-34D9F17AD3C3</RequestId>\\n <Success>true</Success>\\n</UpdateTaskFlowOwnerResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowOwner',
+ 'description' => 'Note: The new owner of the task flow must belong to the same tenant as the previous owner.'."\n",
+ ],
+ 'UpdateTaskFlowSchedule' => [
+ 'summary' => 'Updates the scheduling properties for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '145506',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'ScheduleSwitch',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable scheduling. Valid values:'."\n"
+ ."\n"
+ .'* **Enable**'."\n"
+ .'* **Disable**'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Disable'."\n",
+ ],
+ ],
+ [
+ 'name' => 'CronBeginDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The start of the time range for scheduling.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CronBeginDate_test',
+ ],
+ ],
+ [
+ 'name' => 'CronEndDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range for scheduling.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CronEndDate_test',
+ ],
+ ],
+ [
+ 'name' => 'ScheduleParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The event scheduling configuration. The value of this parameter is a JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ScheduleParam_test',
+ ],
+ ],
+ [
+ 'name' => 'CronStr',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cron expression for timed scheduling.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CronStr_test',
+ ],
+ ],
+ [
+ 'name' => 'TriggerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The mode in which the task flow is triggered. Valid values:'."\n"
+ ."\n"
+ .'* **Cron**: The task flow is triggered based on timed scheduling.'."\n"
+ .'* **Event**: The task flow is triggered by events.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Event',
+ ],
+ ],
+ [
+ 'name' => 'CronType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the scheduling cycle. Valid values:'."\n"
+ ."\n"
+ .'* **MINUTE**: scheduling by minute'."\n"
+ .'* **HOUR**: scheduling by hour'."\n"
+ .'* **DAY**: scheduling by day'."\n"
+ .'* **WEEK**: scheduling by week'."\n"
+ .'* **MONTH**: scheduling by month'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'HOUR',
+ ],
+ ],
+ [
+ 'name' => 'TimeZoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time zone. The default time zone is UTC+8 (Asia/Shanghai).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Asia/Shanghai',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7BF38A13-C181-5B5E-97F1-8643F8A10093',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF38A13-C181-5B5E-97F1-8643F8A10093\\",\\n \\"ErrorCode\\": \\"InvalidParameterValid\\",\\n \\"ErrorMessage\\": \\"InvalidParameterValid\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowScheduleResponse>\\n <RequestId>7BF38A13-C181-5B5E-97F1-8643F8A10093</RequestId>\\n <ErrorCode>InvalidParameterValid</ErrorCode>\\n <ErrorMessage>InvalidParameterValid</ErrorMessage>\\n <Success>true</Success>\\n</UpdateTaskFlowScheduleResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowSchedule',
+ 'description' => 'You can call this operation to update the scheduling properties for a task flow in the editing state. You can configure a **timed scheduling** task flow or an **event scheduling** task flow. When you configure a **timed scheduling** task flow, you can choose from one-time scheduling or periodic scheduling. When you configure an **event scheduling** task flow, you can subscribe to task flows or task flow nodes.****\\'."\n"
+ .'After you update the scheduling properties, you need to publish and deploy the task flow again. The new task flow instance will run based on the updated scheduling properties.'."\n",
+ 'requestParamsDescription' => '### Note about scheduling configuration parameters'."\n"
+ ."\n"
+ .'When you configure a timed scheduling task flow, you can choose from one-time scheduling or periodic scheduling.'."\n"
+ ."\n"
+ .'The following parameters are required:'."\n"
+ ."\n"
+ .'* ScheduleSwitch: True'."\n"
+ .'* TriggerType: Cron'."\n"
+ .'* CronBeginDate'."\n"
+ .'* CronEndDate'."\n"
+ .'* CronStr'."\n"
+ .'* CronType'."\n"
+ .'* ScheduleParam: The task can be run by day, week, month, or only once.'."\n"
+ ."\n"
+ .'The following section provides examples:'."\n"
+ ."\n"
+ .'**Scheduling by day:**'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "triggerType":"0",'."\n"
+ .' "dateTime":"00:00"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**Scheduling by week:** "1" for Sunday, "2" for Monday, ..., and "7" for Saturday.'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "triggerType":"0",'."\n"
+ .' "dateWeek":['."\n"
+ .' "1",'."\n"
+ .' "5"'."\n"
+ .' ],'."\n"
+ .' "weekTime":"00:00"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**Scheduling by month:**'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "triggerType":"0",'."\n"
+ .' "dateMonth":"1",'."\n"
+ .' "MonthTime":"00:00"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**Scheduling once:**'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "triggerType":"1",'."\n"
+ .' "specificTime":"2022-09-02 00:00"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**Parameter description**'."\n"
+ ."\n"
+ .'1. CronStr: CronStr defines how a task flow is scheduled.'."\n"
+ .'2. CronBeginDate and CronEndDate: For periodic scheduling, CronBeginDate, CronEndDate, and CronStr together define task flow scheduling. If the time specified by CronStr is within the time range between CronBeginDate and CronEndDate, the task is triggered.'."\n"
+ .'3. CronType: This is used for verification. Enter a value based on the scheduling cycle specified by CronStr.'."\n"
+ .'4. ScheduleParam: Enter a value based on the scheduling configuration specified by CronStr.'."\n"
+ ."\n"
+ .'**Event Scheduling** (automatically triggered across task flows)'."\n"
+ ."\n"
+ .'The following parameters are required:'."\n"
+ ."\n"
+ .'* ScheduleSwitch: True'."\n"
+ .'* TriggerType: Event'."\n"
+ .'* ScheduleParam'."\n"
+ ."\n"
+ .'The following section provides examples:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "triggerType":"2" // The scheduling type. The value 2 indicates event scheduling.'."\n"
+ .' "deps":[ // The subscription configurations for task flows and task nodes.'."\n"
+ .' {'."\n"
+ .' "eventType":1, // The type of the subscription. The value 0 indicates subscription to task flows. The value 1 indicates subscription to task nodes.'."\n"
+ .' "lisDagId":12345, // The task flow to which the subscribed node belongs.'."\n"
+ .' "lisNodeId":2134 // The ID of the node to which you subscribe.'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "eventType":0,'."\n"
+ .' "lisDagId":12343 // The ID of the task flow to which you subscribe.'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "eventType":0,'."\n"
+ .' "lisDagId":23456'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "maxWait":21600 // The maximum waiting time before all the preceding task flows or nodes to which you subscribe run.'."\n"
+ .'}'."\n"
+ .'```'."\n",
+ ],
+ 'UpdateTaskFlowRelations' => [
+ 'summary' => 'Fully updates the edges of a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '145901',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'Edges',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of task flow edges to be updated.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '24***',
+ ],
+ 'NodeEnd' => [
+ 'description' => 'The ID of the end node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ 'NodeFrom' => [
+ 'description' => 'The ID of the start node on the edge.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '44***',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '15D9E71C-405B-57D7-BE6E-707C2C7A8E0B',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15D9E71C-405B-57D7-BE6E-707C2C7A8E0B\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowRelationsResponse>\\n <RequestId>15D9E71C-405B-57D7-BE6E-707C2C7A8E0B</RequestId>\\n <Success>true</Success>\\n</UpdateTaskFlowRelationsResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowRelations',
+ 'description' => 'You can call this operation to perform a full update. For incremental updates, see AddTaskFlowEdges, UpdateTaskFlowEdges, and DeleteTaskFlowEdgesByMultiCondition.'."\n",
+ ],
+ 'UpdateTaskFlowNotification' => [
+ 'summary' => 'Updates the notification settings for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '147858',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15***',
+ ],
+ ],
+ [
+ 'name' => 'DagNotificationFail',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable notifications for failed task flows. Notifications are disabled by default. You can enable notifications based on your business requirements.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DagNotificationSuccess',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable notifications for successful task flows. Notifications are disabled by default. You can enable notifications based on your business requirements.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DagNotificationSla',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable SLA global notifications for task flows. Notifications are disabled by default. You can enable notifications based on your business requirements.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '3BDC762F-2525-5E47-8748-D6C58BDB3B38',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BDC762F-2525-5E47-8748-D6C58BDB3B38\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskFlowNotificationResponse>\\n <RequestId>3BDC762F-2525-5E47-8748-D6C58BDB3B38</RequestId>\\n <Success>true</Success>\\n</UpdateTaskFlowNotificationResponse>","errorExample":""}]',
+ 'title' => 'UpdateTaskFlowNotification',
+ ],
+ 'ListTasksInTaskFlow' => [
+ 'summary' => 'Queries the tasks in a specified task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '145478',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '32***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '8B36B063-6B7D-5595-9FCF-3844B7B7ACD4',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tasks' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Task' => [
+ 'description' => 'The tasks in the task flow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Cross-Database Spark SQL-1',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the node. For more information about the valid values for this parameter, see [NodeType parameter](~~424705~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'SPARK_SQL',
+ ],
+ 'NodeContent' => [
+ 'description' => 'The configuration for the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{ "dbId":123***, "sql":"", "dbType":"polardb" }',
+ ],
+ 'TimeVariables' => [
+ 'description' => 'The time variables configured for the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"variables\\":[{\\"name\\":\\"test1\\",\\"pattern\\":\\"yyyy-MM-dd',
+ ],
+ 'NodeConfig' => [
+ 'description' => 'The advanced configuration for the node.'."\n",
+ 'type' => 'string',
+ 'example' => '{ "rerun":{ "rerunEnable":true, "rerunCount":1, "rerunInterval":10 // }}',
+ ],
+ 'NodeOutput' => [
+ 'description' => 'The output variables for the task.'."\n",
+ 'type' => 'string',
+ 'example' => '{ "outputs":[{ { "row":0, "column":-1, "combiner":"," } "extractMethod":"{\\"row\\":0,\\"column\\":-1,\\"combiner\\":\\",\\"}", "variableName":"var", "description":"For demo"} ] }',
+ ],
+ 'GraphParam' => [
+ 'description' => 'The position of the node on the Directed Acyclic Graph (DAG).'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"x\\":435,\\"y\\":192,\\"layoutType\\":\\"Horizontal\\"}',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '92***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8B36B063-6B7D-5595-9FCF-3844B7B7ACD4\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"任务流不存在或没有权限\\",\\n \\"Success\\": true,\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"NodeName\\": \\"Cross-Database Spark SQL-1\\",\\n \\"NodeType\\": \\"SPARK_SQL\\",\\n \\"NodeContent\\": \\"{ \\\\\\"dbId\\\\\\":123456, // 数据库Id \\\\\\"sql\\\\\\":\\\\\\"/* 请使用当前节点所选择的数据库语法编写SQL */\\\\\\", // sql语句 \\\\\\"dbType\\\\\\":\\\\\\"polardb\\\\\\" // 数据库类型 }\\",\\n \\"TimeVariables\\": \\"{ \\\\\\"variables\\\\\\":[ // \\\\\\"variables\\\\\\"为固定值 { \\\\\\"name\\\\\\":\\\\\\"var\\\\\\", // name指定变量名 \\\\\\"pattern\\\\\\":\\\\\\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\\\\\\" // 见后面解释 } ] }\\",\\n \\"NodeConfig\\": \\"{ \\\\\\"rerun\\\\\\":{ // 必填固定值 \\\\\\"rerunEnable\\\\\\":true, // 是否开启重跑 \\\\\\"rerunCount\\\\\\":1, // 重跑次数 \\\\\\"rerunInterval\\\\\\":10 // 重跑间隔 } }\\",\\n \\"NodeOutput\\": \\"{ \\\\\\"outputs\\\\\\":[ { /* 变量提取设置 { \\\\\\"row\\\\\\":0, // 行，-1为所有行 \\\\\\"column\\\\\\":-1, // 列，-1为所有列 /* 分隔符 当选中所有行或所有列时，需要指定连接符。变量返回值为字符串 */ \\\\\\"combiner\\\\\\":\\\\\\",\\\\\\" } */ \\\\\\"extractMethod\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"row\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"column\\\\\\\\\\\\\\":-1,\\\\\\\\\\\\\\"combiner\\\\\\\\\\\\\\":\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"}\\\\\\", \\\\\\"variableName\\\\\\":\\\\\\"var\\\\\\", // 变量名 \\\\\\"description\\\\\\":\\\\\\"For demo\\\\\\" // 变量介绍 } ] }\\",\\n \\"GraphParam\\": \\"{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":435,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":192,\\\\\\\\\\\\\\"layoutType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Horizontal\\\\\\\\\\\\\\"}\\",\\n \\"NodeId\\": \\"92***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTasksInTaskFlowResponse>\\n <RequestId>8B36B063-6B7D-5595-9FCF-3844B7B7ACD4</RequestId>\\n <Success>true</Success>\\n <Tasks>\\n <NodeName>Cross-Database Spark SQL-1</NodeName>\\n <NodeType>SPARK_SQL</NodeType>\\n <NodeContent>{ \\"dbId\\":123456, // 数据库Id \\"sql\\":\\"/* 请使用当前节点所选择的数据库语法编写SQL */\\", // sql语句 \\"dbType\\":\\"polardb\\" // 数据库类型 }</NodeContent>\\n <TimeVariables>{ \\"variables\\":[ // \\"variables\\"为固定值 { \\"name\\":\\"var\\", // name指定变量名 \\"pattern\\":\\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\\" // 见后面解释 } ] }</TimeVariables>\\n <NodeConfig>{ \\"rerun\\":{ // 必填固定值 \\"rerunEnable\\":true, // 是否开启重跑 \\"rerunCount\\":1, // 重跑次数 \\"rerunInterval\\":10 // 重跑间隔 } }</NodeConfig>\\n <NodeOutput>{ \\"outputs\\":[ { /* 变量提取设置 { \\"row\\":0, // 行，-1为所有行 \\"column\\":-1, // 列，-1为所有列 /* 分隔符 当选中所有行或所有列时，需要指定连接符。变量返回值为字符串 */ \\"combiner\\":\\",\\" } */ \\"extractMethod\\":\\"{\\\\\\"row\\\\\\":0,\\\\\\"column\\\\\\":-1,\\\\\\"combiner\\\\\\":\\\\\\",\\\\\\"}\\", \\"variableName\\":\\"var\\", // 变量名 \\"description\\":\\"For demo\\" // 变量介绍 } ] }</NodeOutput>\\n <GraphParam>{\\\\\\"x\\\\\\":435,\\\\\\"y\\\\\\":192,\\\\\\"layoutType\\\\\\":\\\\\\"Horizontal\\\\\\"}</GraphParam>\\n <NodeId>92***</NodeId>\\n </Tasks>\\n</ListTasksInTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'ListTasksInTaskFlow',
+ ],
+ 'CreateTaskFlow' => [
+ 'summary' => 'Creates a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '144894',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Dag_Name',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zht_test',
+ ],
+ ],
+ [
+ 'name' => 'ScenarioId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2**',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '19DA51A9-AC3E-5C36-8351-07EBCD2B89A1',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'User can not access to Tenant [1]',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19DA51A9-AC3E-5C36-8351-07EBCD2B89A1\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"User can not access to Tenant [1]\\",\\n \\"Success\\": true,\\n \\"DagId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateTaskFlowResponse>\\n <RequestId>19DA51A9-AC3E-5C36-8351-07EBCD2B89A1</RequestId>\\n <Success>true</Success>\\n <DagId>33***</DagId>\\n</CreateTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'CreateTaskFlow',
+ 'requestParamsDescription' => 'DagName is unique to each task flow. If the DagName you specify already exists, the request fails.'."\n",
+ ],
+ 'SuspendTaskFlowInstance' => [
+ 'summary' => 'Suspends a task flow instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '145426',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '47****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '028BF827-3801-5869-8548-F4A039256305',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"028BF827-3801-5869-8548-F4A039256305\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SuspendTaskFlowInstanceResponse>\\n <RequestId>028BF827-3801-5869-8548-F4A039256305</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</SuspendTaskFlowInstanceResponse>","errorExample":""}]',
+ 'title' => 'SuspendTaskFlowInstance',
+ ],
+ 'ReRunTaskFlowInstance' => [
+ 'summary' => 'Reruns a task flow instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '145425',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '极度限流API，无法跑通自动化测试',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '47****',
+ ],
+ ],
+ [
+ 'name' => 'DagVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version number of the task flow. You can call the ListTaskFlowVersions operation to query the version number of the task flow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '8CFF2295-8249-5287-B888-DBD4F0D76CB0',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8CFF2295-8249-5287-B888-DBD4F0D76CB0\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ReRunTaskFlowInstanceResponse>\\n <RequestId>8CFF2295-8249-5287-B888-DBD4F0D76CB0</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</ReRunTaskFlowInstanceResponse>","errorExample":""}]',
+ 'title' => 'ReRunTaskFlowInstance',
+ ],
+ 'MakeTaskFlowInstanceSuccess' => [
+ 'summary' => 'Sets the status of a task flow to "Successful".',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '145423',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '47****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '028BF827-3801-5869-8548-F4A039256304',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"028BF827-3801-5869-8548-F4A039256304\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<MakeTaskFlowInstanceSuccessResponse>\\n <RequestId>028BF827-3801-5869-8548-F4A039256304</RequestId>\\n <Success>true</Success>\\n</MakeTaskFlowInstanceSuccessResponse>","errorExample":""}]',
+ 'title' => 'MakeTaskFlowInstanceSuccess',
+ ],
+ 'DeleteTask' => [
+ 'summary' => 'Deletes a task in a specified task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '145358',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the node you want to delete.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '54****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '3B460770-40D9-5F07-B68A-173D1D708B72',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unknown server error',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3B460770-40D9-5F07-B68A-173D1D708B72\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTaskResponse>\\n <RequestId>3B460770-40D9-5F07-B68A-173D1D708B72</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>Unknown server error</ErrorMessage>\\n <Success>true</Success>\\n</DeleteTaskResponse>","errorExample":""}]',
+ 'title' => 'DeleteTask',
+ ],
+ 'PublishAndDeployTaskFlow' => [
+ 'summary' => 'Publishes and deploys a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '145472',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'VersionComments',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the version.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vc_test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '64E26249-B61F-51C6-B6DF-47EFF50128CC',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'Unknown server error',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the deployment record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12**',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7160423-2A83-592B-97E2-D8AE7B11C520\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"Unknown server error\\",\\n \\"Success\\": true,\\n \\"DeployId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<PublishAndDeployTaskFlowResponse>\\n <RequestId>A7160423-2A83-592B-97E2-D8AE7B11C520</RequestId>\\n <DeployId>61***</DeployId>\\n <Success>true</Success>\\n</PublishAndDeployTaskFlowResponse>","errorExample":""}]',
+ 'title' => 'PublishAndDeployTaskFlow',
+ ],
+ 'StopTaskFlowInstance' => [
+ 'summary' => 'Stops a task flow instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '145428',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'DagInstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution record of the task flow. You can call the [ListTaskFlowInstance](~~424689~~) operation to query the execution record ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '47****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '028BF827-3801-5869-8548-F4A039256308',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"028BF827-3801-5869-8548-F4A039256308\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopTaskFlowInstanceResponse>\\n <RequestId>028BF827-3801-5869-8548-F4A039256308</RequestId>\\n <ErrorCode>UnknownError</ErrorCode>\\n <ErrorMessage>UnknownError</ErrorMessage>\\n <Success>true</Success>\\n</StopTaskFlowInstanceResponse>","errorExample":""}]',
+ 'title' => 'StopTaskFlowInstance',
+ ],
+ 'CreateTask' => [
+ 'summary' => 'Creates a task node for a task flow.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '145318',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the [Manage DMS tenants](~~181330~~) topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7***',
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the node that you want to create.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'zhttest',
+ ],
+ ],
+ [
+ 'name' => 'NodeType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the node that you want to create. For more information about the valid values for this parameter, see [NodeType parameter](~~424705~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '36',
+ ],
+ ],
+ [
+ 'name' => 'NodeContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration of the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'TimeVariables',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The time variables configured for the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'NodeOutput',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The output variables configured for the task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'GraphParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The position of the node on the Directed Acyclic Graph (DAG).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'CFD8FE00-36D9-4C1B-940D-65A7B73D9066',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the task node returned when the task was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFD8FE00-36D9-4C1B-940D-65A7B73D9066\\",\\n \\"ErrorCode\\": \\"InvalidParameterValid\\",\\n \\"ErrorMessage\\": \\"InvalidParameterValid\\",\\n \\"Success\\": true,\\n \\"NodeId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateTaskResponse>\\n <RequestId>CFD8FE00-36D9-4C1B-940D-65A7B73D9066</RequestId>\\n <ErrorCode>InvalidParameterValid</ErrorCode>\\n <ErrorMessage>InvalidParameterValid</ErrorMessage>\\n <Success>true</Success>\\n</CreateTaskResponse>","errorExample":""}]',
+ 'title' => 'CreateTask',
+ 'requestParamsDescription' => '# Description of node-related parameters'."\n"
+ ."\n"
+ .'The configuration of a node varies based on the node type. This topic is a supplementary description of task node-related operations, such as CreateTask and UpdateTaskOutput. The NodeParam, NodeContent, and GraphParam parameters apply to all task node-related operations.\\'."\n"
+ .'Only nodes such as single-instance SQL assignment, script code, and Elastic Compute Service (ECS) remote command have output variables. The configurations of output variables vary based on the node type. For more information, see the related topic of the UpdateTaskOutput operation.'."\n"
+ ."\n"
+ .'## SQL for single instance'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 1'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "dbId":123456, // The database ID.'."\n"
+ .' "sql":"/* Use the database syntax for the current node to write SQL statements */", // The SQL statement.'."\n"
+ .' "dbType":"lindorm_sql" // The database type.'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Script'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 28'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeOutput'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "outputs":['."\n"
+ .' {'."\n"
+ .' "extractMethod":"json", // The value is in the JSON format.'."\n"
+ .' "variableName":"var", // The name of the variable.'."\n"
+ .' "description":"demo desc" // The description of the variable.'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "regionId":"cn-hangzhou", // The region ID.'."\n"
+ .' "gatewayId":"dg-xxxxxxxxxxxxxx", // The gateway ID.'."\n"
+ .' "gatewayInstanceId":"dg-node-xxxxxxxxxxxxxx", // The ID of the gateway instance.'."\n"
+ .' "scriptFileName":"demo.sh", // The file name.'."\n"
+ .' "args":[ // The running parameters.'."\n"
+ .' "-n value",'."\n"
+ .' "-n1 value1"'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Lock-free data change'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 24'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "dbId":123456, // The database ID.'."\n"
+ .' "sql":"/* Use the database syntax for the current node to write SQL statements */", // The SQL statement.'."\n"
+ .' "dbType":"polardb" // The database type.'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## SQL assignment for single instance'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 32'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeOutput:'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "outputs":['."\n"
+ .' {'."\n"
+ .' /*'."\n"
+ .' // The variable extraction settings.'."\n"
+ .' {'."\n"
+ .' "row":0, // Rows. A value of -1 indicates all rows.'."\n"
+ .' "column":-1, // Columns. A value of -1 indicates all columns.'."\n"
+ .' "combiner":"," // The delimiter. If you select all rows or columns, you must specify a delimiter. The returned value of the variable is a string.'."\n"
+ .' }'."\n"
+ .' */'."\n"
+ .' "extractMethod":"{\\"row\\":0,\\"column\\":-1,\\"combiner\\":\\",\\"}", '."\n"
+ .' "variableName":"var", // The name of the variable.'."\n"
+ .' "description":"For demo" // The description of the variable.'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "dbId":123456, // The database ID.'."\n"
+ .' "sql":"/* Use the database syntax for the current node to write SQL statements. Only SELECT statements are supported. By default, the maximum number of rows returned is 30. *", // The SQL statement.'."\n"
+ .' "dbType":"lindorm_cql" // The database type.'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Dependency check'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 2'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "dependentDAGId":132, // Dependency object: task flow.'."\n"
+ .' "dependentNodeId":"", // Dependency object: a single node. By default, the dependency object is the specified task flow.'."\n"
+ .' "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // The offset of the start time.'."\n"
+ .' "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d +0h+0m", // The offset of the end time.'."\n"
+ .' "multiSuccessStrategy":2, // The instance check policy. A value of 0 specifies that the most previous node is successful. A value of 1 specifies that all nodes are successful. A value of 2 specifies that the specified node is successful'."\n"
+ .' "multiSuccessStrategyIndex":1 // Instance check policy: The node x+1 is successful.'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Status check of a time column in a table'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 2'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "dependentDAGId":132, // Dependency object: task flow.'."\n"
+ .' "dependentNodeId":"", // Dependency object: a single node. By default, the dependency object is the specified task flow.'."\n"
+ .' "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // The offset of the start time.'."\n"
+ .' "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d +0h+0m", // The offset of the end time.'."\n"
+ .' "multiSuccessStrategy":2, // The instance check policy. A value of 0 specifies that the most previous node is successful. A value of 1 specifies that all nodes are successful. A value of 2 specifies that the specified node is successful'."\n"
+ .' "multiSuccessStrategyIndex":1 // Instance check policy: The node x+1 is successful.'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## SQL status check'."\n"
+ ."\n"
+ .'* DagId'."\n"
+ .'* NodeName'."\n"
+ .'* NodeType: 25'."\n"
+ .'* NodeParam'."\n"
+ .'* GraphParam'."\n"
+ .'* NodeContent:'."\n"
+ ."\n"
+ .'```Json'."\n"
+ .'{'."\n"
+ .' "dbId":123456,'."\n"
+ .' "sql":"/* Use the database syntax for the current node to write SQL statements*/ \\n\\n select 1 from abc",'."\n"
+ .' "dbType":"lindorm_cql"'."\n"
+ .'}'."\n"
+ .'```'."\n",
+ ],
+ 'UpdateTaskContentV2' => [
+ 'summary' => 'Updates the node content in large SQL files.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '145901',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task node. You can call the [GetTaskInstanceRelation](~~424711~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '449***',
+ ],
+ ],
+ [
+ 'name' => 'NodeContent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node configurations after modification.'."\n"
+ ."\n"
+ .'> We recommend that you change the SQL type from SELECT to INSERT/CREATE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{ "dbId":12****, "sql":"select * from test_table", "dbType":"lindorm_sql" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'Id of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773',
+ 'title' => 'Id of the request',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ 'title' => 'Schema of Response',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\\\n\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateTaskContentV2',
+ 'description' => 'You can call this operation to modify node configurations.'."\n",
+ ],
+ 'TryRunTaskFlow' => [
+ 'summary' => 'Tests the task flow of task orchestration.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdms19SL1H',
+ ],
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '开启了流控配置，无法短时间调用多次',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The task flow ID. You can call the [ListTaskFlow](~~424565~~) or [ListLhTaskFlowAndScenario](~~426672~~) operation to query the ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '11****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '9997630E-1993-5E6D-9DF1-4EFEE755FE31',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed. Value values:'."\n"
+ ."\n"
+ .'* If the request was successful, the **ErrorCode** parameter is not returned.'."\n"
+ .'* If the request failed, **ErrorCode** is returned. For more information, see the **Error codes** section in this topic.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID of the order.'."\n",
+ 'type' => 'string',
+ 'example' => '169****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9997630E-1993-5E6D-9DF1-4EFEE755FE31\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"InstanceId\\": \\"169****\\"\\n}","type":"json"}]',
+ 'title' => 'TryRunTaskFlow',
+ 'description' => '### [](#)Usage notes'."\n"
+ ."\n"
+ .'An edge can be created only when the following conditions are met:'."\n"
+ ."\n"
+ .'1. The start and end nodes of the edge exist in the directed acyclic graph (DAG) of the task flow specified by DagId.'."\n"
+ .'2. After the edge is created, the DAG does not contain loops.'."\n",
+ ],
+ 'CreateLakeHouseSpace' => [
+ 'summary' => 'Creates a workspace for data warehouse development in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '130576',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SpaceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_space',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Mode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The mode in which the workspace runs. Valid values:'."\n"
+ ."\n"
+ .'* **0**: basic mode. This mode is unavailable.'."\n"
+ .'* **1**: standard mode.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'DwDbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database. Valid values:'."\n"
+ ."\n"
+ .'* **14**: AnalyticDB for MySQL'."\n"
+ .'* **18**: AnalyticDB for PostgreSQL'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '14',
+ ],
+ ],
+ [
+ 'name' => 'SpaceConfig',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **skipManualRunCheck**: No security rule check is required in the trial run phase.'."\n"
+ .'* **skipPublishApprove**: No approval is required for publishing and O\\&M.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{\\"skipManualRunCheck\\":true,\\"skipPublishApprove\\":true}',
+ ],
+ ],
+ [
+ 'name' => 'DevDbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the development database. You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2435****',
+ ],
+ ],
+ [
+ 'name' => 'ProdDbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the production database. You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2442****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SpaceId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '24',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'InvalidParameterValid',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid parameters: space name,mode,prod db id,db type,config.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SpaceId\\": 24,\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"InvalidParameterValid\\",\\n \\"ErrorMessage\\": \\"Invalid parameters: space name、mode、prod db id、db type、config.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateLakeHouseSpaceResponse>\\n <RequestId>7FAD400F-7A5C-4193-8F9A-39D86C4F0231</RequestId>\\n <SpaceId>24</SpaceId>\\n <Success>true</Success>\\n</CreateLakeHouseSpaceResponse>","errorExample":""}]',
+ 'title' => 'CreateLakeHouseSpace',
+ 'description' => '* The workspace name must be unique within a tenant. If a workspace with the same name already exists within the tenant, the call may fail.'."\n"
+ .'* You can call the [GetLhSpaceByName](~~424379~~) operation to query whether a workspace with a specific name already exists as a DMS administrator or database administrator (DBA).'."\n",
+ ],
+ 'GetLhSpaceByName' => [
+ 'summary' => 'Queries the information about a workspace based on the workspace name in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SpaceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_space',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'LakehouseSpace' => [
+ 'description' => 'The workspace for data warehouse development.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'SpaceName' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_space',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => '51***',
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the tenant to which the workspace belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '3***',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Mode' => [
+ 'description' => 'The mode in which the workspace runs. Valid values:'."\n"
+ ."\n"
+ .'* **0**: basic mode'."\n"
+ .'* **1**: standard mode'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DwDbType' => [
+ 'description' => 'The type of the database. Valid values:'."\n"
+ ."\n"
+ .'* **14**: AnalyticDB for MySQL'."\n"
+ .'* **18**: AnalyticDB for PostgreSQL'."\n",
+ 'type' => 'string',
+ 'example' => '14',
+ ],
+ 'SpaceConfig' => [
+ 'description' => 'The configuration of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **skipManualRunCheck**: No security rule check is required in the trial run phase.'."\n"
+ .'* **skipPublishApprove**: No approval is required for publishing and O\\&M.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"skipManualRunCheck\\":true,\\"skipPublishApprove\\":true}',
+ ],
+ 'DevDbId' => [
+ 'description' => 'The ID of the development database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2435****',
+ ],
+ 'ProdDbId' => [
+ 'description' => 'The ID of the production database.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2442****',
+ ],
+ 'IsDeleted' => [
+ 'description' => 'Indicates whether the workspace is deleted. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The workspace is deleted.'."\n"
+ .'* **false**: The workspace is not deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"LakehouseSpace\\": {\\n \\"Id\\": 1,\\n \\"SpaceName\\": \\"test_space\\",\\n \\"CreatorId\\": \\"51***\\",\\n \\"TenantId\\": \\"3***\\",\\n \\"Description\\": \\"test\\",\\n \\"Mode\\": 1,\\n \\"DwDbType\\": \\"14\\",\\n \\"SpaceConfig\\": \\"{\\\\\\\\\\\\\\"skipManualRunCheck\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"skipPublishApprove\\\\\\\\\\\\\\":true}\\",\\n \\"DevDbId\\": 0,\\n \\"ProdDbId\\": 0,\\n \\"IsDeleted\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetLhSpaceByNameResponse>\\n <RequestId>FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8</RequestId>\\n <LakehouseSpace>\\n <TenantId>3***</TenantId>\\n <IsDeleted>false</IsDeleted>\\n <SpaceName>test_space</SpaceName>\\n <CreatorId>51***</CreatorId>\\n <Mode>1</Mode>\\n <DwDbType>14</DwDbType>\\n <Id>1</Id>\\n <SpaceConfig>{\\"skipManualRunCheck\\":true,\\"skipPublishApprove\\":true}</SpaceConfig>\\n <DevDbId>2435****</DevDbId>\\n <ProdDbId>2442****</ProdDbId>\\n </LakehouseSpace>\\n <Success>true</Success>\\n</GetLhSpaceByNameResponse>","errorExample":""}]',
+ 'title' => 'GetLhSpaceByName',
+ 'description' => 'You are a DMS administrator or a database administrator (DBA).'."\n",
+ ],
+ 'DeleteLakeHouseSpace' => [
+ 'summary' => 'Deletes a workspace.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '132905',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SpaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace. You can call the [GetLhSpaceByName](~~424379~~) operation to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '24',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'E76DD2E7-EBAC-5724-B163-19AAC233F8F2',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'NoPermission',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'You are not authorized to perform this operation.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E76DD2E7-EBAC-5724-B163-19AAC233F8F2\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"ErrorMessage\\": \\"You are not authorized to perform this operation.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLakeHouseSpaceResponse>\\n <RequestId>E76DD2E7-EBAC-5724-B163-19AAC233F8F2</RequestId>\\n <Success>true</Success>\\n</DeleteLakeHouseSpaceResponse>","errorExample":""}]',
+ 'title' => 'DeleteLakeHouseSpace',
+ ],
+ 'ListLhTaskFlowAndScenario' => [
+ 'summary' => 'Queries the information about task flows in the business scenarios of a workspace in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '130971',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SpaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace. You can call the [GetLhSpaceByName](~~424379~~) operation to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '24',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to obtain the user ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '51****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RawDAGList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Dag' => [
+ 'description' => 'The task flows in the default business scenario.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '134137****',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'IsDeleted' => [
+ 'description' => 'Indicates whether the task flow is deleted. Valid values:'."\n"
+ ."\n"
+ .'* **true**: deleted'."\n"
+ .'* **false**: not deleted'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DemoId' => [
+ 'description' => 'The extended field. No meaning is specified for this field.'."\n",
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the latest deployment record.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12**',
+ ],
+ 'DataFlowId' => [
+ 'description' => 'The extended field. No meaning is specified for this field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '-',
+ ],
+ 'ScenarioId' => [
+ 'description' => 'The ID of the business scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2**',
+ ],
+ 'SpaceId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreatorNickName' => [
+ 'description' => 'The name of the user who creates the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'Creator_Name',
+ ],
+ 'DagOwnerNickName' => [
+ 'description' => 'The name of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'Owner_Name',
+ ],
+ 'CanEdit' => [
+ 'description' => 'Indicates whether the task flow can be modified. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The task flow can be modified.'."\n"
+ .'* **false**: The task flow cannot be modified.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invalid'."\n"
+ .'* **1**: scheduling disabled'."\n"
+ .'* **2**: waiting to be scheduled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'LatestInstanceStatus' => [
+ 'description' => 'The status of the latest execution. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invalid'."\n"
+ .'* **1**: scheduling disabled'."\n"
+ .'* **2**: waiting to be scheduled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'LatestInstanceTime' => [
+ 'description' => 'The time when the latest execution record was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2022-04-14',
+ ],
+ 'DagName' => [
+ 'description' => 'The name of the task flow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Dag_Name',
+ ],
+ 'DagOwnerId' => [
+ 'description' => 'The user ID of the task flow owner.'."\n",
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ScenarioDAGList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ScenarioDAG' => [
+ 'description' => 'The task flows in other business scenarios.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Scenario' => [
+ 'description' => 'The information about the business scenario.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ScenarioName' => [
+ 'description' => 'The name of the business scenario.',
+ 'type' => 'string',
+ 'example' => 'Scenario_2',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the business scenario.',
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the business scenario.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'DagList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Dag' => [
+ 'title' => '',
+ 'description' => 'The list of task flows.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the task flow.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9***',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the user who creates the task flow.',
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ 'IsDeleted' => [
+ 'description' => 'Indicates whether the task flow is deleted. Valid values:'."\n"
+ ."\n"
+ .'- **true**: deleted'."\n"
+ .'- **false**: not deleted',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'DemoId' => [
+ 'description' => 'The extended field. No meaning is specified for this field.',
+ 'type' => 'string',
+ 'example' => '-',
+ ],
+ 'DeployId' => [
+ 'description' => 'The ID of the latest deployment record.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12**',
+ ],
+ 'DataFlowId' => [
+ 'description' => 'The extended field. No meaning is specified for this field.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '-',
+ ],
+ 'ScenarioId' => [
+ 'description' => 'The ID of the business scenario.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2**',
+ ],
+ 'SpaceId' => [
+ 'description' => 'The ID of the workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreatorNickName' => [
+ 'description' => 'The name of the user who creates the workspace.',
+ 'type' => 'string',
+ 'example' => 'Creator_Name',
+ ],
+ 'DagOwnerNickName' => [
+ 'description' => 'The name of the task flow owner.',
+ 'type' => 'string',
+ 'example' => 'Owner_Name',
+ ],
+ 'CanEdit' => [
+ 'description' => 'Indicates whether the task flow can be modified. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The task flow can be modified.'."\n"
+ .'- **false**: The task flow cannot be modified.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the task flow. Valid values:'."\n"
+ ."\n"
+ .'- **0**: invalid'."\n"
+ .'- **1**: scheduling disabled'."\n"
+ .'- **2**: waiting to be scheduled',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'LatestInstanceStatus' => [
+ 'description' => 'The status of the latest execution. Valid values:'."\n"
+ ."\n"
+ .'- 0: invalid'."\n"
+ .'- 1: scheduling disabled'."\n"
+ .'- 2: waiting to be scheduled',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'LatestInstanceTime' => [
+ 'description' => 'The time when the latest execution record was generated.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2022-04-14',
+ ],
+ 'DagName' => [
+ 'description' => 'The name of the task flow.',
+ 'type' => 'string',
+ 'example' => 'Dag_Name',
+ ],
+ 'DagOwnerId' => [
+ 'description' => 'The user ID of the task flow owner.',
+ 'type' => 'string',
+ 'example' => '51****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '48602B78-0DDF-414C-8688-70CAB6070115',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.',
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RawDAGList\\": {\\n \\"Dag\\": [\\n {\\n \\"Id\\": 0,\\n \\"CreatorId\\": \\"51****\\",\\n \\"IsDeleted\\": false,\\n \\"DemoId\\": \\"-\\",\\n \\"DeployId\\": 0,\\n \\"DataFlowId\\": 0,\\n \\"ScenarioId\\": 0,\\n \\"SpaceId\\": 1,\\n \\"CreatorNickName\\": \\"Creator_Name\\",\\n \\"DagOwnerNickName\\": \\"Owner_Name\\",\\n \\"CanEdit\\": true,\\n \\"Status\\": 2,\\n \\"LatestInstanceStatus\\": 0,\\n \\"LatestInstanceTime\\": 0,\\n \\"DagName\\": \\"Dag_Name\\",\\n \\"DagOwnerId\\": \\"51****\\"\\n }\\n ]\\n },\\n \\"ScenarioDAGList\\": {\\n \\"ScenarioDAG\\": [\\n {\\n \\"Scenario\\": {\\n \\"ScenarioName\\": \\"Scenario_2\\",\\n \\"CreatorId\\": \\"51****\\",\\n \\"Description\\": \\"test\\"\\n },\\n \\"DagList\\": {\\n \\"Dag\\": [\\n {\\n \\"Id\\": 0,\\n \\"CreatorId\\": \\"51****\\",\\n \\"IsDeleted\\": false,\\n \\"DemoId\\": \\"-\\",\\n \\"DeployId\\": 0,\\n \\"DataFlowId\\": 0,\\n \\"ScenarioId\\": 0,\\n \\"SpaceId\\": 1,\\n \\"CreatorNickName\\": \\"Creator_Name\\",\\n \\"DagOwnerNickName\\": \\"Owner_Name\\",\\n \\"CanEdit\\": true,\\n \\"Status\\": 1,\\n \\"LatestInstanceStatus\\": 1,\\n \\"LatestInstanceTime\\": 0,\\n \\"DagName\\": \\"Dag_Name\\",\\n \\"DagOwnerId\\": \\"51****\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"48602B78-0DDF-414C-8688-70CAB6070115\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListLhTaskFlowAndScenarioResponse>\\n <RawDAGList>\\n <CreatorId>51****</CreatorId>\\n <IsDeleted>false</IsDeleted>\\n <DemoId>-</DemoId>\\n <SpaceId>1</SpaceId>\\n <CreatorNickName>Creator_Name</CreatorNickName>\\n <DagOwnerNickName>Owner_Name</DagOwnerNickName>\\n <CanEdit>true</CanEdit>\\n <Status>2</Status>\\n <LatestInstanceStatus>0</LatestInstanceStatus>\\n <DagName>Dag_Name</DagName>\\n <DagOwnerId>51****</DagOwnerId>\\n </RawDAGList>\\n <ScenarioDAGList>\\n <Scenario>\\n <ScenarioName>Scenario_2</ScenarioName>\\n <CreatorId>51****</CreatorId>\\n <Description>test</Description>\\n </Scenario>\\n <DagList>\\n <CreatorId>51****</CreatorId>\\n <IsDeleted>false</IsDeleted>\\n <DemoId>-</DemoId>\\n <SpaceId>1</SpaceId>\\n <CreatorNickName>Creator_Name</CreatorNickName>\\n <DagOwnerNickName>Owner_Name</DagOwnerNickName>\\n <CanEdit>true</CanEdit>\\n <Status>1</Status>\\n <LatestInstanceStatus>1</LatestInstanceStatus>\\n <DagName>Dag_Name</DagName>\\n <DagOwnerId>51****</DagOwnerId>\\n </DagList>\\n </ScenarioDAGList>\\n <RequestId>48602B78-0DDF-414C-8688-70CAB6070115</RequestId>\\n <Success>true</Success>\\n</ListLhTaskFlowAndScenarioResponse>","errorExample":""}]',
+ 'title' => 'ListLhTaskFlowAndScenario',
+ 'description' => '* Before you call this operation, make sure that you have the access permissions on the workspace. If you do not have the access permissions on the workspace, you can contact a DMS administrator, database administrator (DBA), or workspace administrator to add you as a member of the workspace. The [AddLhMembers](~~424759~~) operation can be called to add a workspace member.'."\n"
+ .'* If you are a DMS administrator or a workspace administrator, you can query the business scenarios and task flows related to a user in a workspace based on the user ID.'."\n",
+ ],
+ 'AddLhMembers' => [
+ 'summary' => 'Adds a workspace administrator, a workspace member, or a task flow developer in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '131032',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ObjectType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object. Valid values:'."\n"
+ ."\n"
+ .'* **0**: workspace'."\n"
+ .'* **1**: task flow'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ObjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the object.'."\n"
+ ."\n"
+ .'* If the object is a workspace, you can call the [GetLhSpaceByName](~~424379~~) operation to obtain the workspace ID.'."\n"
+ .'* If the object is a task flow, you can call the [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Members',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the users to be added.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The ID of the user to be added. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to obtain the user ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15****',
+ ],
+ 'Roles' => [
+ 'description' => 'The role. Valid values:'."\n"
+ ."\n"
+ .'* **ADMIN**: workspace administrator. You can add a workspace administrator only as a DMS administrator or a DBA.'."\n"
+ .'* **MEMBER**: workspace member.'."\n"
+ .'* **DEVELOPER**: task flow developer. Only a workspace member can be added as a task flow developer.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ADMIN',
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '31853A2B-DC9D-5B39-8492-D2AC8BCF550E',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"31853A2B-DC9D-5B39-8492-D2AC8BCF550E\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddLhMembersResponse>\\n <RequestId>31853A2B-DC9D-5B39-8492-D2AC8BCF550E</RequestId>\\n <Success>true</Success>\\n</AddLhMembersResponse>","errorExample":""}]',
+ 'title' => 'AddLhMembers',
+ 'description' => 'You must call this operation as a DMS administrator, a database administrator (DBA), or a workspace administrator.'."\n"
+ ."\n"
+ .'Usage notes:'."\n"
+ ."\n"
+ .'* Before you call this operation to add a user as a task flow developer, make sure that you have added the user as a workspace member.'."\n"
+ .'* You cannot call this operation to transfer the ownership of a task flow. To transfer the ownership of a task flow, call the [ChangLhDagOwner](~~424761~~) operation.'."\n"
+ .'* For more information about workspace roles and permissions, see [Manage permissions on a workspace](~~410893~~).'."\n",
+ ],
+ 'DeleteLhMembers' => [
+ 'summary' => 'Removes a workspace member or a task flow developer in Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '130999',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ObjectType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object. Valid values:'."\n"
+ ."\n"
+ .'* **0**: workspace'."\n"
+ .'* **1**: task flow'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ObjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the object.'."\n"
+ ."\n"
+ .'* If the object is a workspace, you can call the [GetLhSpaceByName](~~424379~~) operation to obtain the workspace ID.'."\n"
+ .'* If the object is a task flow, you can call the [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '9***',
+ ],
+ ],
+ [
+ 'name' => 'MemberIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The ID of the user to be removed. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to obtain the user ID.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '[50****,51****]',
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ 'maxItems' => 50,
+ 'minItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F1C78D32-1AFD-58AD-9DD2-C8A0896969DD',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1C78D32-1AFD-58AD-9DD2-C8A0896969DD\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLhMembersResponse>\\n <RequestId>F1C78D32-1AFD-58AD-9DD2-C8A0896969DD</RequestId>\\n <Success>true</Success>\\n</DeleteLhMembersResponse>","errorExample":""}]',
+ 'title' => 'DeleteLhMembers',
+ 'description' => 'You must call this operation as a DMS administrator, a database administrator (DBA), or a workspace administrator.'."\n"
+ ."\n"
+ .'You cannot call this operation to transfer the ownership of a task flow. To transfer the ownership of a task flow, call the [ChangLhDagOwner](~~424761~~) operation.'."\n",
+ ],
+ 'ChangeLhDagOwner' => [
+ 'summary' => 'Transfers the ownership of a task flow in a workspace of Data Management (DMS).',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '131459',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the task flow. You can call the [ListLhTaskFlowAndScenario](~~426672~~) operation to obtain the task flow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '9***',
+ ],
+ ],
+ [
+ 'name' => 'OwnerUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user to be specified as the new owner of the task flow. You can call the [ListUsers](~~141938~~) or [GetUser](~~147098~~) operation to obtain the user ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '50****',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '9997630E-1993-5E6D-9DF1-4EFEE755FE31',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => '403',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request is successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9997630E-1993-5E6D-9DF1-4EFEE755FE31\\",\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ChangeLhDagOwnerResponse>\\n <RequestId>9997630E-1993-5E6D-9DF1-4EFEE755FE31</RequestId>\\n <Success>true</Success>\\n</ChangeLhDagOwnerResponse>","errorExample":""}]',
+ 'title' => 'ChangeLhDagOwner',
+ 'description' => 'Usage notes:'."\n"
+ ."\n"
+ .'* If you call this operation to transfer the ownership of a published task flow, the ownership transfer does not take effect.'."\n"
+ .'* You can call the [ReDeployLhDagVersion](~~424712~~) operation to redeploy a published version of a task flow.'."\n",
+ ],
+ 'ListEffectiveOrders' => [
+ 'summary' => 'Queries valid orders.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'A8FE12AA-300D-5FDF-806F-C2CB99161F32',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'OrderSummary' => [
+ 'description' => 'The information about orders.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CommodityCode' => [
+ 'title' => 'DMS的商品Code'."\n"
+ .'- 中国站：dms_pre_public_cn（包年包月）、dms_post_public_cn（按量付费）'."\n"
+ .'- 国际站：dms_pre_public_intl（包年包月）、dms_post_public_intl（按量付费）',
+ 'description' => 'The commodity code of DMS.'."\n"
+ ."\n"
+ .'* dms_pre_public_cn: DMS that uses the subscription billing method'."\n"
+ .'* dms_post_public_cn: DMS that uses the pay-as-you-go billing method'."\n",
+ 'type' => 'string',
+ 'example' => 'dms_pre_public_cn'."\n",
+ ],
+ 'CommodityType' => [
+ 'title' => '商品类型'."\n"
+ .'- versionType：管控模式'."\n"
+ .'- SensitiveDataProtection：敏感数据保护',
+ 'description' => 'The type of the service.'."\n"
+ ."\n"
+ .'* **VersionType**: DMS that supports control modes'."\n"
+ .'* **SensitiveDataProtection**: DMS that supports sensitive data protection'."\n",
+ 'type' => 'string',
+ 'example' => 'VersionType',
+ ],
+ 'VersionType' => [
+ 'title' => '商品类型为管控模式时（CommodityType = versionType ），区分管控模式的类型：'."\n"
+ .'- stand：稳定变更'."\n"
+ .'- safety：安全协同',
+ 'description' => 'The control mode of DMS. Valid values:'."\n"
+ ."\n"
+ .'* **stand**: Stable Change'."\n"
+ .'* **safety**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'example' => 'safety',
+ ],
+ 'TotalQuota' => [
+ 'title' => 'OrderList订单明细额度总和',
+ 'description' => 'The sum of the number of instances that you can use DMS to manage in all orders.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12',
+ ],
+ 'OrderList' => [
+ 'title' => '订单明细',
+ 'description' => 'Details about the orders.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '订单',
+ 'description' => 'The order.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => [
+ 'title' => '购买订单ID',
+ 'description' => 'The ID of the order.'."\n",
+ 'type' => 'string',
+ 'example' => '2190037****',
+ ],
+ 'BuyerId' => [
+ 'title' => '购买用户UID',
+ 'description' => 'The UID of the user who placed the order.'."\n",
+ 'type' => 'string',
+ 'example' => '2698420314****',
+ ],
+ 'InstanceId' => [
+ 'title' => '购买商品实例ID',
+ 'description' => 'The ID of the instance for the purchased service.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-bp1xd1v866****',
+ ],
+ 'StartTime' => [
+ 'title' => '订单开始时间',
+ 'description' => 'The time when the instance is started.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-10-24 00:00:00',
+ ],
+ 'EndTime' => [
+ 'title' => '订单到期时间',
+ 'description' => 'The time when the instance expires.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-11-24 00:00:00',
+ ],
+ 'InsNum' => [
+ 'title' => '订单购买规格',
+ 'description' => 'The maximum number of database instances that you can use DMS to manage.'."\n",
+ 'type' => 'string',
+ 'example' => '7',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8FE12AA-300D-5FDF-806F-C2CB99161F32\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"OrderSummary\\": [\\n {\\n \\"CommodityCode\\": \\"包年包月\\",\\n \\"CommodityType\\": \\"VersionType\\",\\n \\"VersionType\\": \\"safety\\",\\n \\"TotalQuota\\": 12,\\n \\"OrderList\\": [\\n {\\n \\"OrderId\\": \\"2190037****\\",\\n \\"BuyerId\\": \\"2698420314****\\",\\n \\"InstanceId\\": \\"rm-bp1xd1v866****\\",\\n \\"StartTime\\": \\"2022-10-24 00:00:00\\",\\n \\"EndTime\\": \\"2022-11-24 00:00:00\\",\\n \\"InsNum\\": \\"7\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEffectiveOrdersResponse>\\n <RequestId>A8FE12AA-300D-5FDF-806F-C2CB99161F32</RequestId>\\n <Success>true</Success>\\n <OrderSummary>\\n <CommodityCode>包年包月</CommodityCode>\\n <CommodityType>VersionType</CommodityType>\\n <VersionType>safety</VersionType>\\n <TotalQuota>12</TotalQuota>\\n <OrderList>\\n <OrderId>2190037****</OrderId>\\n <BuyerId>2698420314****</BuyerId>\\n <InstanceId>rm-bp1xd1v866****</InstanceId>\\n <StartTime>2022-10-24 00:00:00</StartTime>\\n <EndTime>2022-11-24 00:00:00</EndTime>\\n <InsNum>7</InsNum>\\n </OrderList>\\n </OrderSummary>\\n</ListEffectiveOrdersResponse>","errorExample":""}]',
+ 'title' => 'ListEffectiveOrders',
+ ],
+ 'RefundPayAsYouGoOrder' => [
+ 'summary' => 'Unsubscribes from a pay-as-you-go Data Management (DMS) resource.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '购买订单ID，可通过 ListEffectiveOrders 获取，只支持按量付费订单ID',
+ 'description' => 'The order ID of the order for the pay-as-you-go resource. You can call the ListEffectiveOrders operation to query the order ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2190037****',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '售卖订单的实例ID',
+ 'description' => 'The instance ID in the sales order.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dms_pre_public_intl-sg-vf****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\"\\n}","errorExample":""},{"type":"xml","example":"<RefundPayAsYouGoOrderResponse>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <Success>true</Success>\\n</RefundPayAsYouGoOrderResponse>","errorExample":""}]',
+ 'title' => 'RefundPayAsYouGoOrder',
+ ],
+ 'BuyPayAsYouGoOrder' => [
+ 'summary' => 'Purchases a pay-as-you-go Data Management (DMS) resource.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see [View information about the current tenant](~~181330~~).',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CommodityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '商品类型'."\n"
+ .'- versionType：管控模式'."\n"
+ .'- SensitiveDataProtection：敏感数据保护',
+ 'description' => 'The type of the resource that you want to purchase.'."\n"
+ ."\n"
+ .'* **VersionType**: DMS that supports control modes'."\n"
+ .'* **SensitiveDataProtection**: DMS that supports sensitive data protection'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SensitiveDataProtection',
+ ],
+ ],
+ [
+ 'name' => 'InsNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '购买额度（一个额度可用于一个数据库实例）',
+ 'description' => 'The number of database instances that you want to use DMS to manage.'."\n"
+ ."\n"
+ .'> A quota can be used for only one database instance.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '7',
+ ],
+ ],
+ [
+ 'name' => 'VersionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '购买管控模式时（CommodityType = versionType ），区分管控模式的类型：'."\n"
+ .'- stand：稳定变更'."\n"
+ .'- safety：安全协同',
+ 'description' => 'The control mode of DMS. Valid values:'."\n"
+ ."\n"
+ .'* **stand**: Stable Change'."\n"
+ .'* **safety**: Security Collaboration'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'stand',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'InstanceId' => [
+ 'title' => '购买成功后，返回购买的订单实例ID',
+ 'description' => 'If the purchase is successful, the ID of the purchased instance is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'dms_pre_public_cn-nif23l****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"InstanceId\\": \\"dms_pre_public_cn-nif23l****\\"\\n}","errorExample":""},{"type":"xml","example":"<BuyPayAsYouGoOrderResponse>\\n <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>\\n <Success>true</Success>\\n <InstanceId>dms_pre_public_cn-nif23l****</InstanceId>\\n</BuyPayAsYouGoOrderResponse>","errorExample":""}]',
+ 'title' => 'BuyPayAsYouGoOrder',
+ ],
+ 'CreateMetaCategory' => [
+ 'summary' => 'Create Asset Category',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'ParentCategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the parent category. The new category is created under this parent category. If this value is left empty, the new category is of the first level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '30000322682',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'OwnerIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '207176D7-A9B3-55CE-A9DA-14E223A31913',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Category' => [
+ 'description' => 'The information about the category.'."\n",
+ '$ref' => '#/components/schemas/MetaCategory',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207176D7-A9B3-55CE-A9DA-14E223A31913\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Category\\": {\\n \\"CategoryId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Depth\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Remark\\": \\"\\",\\n \\"OwnerIds\\": {\\n \\"undefined\\": [\\n 0\\n ]\\n },\\n \\"OwnerNickNames\\": {\\n \\"undefined\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'CreateMetaCategory',
+ ],
+ 'ListMetaCategory' => [
+ 'summary' => 'Queries a list of categories',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to query the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'ParentCategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The parent category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '30000322682',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'maximum' => '1000',
+ 'example' => '50',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CategoryList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'MetaCategory' => [
+ 'description' => 'The list of categories.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the category.'."\n",
+ '$ref' => '#/components/schemas/MetaCategory',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"CategoryList\\": {\\n \\"MetaCategory\\": [\\n {\\n \\"CategoryId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Depth\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Remark\\": \\"\\",\\n \\"OwnerIds\\": {\\n \\"undefined\\": [\\n 0\\n ]\\n },\\n \\"OwnerNickNames\\": {\\n \\"undefined\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListMetaCategory',
+ ],
+ 'UpdateMetaCategory' => [
+ 'summary' => 'Updates asset category information.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '23****',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '30000181325',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The updated name of the category.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'OwnerIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Category' => [
+ 'description' => 'The information about the category.'."\n",
+ '$ref' => '#/components/schemas/MetaCategory',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Category\\": {\\n \\"CategoryId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Depth\\": 0,\\n \\"ParentCategoryId\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Remark\\": \\"\\",\\n \\"OwnerIds\\": {\\n \\"undefined\\": [\\n 0\\n ]\\n },\\n \\"OwnerNickNames\\": {\\n \\"undefined\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateMetaCategory',
+ ],
+ 'DeleteMetaCategory' => [
+ 'summary' => 'Deletes an asset category.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '30000235594',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteMetaCategory',
+ ],
+ 'ListTablesInCategory' => [
+ 'summary' => 'Obtains the list of tables in a category.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '30000235593',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'maximum' => '100',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'EntityList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'MetaCategoryTableEntity' => [
+ 'description' => 'List of table information associated with the asset category.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The table information associated with the specified asset category.'."\n",
+ '$ref' => '#/components/schemas/MetaCategoryTableEntity',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"EntityList\\": {\\n \\"MetaCategoryTableEntity\\": [\\n {\\n \\"CategoryId\\": 0,\\n \\"TableName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"InstanceId\\": 0,\\n \\"TableSchemaName\\": \\"\\",\\n \\"DbId\\": 0,\\n \\"CatalogName\\": \\"\\",\\n \\"DatabaseSearchName\\": \\"\\",\\n \\"SchemaName\\": \\"\\",\\n \\"DbType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListTablesInCategory',
+ ],
+ 'AddTableToCategory' => [
+ 'summary' => 'Add a table to an asset category.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) or [ListUserTenants](~~198074~~) operation to obtain the tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the associated category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '30000254257',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of a physical database: You can call the [ListDatabases](~~141873~~) or [SearchDatabase](~~141876~~) operation to obtain the physical database ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1930****',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table. You can call the [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'table_name',
+ ],
+ ],
+ [
+ 'name' => 'TableSchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dbo',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4AD10',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4AD10\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AddTableToCategory',
+ ],
+ 'RemoveTableFromCategory' => [
+ 'summary' => 'Removes table from the asset category.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsKIHNZQ',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3****',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '30000235594',
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID. You can call the [ListDatabases](~~141873~~) operation to query the ID of a physical database and the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n"
+ ."\n"
+ .'> The value of DatabaseId is that of DbId.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '43153',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table name.'."\n"
+ ."\n"
+ .'> You can also call the [ListTables](~~141878~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_table',
+ ],
+ ],
+ [
+ 'name' => 'TableSchemaName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema name of the table, which is required only for SQL Server instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dbo',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '19DA51A9-AC3E-5C36-8351-07EBCD2B89A1',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the call failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19DA51A9-AC3E-5C36-8351-07EBCD2B89A1\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RemoveTableFromCategory',
+ ],
+ 'AnalyzeSQLLineage' => [
+ 'summary' => 'Analyzes the lineage (dependencies and influence) between tables and between fields in SQL statements.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID.'."\n"
+ ."\n"
+ .'> You can call one of the [SearchDatabase](~~141876~~), [ListDatabases](~~141873~~), and [GetDatabase](~~141869~~) operations to obtain the database ID provided in the DatabaseId response parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123***',
+ ],
+ ],
+ [
+ 'name' => 'SqlContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'insert into a (id) select id from b;',
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n"
+ ."\n"
+ .'> To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see [Manage DMS tenants](~~181330~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'example' => 'B4B07137-F6AE-4756-8474-7F92BB6C4E04',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'LineageResult' => [
+ 'description' => 'Returned data set of SQL lineage.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Lineages' => [
+ 'description' => 'The details about the lineage.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'LineageType' => [
+ 'description' => 'The type of the lineage. Valid values:'."\n"
+ ."\n"
+ .'* **FIELD_DEPEND_FIELD**: Fields depend on fields.'."\n"
+ .'* **TABLE_DEPEND_TABLE**: Tables depend on tables.'."\n"
+ .'* **FIELD_INFLU_TABLE**: Fields influence tables.'."\n"
+ .'* **FIELD_INFLU_FIELD**: Fields influence fields.'."\n"
+ .'* **FIELD_INFLU_TABLE**: Tables influence fields.'."\n"
+ .'* **FIELD_JOIN_FIELD**: Fields are associated with fields.'."\n",
+ 'type' => 'string',
+ 'example' => 'FIELD_DEPEND_FIELD',
+ ],
+ 'Src' => [
+ 'description' => 'The source.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest.b.id',
+ ],
+ 'Dst' => [
+ 'description' => 'The target.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest.a.id',
+ ],
+ 'OperType' => [
+ 'description' => 'The operation type of the SQL statement in which the data lineage is generated. For example, if the operation type is SELECT, the data lineage is generated from a SELECT statement.'."\n"
+ ."\n"
+ .'> This field is an extended field which has no practical use.'."\n",
+ 'type' => 'string',
+ 'example' => 'SELECT',
+ ],
+ 'ProcessDetail' => [
+ 'description' => 'The handling details. This parameter is returned only when LineageType is FIELD_DEPEND_FIELD.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'The SQL code snippet for field processing.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest.b.id',
+ ],
+ 'CalWay' => [
+ 'description' => 'The calculating method. Valid values:'."\n"
+ ."\n"
+ .'* **DIRECT**: No function or expression is used.'."\n"
+ .'* **EXPR**: A function or expression is used.'."\n",
+ 'type' => 'string',
+ 'example' => 'DIRECT',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ObjectMetadata' => [
+ 'description' => 'The table and field metadata information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The object name.'."\n",
+ 'type' => 'string',
+ 'example' => 'a',
+ ],
+ 'Type' => [
+ 'description' => 'The object type. Valid values:'."\n"
+ ."\n"
+ .'* **TABLE**'."\n"
+ .'* **VIEW**'."\n"
+ .'* **TMP_TABLE**'."\n",
+ 'type' => 'string',
+ 'example' => 'TABLE',
+ ],
+ 'Source' => [
+ 'description' => 'The source of metadata. Valid values:'."\n"
+ ."\n"
+ .'* **DDL**: The metadata comes from parsed SQL statements or definition of databases and tables collected by DMS.'."\n"
+ .'* **LINEAGE**: The metadata comes from lineage analysis results.'."\n",
+ 'type' => 'string',
+ 'example' => 'DDL',
+ ],
+ 'Fields' => [
+ 'description' => 'The fields in the metatable.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'dmstest.a.id',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4B07137-F6AE-4756-8474-7F92BB6C4E04\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"LineageResult\\": {\\n \\"Lineages\\": [\\n {\\n \\"LineageType\\": \\"FIELD_DEPEND_FIELD\\",\\n \\"Src\\": \\"dmstest.b.id\\",\\n \\"Dst\\": \\"dmstest.a.id\\",\\n \\"OperType\\": \\"SELECT\\",\\n \\"ProcessDetail\\": {\\n \\"Code\\": \\"dmstest.b.id\\",\\n \\"CalWay\\": \\"DIRECT\\"\\n }\\n }\\n ],\\n \\"ObjectMetadata\\": [\\n {\\n \\"Name\\": \\"a\\",\\n \\"Type\\": \\"TABLE\\",\\n \\"Source\\": \\"DDL\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"dmstest.a.id\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'AnalyzeSQLLineage',
+ 'description' => 'The following conditions must be met before you call this API operation.'."\n"
+ ."\n"
+ .'* The database instance is of one of the following types: ApsaraDB RDS for MySQL, PolarDB for MySQL, AnalyticDB for MySQL, ApsaraDB RDS for PostgreSQL, PolarDB for PostgreSQL, AnalyticDB for PostgreSQL, Oracle, and openGauss.'."\n"
+ .'* A database instance is managed in Security Collaboration mode. For more information about control modes, see [Control modes](~~151629~~).'."\n",
+ ],
+ 'CreateWorkspace' => [
+ 'summary' => 'Creates a workspace.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工作空间名字',
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'workspace_xxx',
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工作空间描述',
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Test',
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'vpc id',
+ 'description' => 'The VPC ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'vpc-xxx',
+ ],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'region',
+ 'description' => 'The region to which the workspace belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '幂等Token',
+ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token-xxx',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4AC23904-55DE-550B-9676-E8946F07****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'WorkspaceId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AC23904-55DE-550B-9676-E8946F07****\\",\\n \\"Success\\": true,\\n \\"WorkspaceId\\": 0\\n}","type":"json"}]',
+ 'title' => 'CreateWorkspace',
+ 'description' => '## [](#)Prerequisites'."\n"
+ ."\n"
+ .'* A virtual private cloud (VPC) is created.'."\n"
+ .'* Log on to the DMS console by using an Alibaba Cloud account or a RAM user that has high permissions, and grant DMS the permissions to access cloud resources (AliyunDMSProcessingDataRolePolicy).'."\n",
+ ],
+ 'DeleteWorkspace' => [
+ 'summary' => 'Deletes a workspace.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DMS工作空间ID',
+ 'description' => 'The ID of the DMS workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '7FAD400F-7A5C-4193-8F9A-39D86C4F0231',
+ ],
+ 'Success' => [
+ 'title' => 'api是否调用成功',
+ 'description' => 'Indicates whether the operation is called successfully.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '工作空间是否删除成功',
+ 'description' => 'Indicates whether the workspace is deleted successfully.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FAD400F-7A5C-4193-8F9A-39D86C4F0231\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteWorkspace',
+ ],
+ 'GetWorkspace' => [
+ 'summary' => 'Queries the details of a workspace.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DMS工作空间ID',
+ 'description' => 'The ID of the DMS workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'FE8EE2F1-4880-46BC-A704-5CF63EAF****',
+ ],
+ 'Message' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '863020290155****',
+ ],
+ 'WorkspaceName' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'workspace_xxx',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ 'RegionId' => [
+ 'description' => 'The ID of the region to which the workspace belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '12345****',
+ ],
+ 'ServiceAccountId' => [
+ 'description' => 'The ID of the service account.'."\n",
+ 'type' => 'string',
+ 'example' => '12345****',
+ ],
+ 'Tid' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3322****',
+ ],
+ 'VpcId' => [
+ 'description' => 'The VPC ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'vpc-xxxx',
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'WorkspaceNotExist',
+ 'errorMessage' => 'The specified workspace not exist.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE8EE2F1-4880-46BC-A704-5CF63EAF****\\",\\n \\"Message\\": \\"UnknownError\\",\\n \\"Data\\": {\\n \\"WorkspaceId\\": 0,\\n \\"WorkspaceName\\": \\"workspace_xxx\\",\\n \\"Description\\": \\"Test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": \\"12345****\\",\\n \\"ServiceAccountId\\": \\"12345****\\",\\n \\"Tid\\": 0,\\n \\"VpcId\\": \\"vpc-xxxx\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'GetWorkspace',
+ ],
+ 'ListWorkspaces' => [
+ 'summary' => 'Queries a list of workspaces of the tenant.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ 'FEATUREdmsKIHNZQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AlreadyJoined',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '过滤是否已加入空间',
+ 'description' => 'Specifies whether the current user has joined the workspace.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工作空间名字关键字',
+ 'description' => 'The search keyword. Fuzzy match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'poc_test',
+ ],
+ ],
+ [
+ 'name' => 'Region',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'region值',
+ 'description' => 'The region in which the bucket is located.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ServiceAccountId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '服务账号ID',
+ 'description' => 'The service account ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '工作空间ID',
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页码',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '每页数量',
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'vpc id',
+ 'description' => 'The virtual private cloud (VPC) ID.'."\n"
+ ."\n"
+ .'> This parameter cannot be used as a filter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-bp10wnlcmor****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '请求ID',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'EE214ECD-4330-503A-82F0-FFB03975****',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UserNotExist',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息',
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '是否请求成功',
+ 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request succeeded.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'title' => '总数',
+ 'description' => 'The total number of workspaces that meet the conditions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'BaseWorkspaces' => [
+ 'title' => '数据集',
+ 'description' => 'The dataset.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => [
+ 'title' => '空间描述',
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ 'CreatorId' => [
+ 'title' => '创建者',
+ 'description' => 'The ID of the creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'OwnerUid' => [
+ 'title' => '责任人阿里云uid',
+ 'description' => 'The Alibaba Cloud UID of the owner.'."\n",
+ 'type' => 'string',
+ 'example' => '15608564799****',
+ ],
+ 'WorkspaceId' => [
+ 'title' => '工作空间ID',
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '8652340494****',
+ ],
+ 'GmtModified' => [
+ 'title' => '最后修改时间',
+ 'description' => 'The update time.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-01 00:00:00',
+ ],
+ 'ServiceAccountId' => [
+ 'title' => '服务账号ID',
+ 'description' => 'The ID of the service account.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'CreatorUid' => [
+ 'title' => '创建者阿里云Uid',
+ 'description' => 'The Alibaba Cloud account UID of the creator.'."\n",
+ 'type' => 'string',
+ 'example' => '1344****',
+ ],
+ 'ServiceAccountNickName' => [
+ 'title' => '服务账号昵称',
+ 'description' => 'The nickname of the service account.'."\n",
+ 'type' => 'string',
+ 'example' => 'testname',
+ ],
+ 'Name' => [
+ 'title' => '工作空间名字，同WorkspaceName',
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'workspace-xxxx',
+ ],
+ 'AlreadyJoined' => [
+ 'title' => '请求者是否已加入空间',
+ 'description' => 'Whether the current user has joined the workspace.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TenantId' => [
+ 'title' => 'DMS租户ID',
+ 'description' => 'The ID of the tenant to which the workspace belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '23456',
+ ],
+ 'GmtCreate' => [
+ 'title' => '工作空间创建时间',
+ 'description' => 'The creation time.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-01 00:00:00',
+ ],
+ 'ServiceAccountUid' => [
+ 'title' => '服务账号阿里云UID',
+ 'description' => 'The Alibaba Cloud account UID of the service account.'."\n",
+ 'type' => 'string',
+ 'example' => '1422****',
+ ],
+ 'OwnerId' => [
+ 'title' => '创建者ID',
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123****',
+ ],
+ 'VpcId' => [
+ 'title' => 'vpc id',
+ 'description' => 'The VPC ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'vpc-25fl3qjqb****',
+ ],
+ 'Region' => [
+ 'title' => 'region，区域',
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'WorkspaceName' => [
+ 'title' => '工作空间名称',
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test-workspace',
+ ],
+ 'CreatorNickName' => [
+ 'title' => '创建者昵称',
+ 'description' => 'The nickname of the creator.'."\n",
+ 'type' => 'string',
+ 'example' => 'work*****',
+ ],
+ 'OwnerNickName' => [
+ 'title' => '责任人昵称',
+ 'description' => 'The nickname of the owner.'."\n",
+ 'type' => 'string',
+ 'example' => 'hel****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'NextToken' => [
+ 'title' => 'nextToken，暂无用',
+ 'description' => 'NextToken does not take effect.'."\n",
+ 'type' => 'string',
+ 'example' => 'token-xxx',
+ ],
+ 'MaxResults' => [
+ 'title' => '同totalCount',
+ 'description' => 'The total number of workspaces that meet the condition, which is the same as the TotalCount parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE214ECD-4330-503A-82F0-FFB03975****\\",\\n \\"ErrorCode\\": \\"UserNotExist\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 10,\\n \\"Data\\": {\\n \\"BaseWorkspaces\\": [\\n {\\n \\"Description\\": \\"Test\\",\\n \\"CreatorId\\": 123,\\n \\"OwnerUid\\": \\"15608564799****\\",\\n \\"WorkspaceId\\": 0,\\n \\"GmtModified\\": \\"2025-01-01 00:00:00\\",\\n \\"ServiceAccountId\\": 12345,\\n \\"CreatorUid\\": \\"1344****\\",\\n \\"ServiceAccountNickName\\": \\"testname\\",\\n \\"Name\\": \\"workspace-xxxx\\",\\n \\"AlreadyJoined\\": true,\\n \\"TenantId\\": 23456,\\n \\"GmtCreate\\": \\"2025-01-01 00:00:00\\",\\n \\"ServiceAccountUid\\": \\"1422****\\",\\n \\"OwnerId\\": 0,\\n \\"VpcId\\": \\"vpc-25fl3qjqb****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"WorkspaceName\\": \\"test-workspace\\",\\n \\"CreatorNickName\\": \\"work*****\\",\\n \\"OwnerNickName\\": \\"hel****\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"token-xxx\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
+ 'title' => 'ListWorkspaces',
+ ],
+ 'UpdateWorkspace' => [
+ 'summary' => 'Updates the information about a workspace.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsXSH6IQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'DMS工作空间ID',
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12****',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '要更改的工作名字',
+ 'description' => 'The new name of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'workspace_xxx',
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '要更改的空间描述',
+ 'description' => 'The new description of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token-xxx',
+ ],
+ ],
+ ],
+ '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 request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'C51420E3-144A-4A94-B473-8662FCF4****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the call is successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C51420E3-144A-4A94-B473-8662FCF4****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateWorkspace',
+ ],
+ 'OptimizeSqlByMetaAgent' => [
+ 'summary' => 'Analyzes and optimizes the SQL statements in the specified database.',
+ 'description' => 'You can call this operation to analyze and optimize the SQL statements in the specified database.'."\n",
+ 'path' => '/',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '数据库ID，可以调用[ListDatabases](~~141873~~)接口获取。',
+ 'description' => 'The ID of the database. You can call the [ListDatabases](~~141873~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '备注信息',
+ 'description' => 'The remarks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '是否为慢SQL',
+ ],
+ ],
+ [
+ 'name' => 'Sql',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '待分析的SQL。',
+ 'description' => 'The SQL statement that you want to analyze.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'select * from table where col = 1',
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '选用的模型名称，仅可用千问系列',
+ 'description' => 'The name of the selected model. You can use only Qwen series models.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功返回',
+ 'schema' => [
+ 'title' => '返回内容',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码。',
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息。',
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，返回值如下：'."\n"
+ .'- **true**：请求成功'."\n"
+ .'- **false**：请求失败',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '返回的数据信息。',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'title' => '回答内容',
+ 'description' => 'The answer.'."\n",
+ 'type' => 'string',
+ 'example' => 'SQL优化结果...',
+ ],
+ 'SessionId' => [
+ 'title' => '会话ID',
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'f63a6eed-0e3c-4564-8533-b1295db8d6ff',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Content\\": \\"SQL优化结果...\\",\\n \\"SessionId\\": \\"f63a6eed-0e3c-4564-8533-b1295db8d6ff\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'OptimizeSqlByMetaAgent',
+ ],
+ 'FixSqlByMetaAgent' => [
+ 'summary' => 'Uses the specified SQL statement, error message, and database ID to analyze and fix the SQL error.',
+ 'description' => 'You can call this operation to analyze and fix SQL errors based on the specified SQL statement, error message, and database ID.'."\n",
+ 'path' => '/',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '数据库ID，可以调用[ListDatabases](~~141873~~)接口获取。',
+ 'description' => 'The ID of the database. You can call the [ListDatabases](~~141873~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '备注信息',
+ 'description' => 'The remarks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '正确字段是啥？',
+ ],
+ ],
+ [
+ 'name' => 'Sql',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '报错的SQL。',
+ 'description' => 'The SQL statement that reports the error.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'select * from table where col = 1',
+ ],
+ ],
+ [
+ 'name' => 'Error',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '报错信息',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'unknown column col',
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '选用的模型名称，仅可用千问系列',
+ 'description' => 'The name of the selected model. You can use only Qwen series models.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功返回',
+ 'schema' => [
+ 'title' => '返回内容',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码。',
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息。',
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，返回值如下：'."\n"
+ .'- **true**：请求成功'."\n"
+ .'- **false**：请求失败',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '返回的数据信息。',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'title' => '回答内容',
+ 'description' => 'The answer.'."\n",
+ 'type' => 'string',
+ 'example' => 'SQL修复结果...',
+ ],
+ 'SessionId' => [
+ 'title' => '会话ID',
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'f63a6eed-0e3c-4564-8533-b1295db8d6ff',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Content\\": \\"SQL修复结果...\\",\\n \\"SessionId\\": \\"f63a6eed-0e3c-4564-8533-b1295db8d6ff\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'FixSqlByMetaAgent',
+ ],
+ 'AnswerSqlSyntaxByMetaAgent' => [
+ 'summary' => 'Answers the syntax questions of the corresponding engine according to the specified database ID.',
+ 'description' => 'You can call this operation to answer the syntax questions of the corresponding engine according to the specified database ID.'."\n",
+ 'path' => '/',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '数据库ID，可以调用[ListDatabases](~~141873~~)接口获取。',
+ 'description' => 'The ID of the database. You can call the [ListDatabases](~~141873~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '语法问题',
+ 'description' => 'The syntax question.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '怎么获取当前时间的字符串',
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '选用的模型名称，仅可用千问系列',
+ 'description' => 'The name of the selected model. You can use only Qwen series models.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功返回',
+ 'schema' => [
+ 'title' => '返回内容',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码。',
+ 'description' => 'The error code that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息。',
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，返回值如下：'."\n"
+ .'- **true**：请求成功'."\n"
+ .'- **false**：请求失败',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '返回的数据信息。',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'title' => '回答内容',
+ 'description' => 'The answer to the question.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql数据库类型下...',
+ ],
+ 'SessionId' => [
+ 'title' => '会话ID',
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'f63a6eed-0e3c-4564-8533-b1295db8d6ff',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Content\\": \\"mysql数据库类型下...\\",\\n \\"SessionId\\": \\"f63a6eed-0e3c-4564-8533-b1295db8d6ff\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'AnswerSqlSyntaxByMetaAgent',
+ ],
+ 'ListUserOwnedResources' => [
+ 'summary' => 'Obtains',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3***',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1***',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'db_name',
+ ],
+ ],
+ [
+ 'name' => 'OwnerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the owner. Valid values:'."\n"
+ ."\n"
+ .'* INSTANCE: an owner of an instance.'."\n"
+ .'* DATABASE: an owner of a physical database.'."\n"
+ .'* TABLE: an owner of a physical table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'INSTANCE',
+ 'enum' => [
+ 'INSTANCE',
+ 'DATABASE',
+ 'TABLE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true.**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the environment in which the database instance is deployed. Valid values:'."\n"
+ ."\n"
+ .'* **product**: production environment.'."\n"
+ .'* **dev**: development environment.'."\n"
+ .'* **pre**: pre-release environment.'."\n"
+ .'* **test**: test environment.'."\n"
+ .'* **sit**: system integration testing (SIT) environment.'."\n"
+ .'* **uat**: user acceptance testing (UAT) environment.'."\n"
+ .'* **pet**: stress testing environment.'."\n"
+ .'* **stag**: staging environment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'product',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the database instance. For more information about the valid values of this parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MYSQL',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '8E88933E-E3D4-5BA8-8CBF-0A1CAE666690',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'resourceList' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '291594',
+ ],
+ 'DbId' => [
+ 'description' => 'The ID of the database in DMS.'."\n",
+ 'type' => 'string',
+ 'example' => '29697059',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'as_task_engine',
+ ],
+ 'Logic' => [
+ 'description' => 'Indicates whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The database is a logical database'."\n"
+ .'* **false**: The database is a physical database.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SearchName' => [
+ 'description' => 'The query name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'dtstest [dtstest_dms]',
+ ],
+ 'TableName' => [
+ 'description' => 'The table name.'."\n",
+ 'type' => 'string',
+ 'example' => 'addepmap',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment to which the database instance belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'product',
+ ],
+ 'DbType' => [
+ 'description' => 'The database engine type. For more information about the valid values of the DbType parameter, see [DbType parameter](~~198106~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'MySQL',
+ ],
+ 'TableId' => [
+ 'description' => 'The table ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1760934555',
+ ],
+ 'Alias' => [
+ 'description' => 'The alias of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'DMS_GYX_TESTupdata',
+ ],
+ 'Host' => [
+ 'description' => 'The endpoint of the instance to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'rm-wz98bw60x1i1303c5.mysql.rds.aliyuncs.com',
+ ],
+ 'Port' => [
+ 'description' => 'The connection port of the instance to which the database belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6379',
+ ],
+ 'DbInstanceId' => [
+ 'description' => 'The ID of the instance to which the database belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '876XXX',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"8E88933E-E3D4-5BA8-8CBF-0A1CAEXXXXXX\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Data\\": {\\n \\"resourceList\\": [\\n {\\n \\"InstanceId\\": \\"291XXX\\",\\n \\"DbId\\": \\"29697XXX\\",\\n \\"SchemaName\\": \\"as_task_engine\\",\\n \\"Logic\\": false,\\n \\"SearchName\\": \\"dtstest [dtstest_dms]\\",\\n \\"TableName\\": \\"addepmap\\",\\n \\"EnvType\\": \\"product\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"TableId\\": \\"1760934XXX\\",\\n \\"Alias\\": \\"DMS_GYX_TESTupdata\\",\\n \\"Host\\": \\"rm-wz98XXXXXX1303c5.mysql.rds.aliyuncs.com\\",\\n \\"Port\\": 6379,\\n \\"DbInstanceId\\": \\"876XXX\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ListUserOwnedResources',
+ ],
+ 'CheckBatchTableAccessPermission' => [
+ 'summary' => 'Batch verify table permissions.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsY7L2P4',
+ ],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableNameList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_name',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'DbId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The database ID. You can call the [ListDatabases](~~141873~~) operation to query the ID of a physical database and the [ListLogicDatabases](~~141874~~) operation to query the ID of a logical database.'."\n"
+ ."\n"
+ .'> The value of DatabaseId is that of DbId.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '43153',
+ ],
+ ],
+ [
+ 'name' => 'Logic',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the database is a logical database. Valid values:'."\n"
+ ."\n"
+ .'* true: Logical database.'."\n"
+ .'* false: Physical database.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'PermissionType',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'description' => 'The type of the permission to be verified.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* QUERY'."\n"
+ .'* EXPORT'."\n"
+ .'* CORRECT'."\n"
+ .'* LOGIN'."\n"
+ .'* PERF'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'QUERY',
+ 'enum' => [
+ 'QUERY',
+ 'EXPORT',
+ 'CORRECT',
+ 'LOGIN',
+ 'PERF',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Tid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the tenant.'."\n"
+ ."\n"
+ .'> View Tenant ID by hovering over your profile icon in the DMS console. For more information, see the [View information about the current tenant](~~181330~~) section of the "Manage DMS tenants" topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3***',
+ ],
+ ],
+ ],
+ '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' => 'B43AD641-49C2-5299-9E06-1B37EC1B****',
+ ],
+ 'Data' => [
+ 'description' => 'The dataset.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'tab_add_teacher_record',
+ ],
+ 'Success' => [
+ 'description' => '* **true**: Permission granted'."\n"
+ .'* **false**: Permissions denied'."\n",
+ 'type' => 'string',
+ 'example' => 'True',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that is returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'The productKey is empty.',
+ ],
+ ],
+ ],
+ ],
+ 'ErrorCode' => [
+ 'description' => 'Error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B43AD641-49C2-5299-9E06-1B37EC1B****\\",\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"tab_add_teacher_record\\",\\n \\"Success\\": \\"True\\",\\n \\"ErrorMessage\\": \\"NoPermission\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'CheckBatchTableAccessPermission',
+ 'description' => 'Verify the permissions on multiple tables at a time.'."\n",
+ ],
+ 'ChatWithDesensitize' => [
+ 'summary' => 'Chat API with DMS Data Masking capabilities.',
+ 'description' => 'Chat API with DMS Data Masking capabilities.'."\n",
+ 'path' => '/',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '实例ID，通过实例ID指定对应的脱敏规则。可通过调用接口[ListInstances](~~141936~~)或[GetInstance](~~141567~~)获取该参数的值。',
+ 'description' => 'The ID of the instance, used to specify the corresponding data masking rules. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123***',
+ ],
+ ],
+ [
+ 'name' => 'Messages',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '传递给大模型的上下文，按对话顺序排列。',
+ 'description' => 'The conversation context passed to the model, arranged in chronological order.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'For each message body of the dialog, the standard format is as follows: { "content": "$message", "role": "$role：system，user，assistant" }'."\n",
+ 'type' => 'any',
+ 'required' => false,
+ 'example' => '',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'example' => '['."\n"
+ .' {'."\n"
+ .' "content": "你好",'."\n"
+ .' "role": "user"'."\n"
+ .' }'."\n"
+ .']',
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '模型名称。支持的模型：Qwen系列的纯文本大语言模型（商业版、开源版）。不支持多模态模型',
+ 'description' => 'The model name. Supported Models: Qwen series text-only Large Language Models (Commercial and Open-source). Multi-modal models are not supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ [
+ 'name' => 'Stop',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '停止词列表。',
+ 'description' => 'Stop sequences.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Stop sequences: Generation will terminate immediately if the model generates any of the strings specified in the \'stop\' parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\\n',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'example' => '["\\n"]',
+ ],
+ ],
+ [
+ 'name' => 'NeedDesensitization',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否需要进行脱敏，默认为false',
+ 'description' => 'Whether to enable data masking. Defaults to false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'DesensitizationRule',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '脱敏类别，needDesensitization为true时不可为空',
+ 'description' => 'Masking category. Required when needDataMasking is true.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'UserInfo',
+ ],
+ ],
+ [
+ 'name' => 'MaxTokens',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用于限制模型输出的最大 Token 数。若生成内容超过此值，生成将提前停止。适用于需控制输出长度的场景。',
+ 'description' => 'Limits the maximum number of tokens the model can generate. If the output exceeds this value, generation will be truncated. Suitable for scenarios where you need to control the output length.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '256',
+ ],
+ ],
+ [
+ 'name' => 'PresencePenalty',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Controls the degree of repetition in generated text. Valid values: \\[-2.0, 2.0]. Positive values decrease repetition, while negative values increase it.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0.0',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'ResponseFormat',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '返回内容的格式。可选值：text：输出文字回复；json_object：输出标准格式的JSON字符串。',
+ 'description' => 'The format of the returned content. Valid values: text: Plain text response; json_object: Standardized JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ ],
+ [
+ 'name' => 'Seed',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '随机数种子。用于确保在相同输入和参数下生成结果可复现。取值范围：[0, 2^31−1]。',
+ 'description' => 'Random seed. Used to ensure the reproducibility of results under the same input and parameters. Valid values: \\[0, 2^31−1].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EnableThinking',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '使用混合思考模型时，是否开启思考模式。',
+ 'description' => 'Specifies whether to enable Thinking Mode when using hybrid thinking models.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'ThinkingBudget',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '思考过程的最大token数',
+ 'description' => 'The maximum number of tokens allowed for the model\'s internal reasoning process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '256',
+ ],
+ ],
+ [
+ 'name' => 'Temperature',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sampling temperature controls the diversity of the generated text. The higher the temperature, the more diverse the generated text, and conversely, the more deterministic the generated text. Valid values: \\[0, 2).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'TopLogprobs',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '指定在每一步生成时，返回模型最大概率的候选 Token 个数。取值范围：[0, 5]。',
+ 'description' => 'Specifies the number of most likely candidate tokens to return at each generation step. Valid values: \\[0, 5].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'TopK',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '指定生成过程中用于采样的候选 Token 数量。值越大，输出越随机；值越小，输出越确定。若设为null或大于 100，则禁用。',
+ 'description' => 'Specifies the number of candidate tokens to consider during sampling. Higher values increase randomness, while lower values make the output more deterministic. Set to null or a value greater than 100 to disable.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TopP',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The probability threshold for nucleus sampling, used to control the diversity of the generated text. Higher Top-P values result in more diverse generated text. Valid values: (0,1.0].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0.5',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'XDashScopeDataInspection',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '在通义千问 API 的内容安全能力基础上，是否进一步识别输入输出内容的违规信息。'."\n",
+ 'description' => 'Specifies whether to further identify non-compliant information in both input and output content, building upon the built-in content safety capabilities of the Tongyi Qianwen API.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'SearchOptions',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '联网搜索的策略。',
+ 'description' => 'Web search strategy.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The strategy key-value pair for Web search.',
+ 'example' => '{}',
+ ],
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'ModalitiesList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '输出数据的模态，仅适用于 Qwen-Omni 模型。',
+ 'description' => 'Output data modality; only applicable to the Qwen-Omni model.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '输出数据的模态',
+ 'description' => 'Output data modality.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ 'required' => false,
+ 'example' => '["text","audio"]',
+ ],
+ ],
+ [
+ 'name' => 'AudioJson',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '输出音频的音色与格式，仅适用于 Qwen-Omni 模型，且modalities参数需为["text","audio"]。',
+ 'description' => 'Output audio voice and format; only applicable to the Qwen-Omni model, provided that the modalities parameter is set to ["text", "audio"].',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'EnableCodeInterpreter',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否开启代码解释器功能。仅当model为qwen3-max-preview且enable_thinking为true时生效。',
+ 'description' => 'Specifies whether to enable the code interpreter feature. Takes effect only when model is qwen3-max-preview and enable_thinking is true.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Logprobs',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否返回输出 Token 的对数概率，',
+ 'description' => 'Specifies whether to return the log probabilities of the output tokens.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'VlHighResolutionImages',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否将输入图像的像素上限提升至 16384 Token 对应的像素值。',
+ 'description' => 'Specifies whether to increase the maximum pixel limit of input images to the equivalent of 16,384 tokens.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EnableSearch',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否开启联网搜索。',
+ 'description' => 'Whether to enable web search.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功返回',
+ 'schema' => [
+ 'title' => '返回内容',
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'ID of the request.',
+ 'type' => 'string',
+ 'example' => '0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931',
+ ],
+ 'ErrorCode' => [
+ 'title' => '错误码。',
+ 'description' => 'Error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '错误信息。',
+ 'description' => 'Error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，返回值如下：'."\n"
+ .'- **true**：请求成功'."\n"
+ .'- **false**：请求失败',
+ 'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'title' => '返回的数据信息。',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Created' => [
+ 'title' => '请求创建时的 Unix 时间戳（秒）。',
+ 'description' => 'The Unix timestamp (in seconds) when the request was created.'."\n",
+ 'type' => 'string',
+ 'example' => '1763710100',
+ ],
+ 'Model' => [
+ 'title' => '本次请求使用的模型。',
+ 'description' => 'The model used for this request.'."\n",
+ 'type' => 'string',
+ 'example' => 'qwen-plus',
+ ],
+ 'Choices' => [
+ 'title' => '模型生成内容的候选数组。',
+ 'description' => 'The candidate array for model-generated content.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '模型生成的候选内容',
+ 'description' => 'Candidate content generated by the model.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FinishReason' => [
+ 'title' => '终止原因：'."\n"
+ .'● 触发输入参数中的stop参数，或自然停止输出时为stop；'."\n"
+ .'● 生成长度过长而结束为length；'."\n"
+ .'● 需要调用工具而结束为tool_call；',
+ 'description' => 'Finish reason: ● stop: The model reached a natural stop point or a specified stop sequence. ● length: Generation ended because the maximum number of tokens was reached. ● tool_calls: The model stopped because it needs to call a tool to proceed.'."\n",
+ 'type' => 'string',
+ 'example' => 'stop',
+ ],
+ 'Message' => [
+ 'title' => '模型输出的消息体',
+ 'description' => 'The message body output by the model.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => [
+ 'title' => '模型的回复内容',
+ 'description' => 'The content of the model\'s response.'."\n",
+ 'type' => 'string',
+ 'example' => '你好呀！',
+ ],
+ 'ReasoningContent' => [
+ 'title' => '模型的深度思考内容',
+ 'description' => 'The internal reasoning content of the model.'."\n",
+ 'type' => 'string',
+ 'example' => '嗯，用户发了个“你好”，看起来是想打招呼...',
+ ],
+ 'Role' => [
+ 'title' => '消息的角色',
+ 'description' => 'Message role.'."\n",
+ 'type' => 'string',
+ 'example' => 'system',
+ ],
+ ],
+ ],
+ 'Logprobs' => [
+ 'title' => '模型输出的 Token 概率信息。',
+ 'description' => 'Token probability information of model output.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ 'description' => 'Token probability information of model output.',
+ 'example' => '{}',
+ ],
+ 'example' => '{}',
+ ],
+ ],
+ ],
+ ],
+ 'Usage' => [
+ 'title' => '本次请求的 Token 消耗信息。',
+ 'description' => 'The token consumption information of this request.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CompletionTokens' => [
+ 'title' => '模型输出的 Token 数。',
+ 'description' => 'The number of output tokens.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'PromptTokens' => [
+ 'title' => '输入的 Token 数。',
+ 'description' => 'The number of input tokens.'."\n",
+ 'type' => 'string',
+ 'example' => '9',
+ ],
+ 'TotalTokens' => [
+ 'title' => '消耗的总 Token 数。',
+ 'description' => 'The total number of tokens consumed.'."\n",
+ 'type' => 'string',
+ 'example' => '19',
+ ],
+ 'PromptTokensDetails' => [
+ 'title' => '输入 Token 的细粒度分类。',
+ 'description' => 'Fine-grained classification of input tokens.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'Fine-grained classification of input tokens.',
+ 'example' => '{}',
+ ],
+ 'example' => '{}',
+ ],
+ 'CompletionTokensDetails' => [
+ 'title' => '使用Qwen-VL模型时输出Token的细粒度分类。',
+ 'description' => 'Fine-grained classification of output tokens when using the Qwen-VL model.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => '{}',
+ 'description' => 'Fine-grained classification of output tokens.',
+ ],
+ 'example' => '{}',
+ ],
+ ],
+ ],
+ 'Message' => [
+ 'title' => '报错信息，当StatusCode不为200的时候会有值',
+ 'description' => 'Error message, provided when StatusCode is not 200.',
+ 'type' => 'string',
+ 'example' => 'InvalidParameter',
+ ],
+ 'StatusCode' => [
+ 'title' => '报错码，200时为正常调用，其他的为异常',
+ 'description' => 'Error code, 200 for normal calls, others for exceptions.',
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Type' => [
+ 'title' => '报错类型',
+ 'description' => 'Error type.',
+ 'type' => 'string',
+ 'example' => 'invalid_request_error',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Created\\": \\"1763710100\\",\\n \\"Model\\": \\"qwen-plus\\",\\n \\"Choices\\": [\\n {\\n \\"FinishReason\\": \\"stop\\",\\n \\"Message\\": {\\n \\"Content\\": \\"你好呀！\\",\\n \\"ReasoningContent\\": \\"嗯，用户发了个“你好”，看起来是想打招呼...\\",\\n \\"Role\\": \\"system\\"\\n },\\n \\"Logprobs\\": {\\n \\"key\\": \\"{}\\"\\n }\\n }\\n ],\\n \\"Usage\\": {\\n \\"CompletionTokens\\": \\"10\\",\\n \\"PromptTokens\\": \\"9\\",\\n \\"TotalTokens\\": \\"19\\",\\n \\"PromptTokensDetails\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"CompletionTokensDetails\\": {\\n \\"key\\": \\"{}\\"\\n }\\n },\\n \\"Message\\": \\"InvalidParameter\\",\\n \\"StatusCode\\": \\"200\\",\\n \\"Type\\": \\"invalid_request_error\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'ChatWithDesensitize',
+ ],
+ 'ChatWithDesensitizeSSE' => [
+ 'summary' => 'Chat SSE API with DMS Data Masking capability.',
+ 'description' => 'Chat SSE API with DMS Data Masking capability.'."\n",
+ 'path' => '/worknode/innerapi/services',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ 'sse',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdmsU8QOR6',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '实例ID，通过实例ID指定对应的脱敏规则。可通过调用接口[ListInstances](~~141936~~)或[GetInstance](~~141567~~)获取该参数的值。',
+ 'description' => 'The ID of the instance, used to specify the corresponding data masking rules. You can call the [ListInstances](~~141936~~) or [GetInstance](~~141567~~) operation to query the ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123***',
+ ],
+ ],
+ [
+ 'name' => 'Messages',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '传递给大模型的上下文，按对话顺序排列。',
+ 'description' => 'The conversation context passed to the model, arranged in chronological order.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '传递给大模型的上下文，按对话顺序排列。',
+ 'description' => 'The conversation context passed to the model, arranged in chronological order.'."\n",
+ 'type' => 'any',
+ 'required' => false,
+ 'example' => '{'."\n"
+ .' "content": "你好",'."\n"
+ .' "role": "user"'."\n"
+ .'}',
+ ],
+ 'required' => false,
+ 'example' => '['."\n"
+ .' {'."\n"
+ .' "content": "你好",'."\n"
+ .' "role": "user"'."\n"
+ .' }'."\n"
+ .']',
+ ],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '模型名称。支持的模型：Qwen系列的纯文本大语言模型（商业版、开源版）。不支持多模态模型',
+ 'description' => 'The model name. Supported models: Qwen series text-only Large Language Models (commercial and open-source). Multi-modal models are not supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qwen-plus',
+ ],
+ ],
+ [
+ 'name' => 'Stop',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '停止词列表。',
+ 'description' => 'Stop sequences.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '停止词列表。',
+ 'description' => 'Stop words.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '\\n',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NeedDesensitization',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否需要进行脱敏，默认为false',
+ 'description' => 'Whether to enable data masking. Defaults to false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'DesensitizationRule',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '脱敏类别，needDesensitization为true时不可为空',
+ 'description' => 'Masking category. Required when needDataMasking is true.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'UserInfo',
+ ],
+ ],
+ [
+ 'name' => 'MaxTokens',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用于限制模型输出的最大 Token 数。若生成内容超过此值，生成将提前停止。适用于需控制输出长度的场景。',
+ 'description' => 'Limits the maximum number of tokens the model can generate. If the output exceeds this value, generation will be truncated. Suitable for scenarios where you need to control the output length.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '256',
+ ],
+ ],
+ [
+ 'name' => 'PresencePenalty',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '控制模型生成文本时的内容重复度。取值范围：[-2.0, 2.0]。正值降低重复度，负值增加重复度。',
+ 'description' => 'Controls the degree of repetition in generated text. Valid values: \\[-2.0, 2.0]. Positive values decrease repetition, while negative values increase it.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0.0',
+ ],
+ ],
+ [
+ 'name' => 'ResponseFormat',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '返回内容的格式。可选值：text：输出文字回复；json_object：输出标准格式的JSON字符串。',
+ 'description' => 'The format of the returned content. Valid values: text: Plain text response; json_object: Standardized JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ ],
+ [
+ 'name' => 'Seed',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '随机数种子。用于确保在相同输入和参数下生成结果可复现。取值范围：[0, 2^31−1]。',
+ 'description' => 'Random seed. Used to ensure the reproducibility of results under the same input and parameters. Valid values: \\[0, 2^31−1].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EnableThinking',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '使用混合思考模型时，是否开启思考模式。',
+ 'description' => 'Specifies whether to enable thinking mode when using hybrid thinking models.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'ThinkingBudget',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '思考过程的最大token数',
+ 'description' => 'The maximum number of tokens allowed for the model\'s internal reasoning process.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '256',
+ ],
+ ],
+ [
+ 'name' => 'Temperature',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '采样温度，控制模型生成文本的多样性。temperature越高，生成的文本更多样，反之，生成的文本更确定。取值范围： [0, 2)',
+ 'description' => 'The sampling temperature controls the diversity of the generated text. The higher the temperature, the more diverse the generated text, and conversely, the more deterministic the generated text. Valid values: \\[0, 2).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'TopLogprobs',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '指定在每一步生成时，返回模型最大概率的候选 Token 个数。取值范围：[0, 5]。',
+ 'description' => 'Specifies the number of most likely candidate tokens to return at each generation step. Valid values: \\[0, 5].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'TopK',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '指定生成过程中用于采样的候选 Token 数量。值越大，输出越随机；值越小，输出越确定。若设为null或大于 100，则禁用。',
+ 'description' => 'Specifies the number of candidate tokens to consider during sampling. Higher values increase randomness, while lower values make the output more deterministic. Set to null or a value greater than 100 to disable.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TopP',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '核采样的概率阈值，控制模型生成文本的多样性。top_p越高，生成的文本更多样。取值范围：（0,1.0]。',
+ 'description' => 'The probability threshold for nucleus sampling, used to control the diversity of the generated text. Higher Top-P values result in more diverse generated text. Valid values: (0,1.0].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0.5',
+ ],
+ ],
+ [
+ 'name' => 'XDashScopeDataInspection',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '在通义千问 API 的内容安全能力基础上，是否进一步识别输入输出内容的违规信息。'."\n",
+ 'description' => 'Specifies whether to further identify non-compliant information in both input and output content, building upon the built-in content safety capabilities of the Tongyi Qianwen API.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'SearchOptions',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '联网搜索的策略。',
+ 'description' => 'Web search strategy.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'Web search strategy.'."\n",
+ 'example' => '{}',
+ ],
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'ModalitiesList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '输出数据的模态，仅适用于 Qwen-Omni 模型。',
+ 'description' => 'Output data modality; only applicable to the Qwen-Omni model.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '输出数据的模态',
+ 'description' => 'Output data modality.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ 'required' => false,
+ 'example' => '["text","audio"]',
+ ],
+ ],
+ [
+ 'name' => 'AudioJson',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '输出音频的音色与格式，仅适用于 Qwen-Omni 模型，且modalities参数需为["text","audio"]。',
+ 'description' => 'Output audio voice and format; only applicable to the Qwen-Omni model, provided that the modalities parameter is set to \\["text", "audio"].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ [
+ 'name' => 'EnableCodeInterpreter',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否开启代码解释器功能。仅当model为qwen3-max-preview且enable_thinking为true时生效。',
+ 'description' => 'Specifies whether to enable the code interpreter feature. Takes effect only when model is qwen3-max-preview and enable_thinking is true.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Logprobs',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否返回输出 Token 的对数概率，',
+ 'description' => 'Specifies whether to return the log probabilities of the output tokens.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'VlHighResolutionImages',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否将输入图像的像素上限提升至 16384 Token 对应的像素值。',
+ 'description' => 'Specifies whether to increase the maximum pixel limit of input images to the equivalent of 16,384 tokens.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EnableSearch',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否开启联网搜索。',
+ 'description' => 'Whether to enable web search.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'IncludeUsage',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '流式输出中是否在响应的最后一个数据块包含Token消耗信息。',
+ 'description' => 'Specifies whether to include token usage information in the final chunk of the streaming response.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Stream',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否使用流式输出',
+ 'description' => 'Specifies whether to use streaming output.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => '1-68f11da7e2b826dcc63c5877-hd',
+ ],
+ ],
+ [
+ 'name' => 'Input',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '向量化模型的输入',
+ 'description' => 'The input to the embedding model.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Dimensions',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '向量化模型的维度',
+ 'description' => 'The embedding dimensions.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '256',
+ ],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '模型配置参数',
+ 'description' => 'Model configuration parameters.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功返回',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'Request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '283C461F-11D8-48AA-B695-DF092DA32AF3',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'UnknownError',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**: The request was successful.'."\n"
+ .'* **false**: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"283C461F-11D8-48AA-B695-DF092DA32AF3\\",\\n \\"Data\\": \\"true\\",\\n \\"ErrorCode\\": \\"UnknownError\\",\\n \\"ErrorMessage\\": \\"UnknownError\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ChatWithDesensitizeSSE',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-qingdao',
+ 'endpoint' => 'dms-enterprise.cn-qingdao.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'dms-enterprise.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'dms-enterprise.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-huhehaote',
+ 'endpoint' => 'dms-enterprise.cn-huhehaote.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'dms-enterprise.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'dms-enterprise.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'dms-enterprise.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'dms-enterprise.cn-chengdu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'dms-enterprise.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'dms-enterprise.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'dms-enterprise.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-2',
+ 'endpoint' => 'dms-enterprise.ap-southeast-2.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'dms-enterprise.ap-southeast-3.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'dms-enterprise.ap-southeast-5.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'dms-enterprise.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'dms-enterprise.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1',
+ 'endpoint' => 'dms-enterprise.eu-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'dms-enterprise.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'me-east-1',
+ 'endpoint' => 'dms-enterprise.me-east-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 11:44:15 +0000