From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/oceanbasepro/2019-09-01/api-docs.php | 60268 ++++++++-------------- 1 file changed, 21848 insertions(+), 38420 deletions(-) (limited to 'data/en_us/oceanbasepro/2019-09-01/api-docs.php') diff --git a/data/en_us/oceanbasepro/2019-09-01/api-docs.php b/data/en_us/oceanbasepro/2019-09-01/api-docs.php index a9ba55e..10b8a22 100644 --- a/data/en_us/oceanbasepro/2019-09-01/api-docs.php +++ b/data/en_us/oceanbasepro/2019-09-01/api-docs.php @@ -1,263 +1,97 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'OceanBasePro', - 'version' => '2019-09-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'OceanBasePro', 'version' => '2019-09-01'], 'directories' => [ [ - 'id' => 191859, - 'title' => 'Tag Management', + 'children' => ['ModifyTagName'], 'type' => 'directory', - 'children' => [ - 'ModifyTagValueName', - 'ModifyTagName', - 'DescribeTagValues', - 'DeleteTagValue', - 'DeleteTag', - 'CreateTagValue', - 'CreateTag', - 'ModifyInstanceTags', - 'DescribeTenantTags', - 'ModifyTenantTags', - 'DescribeInstanceTags', - ], + 'title' => 'Tag management', ], [ - 'id' => 134089, - 'title' => 'Cluster management', + 'children' => ['CreateInstance', 'DescribeInstance', 'DescribeInstances', 'DescribeInstanceTopology', 'DescribeAvailableSpec', 'DescribeAvailableZone', 'DescribeInstanceCreatableZone', 'ModifyInstanceSpec', 'ModifyInstanceTemporaryCapacity', 'RemoveStandbyInstance', 'DescribeStandbyCreateMode'], 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'DescribeInstance', - 'DescribeInstances', - 'DescribeInstanceTopology', - 'DescribeAvailableSpec', - 'DescribeAvailableZone', - 'DescribeInstanceCreatableZone', - 'ModifyInstanceName', - 'ModifyInstanceSpec', - 'ModifyInstanceNodeNum', - 'ModifyInstanceTemporaryCapacity', - 'SwitchoverInstance', - 'RemoveStandbyInstance', - 'DeleteInstances', - 'DescribeInstanceSummary', - 'DescribeStandbyCreateMode', - ], + 'title' => 'Cluster management', ], [ - 'id' => 134094, - 'title' => 'Tenant management', + 'children' => ['CreateTenantReadOnlyConnection', 'DescribeTenants', 'DescribeInstanceTenantModes', 'DescribeTenant', 'DescribeAvailableCpuResource', 'DescribeCharset', 'DescribeInstanceAvailableZones', 'DescribeTenantZonesRead', 'DescribeTimeZones', 'DescribeZones', 'ModifyTenantPrimaryZone', 'DeleteTenants'], 'type' => 'directory', - 'children' => [ - 'DescribeTenantReadableScn', - 'CreateTenant', - 'CreateTenantReadOnlyConnection', - 'CreateTenantSecurityIpGroup', - 'DescribeTenants', - 'DescribeInstanceTenantModes', - 'DescribeTenant', - 'DescribeAvailableCpuResource', - 'DescribeAvailableMemResource', - 'DescribeCharset', - 'DescribeInstanceAvailableZones', - 'DescribeTenantZonesRead', - 'DescribeTimeZones', - 'DescribeTenantSecurityIpGroups', - 'DescribeZones', - 'ModifyTenantPrimaryZone', - 'ModifyTenantResource', - 'ModifyTenantSecurityIpGroup', - 'DeleteTenants', - 'DeleteTenantSecurityIpGroup', - ], + 'title' => 'Tenant management', ], [ - 'id' => 134110, - 'title' => 'Tenant user management', + 'children' => ['CreateTenantUser', 'DescribeTenantUsers', 'ModifyTenantUserPassword', 'ModifyTenantUserRoles'], 'type' => 'directory', - 'children' => [ - 'CreateTenantUser', - 'DescribeTenantUsers', - 'DescribeTenantUserRoles', - 'ModifyTenantUserDescription', - 'ModifyTenantUserPassword', - 'ModifyTenantUserRoles', - 'DeleteTenantUsers', - ], + 'title' => 'Tenant account management', ], [ - 'id' => 134118, - 'title' => 'Database management', + 'children' => ['CreateDatabase', 'ModifyDatabaseDescription', 'ModifyTenantUserStatus', 'ModifyDatabaseUserRoles', 'DeleteDatabases'], 'type' => 'directory', - 'children' => [ - 'CreateDatabase', - 'DescribeDatabases', - 'ModifyDatabaseDescription', - 'ModifyTenantUserStatus', - 'ModifyDatabaseUserRoles', - 'DeleteDatabases', - ], + 'title' => 'Database management', ], [ - 'id' => 134125, - 'title' => 'Parameter management', + 'children' => ['DescribeParameters', 'ModifyParameters'], 'type' => 'directory', - 'children' => [ - 'DescribeParameters', - 'DescribeParametersHistory', - 'ModifyParameters', - ], + 'title' => 'Parameter management', ], [ - 'id' => 181884, - 'title' => 'Session management', + 'children' => ['BatchKillProcessList', 'DescribeProcessStatsComposition'], 'type' => 'directory', - 'children' => [ - 'DescribeSessionList', - 'BatchKillSessionList', - 'BatchKillProcessList', - 'DescribeProcessStatsComposition', - 'KillProcessList', - ], + 'title' => 'Session connection', ], [ - 'id' => 134137, - 'title' => 'Diagnostic management', + 'children' => ['DescribeOasAnomalySQLList', 'DescribeSampleSqlRawTexts', 'DescribeOasSQLDetails', 'DescribeOasSQLPlans', 'DescribeSQLSamples', 'DescribeOasTopSQLList', 'DescribeOasSlowSQLList', 'DescribeOutlineBinding', 'DescribeRecommendIndex', 'DescribeSQLTuningAdvices', 'DescribeSqlAuditStat', 'CreateOasOutlineTask'], 'type' => 'directory', - 'children' => [ - 'DescribeOasAnomalySQLList', - 'DescribeSampleSqlRawTexts', - 'DescribeOasSQLDetails', - 'DescribeOasSQLPlans', - 'DescribeSQLSamples', - 'DescribeOasSQLHistoryList', - 'DescribeOasTopSQLList', - 'DescribeOasSlowSQLList', - 'DescribeOutlineBinding', - 'DescribeRecommendIndex', - 'DescribeSQLTuningAdvices', - 'DescribeSqlAuditStat', - 'CreateOasOutlineTask', - ], + 'title' => 'Diagnostics management', ], [ - 'id' => 134129, - 'title' => 'Security settings', + 'children' => ['ModifyInstanceSSL', 'DescribeInstanceSSL', 'CreateSecurityIpGroup', 'DescribeSecurityIpGroups', 'DescribeTenantEncryption', 'ModifySecurityIps', 'ModifyTenantEncryption', 'DeleteSecurityIpGroup', 'DescribeBackupEncryptedString'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceSSL', - 'DescribeInstanceSSL', - 'CreateSecurityIpGroup', - 'DescribeSecurityIpGroups', - 'DescribeTenantSecurityConfigs', - 'DescribeTenantEncryption', - 'DescribeInstanceSecurityConfigs', - 'ModifySecurityIps', - 'ModifyTenantEncryption', - 'DeleteSecurityIpGroup', - 'DescribeBackupEncryptedString', - ], + 'title' => 'Security settings', ], [ - 'id' => 134134, - 'title' => 'Metrics management', + 'children' => ['DescribeMetricsDataV2', 'DescribeMetricsData', 'DescribeNodeMetrics', 'DescribeTenantMetrics'], 'type' => 'directory', - 'children' => [ - 'DescribeMetricsDataV2', - 'DescribeMetricsData', - 'DescribeNodeMetrics', - 'DescribeTenantMetrics', - ], + 'title' => 'Monitoring management', ], [ - 'id' => 166104, - 'title' => 'Data migration', - 'type' => 'directory', 'children' => [ - 'CreateProject', - 'StartProject', - 'StopProject', - 'ResumeProject', - 'ReleaseProject', - 'DeleteProject', - 'ListProjects', - 'DescribeProject', - 'DescribeProjectSteps', - 'DescribeProjectStepMetric', - 'DescribeProjectProgress', - 'DescribeProjectComponents', - 'ListProjectFullVerifyResult', - 'StartProjectsByLabel', - 'StopProjectsByLabel', - 'GetUploadOssUrl', - 'ListWorkerInstances', - 'CreateMySqlDataSource', - 'CreateOceanBaseDataSource', - 'ListDataSource', - 'CreateLabel', - 'ListAllLabels', - 'CreateOmsMysqlDataSource', - 'ReleaseWorkerInstance', - 'CancelProjectModifyRecord', - 'RetryProjectModifyRecords', - 'StopProjectModifyRecords', - 'ListProjectModifyRecords', - 'CreateProjectModifyRecords', - 'UpdateProjectConfig', - 'DeleteDataSource', - 'CreateRdsPostgreSQLDataSource', + 'CreateProject', 'StartProject', 'StopProject', 'ResumeProject', 'ReleaseProject', 'DeleteProject', 'ListProjects', 'DescribeProject', 'DescribeProjectSteps', 'DescribeProjectStepMetric', 'DescribeProjectProgress', 'DescribeProjectComponents', 'ListProjectFullVerifyResult', 'StartProjectsByLabel', 'StopProjectsByLabel', 'GetUploadOssUrl', 'ListWorkerInstances', 'CreateMySqlDataSource', 'CreateOceanBaseDataSource', 'ListDataSource', + 'CreateLabel', 'ListAllLabels', 'ReleaseWorkerInstance', 'CancelProjectModifyRecord', 'RetryProjectModifyRecords', 'StopProjectModifyRecords', 'ListProjectModifyRecords', 'CreateProjectModifyRecords', 'UpdateProjectConfig', 'DeleteDataSource', 'CreateRdsPostgreSQLDataSource', ], + 'type' => 'directory', + 'title' => 'Data transmission', ], [ - 'id' => 188965, - 'title' => 'Backup and restoration management', + 'children' => ['DescribeBackupSetDownloadLink', 'DescribeDataBackupSet', 'CreateBackupSetDownloadLink', 'DescribeRestorableTenants'], 'type' => 'directory', - 'children' => [ - 'DescribeBackupSetDownloadLink', - 'DescribeDataBackupSet', - 'CreateBackupSetDownloadLink', - 'DescribeRestorableTenants', - ], + 'title' => 'Backup and recovery', ], [ - 'id' => 192529, - 'title' => 'Not translated (other)', + 'children' => ['DescribeAnomalySQLList', 'DescribeSQLDetails', 'DescribeSQLHistoryList', 'DescribeTopSQLList'], 'type' => 'directory', - 'children' => [ - 'DescribeAnomalySQLList', - 'DescribeSQLDetails', - 'DescribeSQLPlans', - 'DescribeSQLHistoryList', - 'DescribeTopSQLList', - 'DescribeSlowSQLList', - 'DescribeSlowSQLHistoryList', - ], + 'title' => 'Untranslated (other)', ], [ - 'id' => 195786, - 'title' => 'others', + 'children' => ['DescribeProxyService', 'DescribeTenantAddressProxyInfo'], 'type' => 'directory', + 'title' => 'Other', + ], + [ 'children' => [ - 'DescribeProxyService', + 'BatchKillSessionList', 'CreateOmsMysqlDataSource', 'CreateTag', 'CreateTagValue', 'CreateTenant', 'CreateTenantSecurityIpGroup', 'DeleteInstances', 'DeleteTag', 'DeleteTagValue', 'DeleteTenantSecurityIpGroup', 'DeleteTenantUsers', 'DescribeAvailableMemResource', 'DescribeDatabases', 'DescribeInstanceSecurityConfigs', 'DescribeInstanceSummary', 'DescribeInstanceTags', 'DescribeOasSQLHistoryList', 'DescribeParametersHistory', 'DescribeSQLPlans', 'DescribeSessionList', + 'DescribeSlowSQLHistoryList', 'DescribeSlowSQLList', 'DescribeTagValues', 'DescribeTenantReadableScn', 'DescribeTenantSecurityConfigs', 'DescribeTenantSecurityIpGroups', 'DescribeTenantTags', 'DescribeTenantUserRoles', 'KillProcessList', 'ModifyInstanceName', 'ModifyInstanceNodeNum', 'ModifyInstanceTags', 'ModifyTagValueName', 'ModifyTenantResource', 'ModifyTenantSecurityIpGroup', 'ModifyTenantTags', 'ModifyTenantUserDescription', 'SwitchoverInstance', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ModifyTagValueName' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchKillProcessList' => [ + 'summary' => 'BatchKillProcessList', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -265,45 +99,27 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 1', - 'title' => '标签组名称', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'Value', + 'name' => 'SessionList', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag 1', - 'title' => '标签名称', - ], + 'schema' => ['description' => 'The list of sessions to close.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"ProxySessId":"752113700739156671","SessionId":3221555062,"ServerIp":"10.***.**.***"}] ', 'title' => ''], ], [ - 'name' => 'NewValue', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The new name of the tag.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag 2', - 'title' => '标签新名称', - ], + 'schema' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'required' => true, 'example' => 't33h8y08k****', 'title' => ''], + ], + [ + 'name' => 'ByObSessionId', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether to perform the KILL operation based on the specified database connection ID. The default value is false, which means the KILL operation is performed based on the proxy link ID to terminate all corresponding database connections. ', 'title' => 'Indicates whether to perform the KILL operation based on the specified database connection ID. The default value is false, which means the KILL operation is performed based on the proxy link ID to terminate all corresponding database connections. ', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ @@ -312,267 +128,258 @@ 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The tag renaming result.', - 'type' => 'string', - 'example' => 'update tag-value name success', - 'title' => '标签修改情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'The array of the return result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the calling is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag-value name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'ModifyTagValueName', - 'summary' => 'You can call this operation to rename a tag.', - ], - 'ModifyTagName' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Shutdown Sessions ', + 'changeSet' => [ + ['createdAt' => '2025-04-22T14:06:02.000Z', 'description' => 'Request parameters changed'], ], + 'ramActions' => [], + ], + 'BatchKillSessionList' => [ + 'summary' => 'You can call this operation to close sessions between the ApsaraDB for OceanBase and the application in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeSessionList.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 1', - 'title' => '标签组名称', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'NewKey', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The new name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 2', - 'title' => '标签组新名称', - ], + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****', 'title' => ''], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The list of sessions, which is concatenated with commas.'."\n" + .'>The session information is obtained from the result returned by the DescribeSessionList API.', 'type' => 'string', 'required' => true, 'example' => '342,354,343'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The tag group renaming result.', - 'type' => 'string', - 'example' => 'update tag name success', - 'title' => '标签组修改情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'ModifyTagName', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'BatchKillSessionList', + 'changeSet' => [], + 'ramActions' => [], ], - 'DescribeTagValues' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CancelProjectModifyRecord' => [ + 'summary' => 'This API cancels a modification by its record ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the resource.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tag', - 'title' => '资源类型', - ], + 'schema' => ['description' => 'The ID of the modification record.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Map' => [ - 'description' => 'The mappings between tag groups and tags.', - 'type' => 'string', - 'example' => '"{\\"Tag group 2\\":[\\"Tag 2-1\\",\\"Tag 2-2\\"],\\"Tag group 1\\":[\\"Tag 1-1\\"]}"', - 'title' => '标签组与标签的映射关系', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', + 'Success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Contains values for the placeholders in the `Message` string.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Contains values for the placeholders in the template specified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Contains values for the placeholders in the template specified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The recommended action.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the proposal template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Contains values for the placeholders in the template specified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details, used for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This parameter is for backward compatibility. Use the `ErrorDetail.Code` parameter instead.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This parameter is for backward compatibility. Use the `ErrorDetail.Message` parameter instead.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'A troubleshooting proposal. This parameter is for backward compatibility. Use the `ErrorDetail.Proposal` parameter instead.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID. Provide this ID when you contact technical support.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned when you use pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter is returned when you use pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter is returned when you use pagination.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => ['description' => 'The data returned by the request.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Cancel modification operation', + 'description' => 'Only modification records in the PENDING state can be canceled.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:CancelProjectModifyRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Map\\": \\"\\\\\\"{\\\\\\\\\\\\\\"标签组2\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值2-1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"标签值2-2\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"标签组1\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值1-1\\\\\\\\\\\\\\"]}\\\\\\"\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'DescribeTagValues', - 'summary' => 'You can call this operation to query tags.', ], - 'DeleteTagValue' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateBackupSetDownloadLink' => [ + 'summary' => 'You can call this operation to create a backup set download link in OceanBase Database.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 1', - 'title' => '标签组名称', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp67acfmxazb4p****'], ], [ - 'name' => 'Value', + 'name' => 'BackupSetId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag 2', - 'title' => '标签名称', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the target backup set.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bak-6f****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The tag deletion result.', - 'type' => 'string', - 'example' => 'delete tag-value success', - 'title' => '标签删除情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The ID of the download task corresponding to the target backup set.', 'example' => '100***012'], + ], + 'description' => 'The returned data.'."\n", + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'The return result of the request.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateBackupSetDownloadLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'DeleteTagValue', - 'summary' => 'You can call this operation to delete a tag from a tag group.', ], - 'DeleteTag' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDatabase' => [ + 'summary' => 'Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -580,5694 +387,3832 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'DatabaseName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 2', - 'title' => '标签组名称', - ], + 'schema' => ['title' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', 'description' => 'Alibaba Cloud CLI', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sms_pre'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The tag group deletion result.', - 'type' => 'string', - 'example' => 'delete tag success', - 'title' => ' 标签组删除情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', - ], - ], - ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The token used to ensure idempotence. '."\n" + .'The value of this parameter is generated by the client and is unique among different requests. '."\n" + ."\n" + .'>
ClientToken can contain only ASCII characters, and cannot exceed 64 characters in length. ', 'description' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'DeleteTag', - 'summary' => 'You can call this operation to delete a tag group.', - ], - 'CreateTagValue' => [ - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Encoding', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The ID of the tenant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'utf8mb4'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'Value', + 'name' => 'Collation', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag 1', - 'title' => '标签名称', - ], + 'schema' => ['title' => '字符序', 'description' => 'The encoding standard of the database.'."\n" + .'For more information, see the Charset field returned by the DescribeCharset operation. ', 'type' => 'string', 'required' => false, 'example' => 'utf8mb4_general_ci'], ], [ - 'name' => 'Key', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tag group.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Tag group 1', - 'title' => '标签组名称', - ], + 'schema' => ['title' => 'The description of the database.', 'description' => 'The collation.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => 'The identifier of the client.', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database. ', 'type' => 'string', 'required' => false, 'example' => '123e4567-****-12d3-a456-42665544****'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => 'The request ID.', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **CreateDatabase**. ', 'type' => 'string', 'required' => false, 'example' => 'this is a test database'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The return result of the request.', + 'title' => 'The ID of the OceanBase cluster.', + 'description' => 'Example 1', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The tag creation result.', - 'type' => 'string', - 'example' => 'create tag value success', - 'title' => '标签创建情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求ID', - ], + 'RequestId' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=CreateDatabase'."\n" + .'&DatabaseName=sms_pre'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&Encoding=utf8mb4'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&ClientToken=123e4567-e89b-12d3-a456-426655440000'."\n" + .'&Description=This is a test database'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'DatabaseName' => ['title' => 'You can call this operation to create a database in a tenant. ', 'description' => 'CreateDatabase', 'type' => 'string', 'example' => 'sms_pre'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"create tag value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'CreateTagValue', - 'summary' => 'You can call this operation to create a tag.', - ], - 'CreateTag' => [ - 'methods' => [ - 'post', - 'put', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"DatabaseName\\": \\"sms_pre\\"\\n}","type":"json"}]', + 'title' => 'Create Database', + 'changeSet' => [ + ['createdAt' => '2023-07-04T02:52:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-28T06:07:38.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateInstance' => [ + 'summary' => 'Create an OceanBase database cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the tag group.', + 'title' => 'The billing method of the instance. Valid values: PrePay: the subscription billing method. You must ensure that the remaining balance or credit balance of your account can cover the cost of the subscription. Otherwise, you will receive an InvalidPayMethod error. PostPay: the pay-as-you-go billing method. This is the default value. By default, fees are charged on an hourly basis.', + 'description' => 'The billing method of the instance. Valid values: '."\n" + .'- PrePay: the subscription billing method. You must ensure that the remaining balance or credit balance of your account can cover the cost of the subscription. Otherwise, you will receive an InvalidPayMethod error. '."\n" + .'- PostPay: the pay-as-you-go billing method. This is the default value. By default, fees are charged on an hourly basis.', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'Tag group 1', - 'title' => '标签组名称', + 'enumValueTitles' => ['PrePay' => 'PrePay', 'PostPay' => 'PostPay'], + 'example' => 'PrePay', + 'enum' => ['PrePay', 'PostPay'], ], ], [ - 'name' => 'ClientToken', + 'name' => 'Series', 'in' => 'formData', 'schema' => [ - 'description' => 'The identifier of the client.', + 'title' => 'The series of the OceanBase instance. Valid values: - normal: The Standard Cluster Edition (ESSD). This is the default value. - normal_ssd: The Standard Cluster Edition (Local SSD). - history: The History Cluster Edition. ', + 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" + .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" + .'- history: History Database Cluster Edition.', 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The tag group creation result.', - 'type' => 'string', - 'example' => 'Create tag success', - 'title' => '标签组创建情况', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', - 'title' => '请求 ID', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'required' => true, + 'docRequired' => true, + 'example' => 'normal', + 'enum' => ['normal', 'normal_ssd', 'history', 'normal_kv', 'normal_hg'], ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Create tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', - 'title' => 'CreateTag', - 'summary' => 'You can call this operation to create a tag group.', - ], - 'ModifyInstanceTags' => [ - 'summary' => 'You can call this operation to modify the tags of a cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Zones', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the zone to which the instance belongs. For more information about how to obtain the list of zones, see DescribeZones. ', 'description' => 'The ID of the zone to which the instance belongs. '."\n" + .'For more information about how to obtain the list of zones, see [DescribeZones](~~25610~~). ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j'], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'InstanceClass', 'in' => 'formData', 'schema' => [ - 'title' => 'Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster. ', + 'title' => 'The specifications of the cluster. You can specify one of the following four plans: - 8C32GB: indicates 8 CPU cores and 32 GB of memory. - 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value. - 30C180GB: indicates 30 CPU cores and 180 GB of memory. - 62C400GB: indicates 62 CPU cores and 400 GB of memory.', + 'description' => 'The specifications of the cluster. '."\n" + .'You can specify one of the following four plans: '."\n" + .' - 8C32GB: indicates 8 CPU cores and 32 GB of memory. '."\n" + .' - 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" + .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory. '."\n" + .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'enumValueTitles' => [ + '64C380GB' => '64C380GB', '64C400GB' => '64C400GB', '32C70GB' => '32C70GB', '14C70GB' => '14C70GB', '16C32GB' => '16C32GB', '4C16GB' => '4C16GB', '32C160GB' => '32C160GB', '8C32GB' => '8C32GB', '16C70GB' => '16C70GB', '24C120GB' => '24C120GB', + '32C180GB' => '32C180GB', '30C180GB' => '30C180GB', '40C64GB' => '40C64GB', '62C400GB' => '62C400GB', '20C32GB' => '20C32GB', '104C600GB' => '104C600GB', '64C180GB' => '64C180GB', + ], + 'example' => '14C70GB', + 'enum' => [ + '8C32GB', '14C70GB', '30C180GB', '62C400GB', '16C70GB', '24C120GB', '32C160GB', '64C380GB', '20C32GB', '40C64GB', '4C16GB', '32C180GB', '64C400GB', '16C32GB', '32C70GB', '64C180GB', '104C600GB', '8C32G', '14C70G', '30C180G', + '62C400G', '16C70G', '24C120G', '32C160G', '64C380G', '20C32G', '40C64G', '4C16G', '32C180G', '64C400G', '16C32G', '32C70G', '64C180G', '104C600G', '24C48GB', '24C48G', '8C16G(generalspec)', '16C32G(generalspec)', '24C48G(generalspec)', '32C70G(generalspec)', + '64C180G(generalspec)', '8C16GB', '8C16G', + ], ], ], [ - 'name' => 'Tags', + 'name' => 'DiskSize', 'in' => 'formData', - 'schema' => [ - 'title' => '标签值', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', - ], + 'schema' => ['title' => 'The size of the storage space, in GB. The limits on the storage space vary with the cluster specifications: - 8C32GB: 100 GB to 10000 GB. - 14C70GB: 200 GB to 10000 GB. - 30C180GB: 400 GB to 10000 GB. - 62C400GB: 800 GB to 10000 GB. The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans. ', 'description' => 'The size of the storage space,in GB. '."\n" + .'The limits on the storage space vary with the cluster specifications: '."\n" + .'- 8C32GB: 100 GB to 10000 GB '."\n" + .'- 14C70GB: 200 GB to 10000 GB '."\n" + .'- 30C180GB: 400 GB to 10000 GB '."\n" + .'- 62C400GB: 800 GB to 10000 GB '."\n" + .'The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '200'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned response.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Message' => [ - 'title' => '打标情况', - 'description' => 'The tag modification result.', - 'type' => 'string', - 'example' => 'done', - ], - ], - ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['title' => 'The valid duration of the purchased resources. The unit is specified by the PeriodUnit parameter. This parameter is only valid and required only when InstanceChargeType parameter is set to PrePaid. If the DedicatedHostId parameter is specified, the subscription period of the instance must be shorter than that of the dedicated host. Valid values: If the PeriodUnit parameter is set to Week: 1, 2, 3, and 4. If the PeriodUnit parameter is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12,24, 36, 48, and 60. ', 'description' => 'The valid duration of the purchased resources. The unit is specified by the PeriodUnit parameter. '."\n" + .'This parameter is valid and required only when the InstanceChargeType parameter is set to PrePaid. '."\n" + .'Valid values: '."\n" + .'- When the PeriodUnit parameter is set to Month: "1", "2", "3", "4", "5", "6", "7", "8", "9". '."\n" + .'- When the PeriodUnit parameter is set to Year: "1", "2", "3".', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"add resource tag relation success\\"\\n}","type":"json"}]', - 'title' => 'ModifyInstanceTags', - ], - 'DescribeTenantTags' => [ - 'summary' => 'You can call this operation to query the tags of tenants in a cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PeriodUnit', + 'in' => 'formData', + 'schema' => ['title' => 'The unit of the valid duration of the purchased resources. Valid value for subscription: Month. Default value: Month for subscription, and Hour for pay-as-you-go. ', 'description' => 'The unit of the valid duration of the purchased resources. '."\n" + .'Valid value for subscription: Month or Year.'."\n" + .'Default value: Month for subscription, and Hour for pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AutoRenew', + 'in' => 'formData', + 'schema' => ['title' => 'Specifies whether to enable automatic renewal. This parameter is valid only when the ChargeType parameter is set to PrePaid. Valid values: - true: enables automatic renewal for the instance. false: disables automatic renewal for the instance. This is the default value. ', 'description' => 'Specifies whether to enable automatic renewal. '."\n" + .'This parameter is valid only when the ChargeType parameter is set to PrePaid. Valid values: '."\n" + .'- true: enables automatic renewal for the instance. '."\n" + .'- false: disables automatic renewal for the instance. This is the default value. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'formData', + 'schema' => ['title' => 'The automatic renewal period of the instance. This parameter is required when the AutoRenew parameter is setto true. Valid values: If the PeriodUnit parameter is set to Week: 1, 2, and 3. If the PeriodUnit parameter is set to Month: 1, 2, 3, 6, and 12. ', 'description' => 'The automatic renewal period of the instance. This parameter is required when the AutoRenew parameter is set to true. Valid values: '."\n" + .'- If the PeriodUnit parameter is set to Year: "1", "2", and "3". '."\n" + .'- If the PeriodUnit parameter is set to Month: "1", "2", "3", "6", and "12".', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the resource group to which the instance belongs.', 'description' => 'The ID of the resource group to which the instance belongs. ', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the cluster. ', 'description' => 'The name of the OceanBase cluster. '."\n" + .'It must be 1 to 20 characters in length. '."\n" + .'If this parameter is not specified, the value is the instance ID of the cluster by default.', 'type' => 'string', 'required' => false, 'example' => 'amap_aos_tx_ob', 'maxLength' => 64, 'minLength' => 0], + ], + [ + 'name' => 'ObVersion', + 'in' => 'formData', + 'schema' => ['title' => 'Oceanbase Server的版本号。', 'description' => 'OceanBase Server version number.', 'type' => 'string', 'required' => false, 'example' => '2.2.77'], + ], + [ + 'name' => 'DiskType', 'in' => 'formData', 'schema' => [ - 'title' => 'Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster. ', + 'title' => '集群的存储类型。仅在标准集群版（云盘）下生效。当前支持两种类型：- cloud_essd_pl1：云盘ESSD PL1; -- cloud_essd_pl1：云盘ESSD PL1; - cloud_essd_pl0：云盘ESSD PL0。默认值为cloud_essd_pl1。', + 'description' => 'The type of the storage disk where the cluster is deployed. This parameter takes effect only for Standard Cluster Edition (Cloud Disk).'."\n" + .'Valid values:'."\n" + .'- cloud_essd_pl1: ESSD PL1.'."\n" + .'- cloud_essd_pl0: ESSD PL0. Default value: cloud_essd_pl1.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'required' => false, + 'example' => 'cloud_essd_pl1', + 'default' => 'cloud_essd_pl1', + 'enum' => ['cloud_essd_pl1', 'cloud_essd_pl0'], ], ], [ - 'name' => 'TenantIds', + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会创建实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接创建实例。', 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the instance is not created. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: The actual request is sent and no dry run is performed. The instance is created if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ReplicaMode', 'in' => 'formData', 'schema' => [ - 'title' => '租户id的json串', - 'description' => 'The JSON string of the tenant ID.', + 'title' => '全功能型副本数。3: 表示3个全功能型副本; 2: 表示2个全功能型副本.', + 'description' => 'The number of full-featured replicas.'."\n" + .'- 3F: three full-featured replicas.'."\n" + .'- 2F1L: two full-featured replicas and one log replica.'."\n" + .'- 2F1A: two full-featured replicas and one arbitration service.'."\n" + .'- ApsaraDB for OceanBase earlier than V4.1 supports 3F and 2F1L.'."\n" + .'- ApsaraDB for OceanBase V4.1 or later supports 3F and 2F1A.'."\n" + .'- An ApsaraDB for OceanBase instance deployed across three zones supports only 3F.'."\n" + .'- An ApsaraDB for OceanBase instance deployed across two zones supports 2F1A or 2F1L, depending on the version.'."\n" + .'- An ApsaraDB for OceanBase instance deployed in a single zone supports 3F, 2F1A, or 2F1L, depending on the version.', 'type' => 'string', - 'required' => true, - 'example' => '["t5r0x2f6q****", "t33h8y08k****", "t5r41rtl7****"]', + 'required' => false, + 'example' => '3', + 'enum' => ['3', '2'], ], ], [ - 'name' => 'Tags', + 'name' => 'IsolationOptimization', 'in' => 'formData', 'schema' => [ - 'title' => '标签值', - 'description' => 'The tags.', + 'title' => '', + 'description' => 'Specifies whether to enable the control group feature.'."\n" + .'Valid values:'."\n" + .'- true'."\n" + .'- false', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '[{"Key": "xxx", "Value", "xxx"}]', + 'example' => 'true', + 'enum' => ['true', 'false'], ], ], + [ + 'name' => 'PrimaryInstance', + 'in' => 'formData', + 'schema' => ['title' => '主实例id', 'description' => 'Primary instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ob3h8ytroxxxxx'], + ], + [ + 'name' => 'PrimaryRegion', + 'in' => 'formData', + 'schema' => ['title' => '主实例Region', 'description' => 'Primary instance region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => ['description' => 'CPU architecture', 'title' => 'CPU architecture', 'type' => 'string', 'example' => 'x86', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned response.', + 'title' => 'The return result of the request.', + 'description' => 'The request ID. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TagResources' => [ - 'title' => '标签列表', - 'description' => 'The list of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'The returned response.', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源id', - 'description' => 'The ID of the resource.', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource.', - 'type' => 'string', - 'example' => 'instance', - ], - 'Tag' => [ - 'title' => '资源标签', - 'description' => 'The tag of the resource.', - 'type' => 'string', - 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', - ], - ], - ], + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'title' => 'Response parameters', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'i-bp67acfmxazb4p****'], + 'OrderId' => ['title' => '订单ID。该参数只有创建包年包月ECS实例（请求参数InstanceChargeType=PrePaid）时有返回值。', 'description' => 'Order ID. The ID of the order that you have placed.'."\n" + .'This parameter returns a value after you create a pre-paid or post-paid cluster.', 'type' => 'string', 'example' => '1234567890'], + 'ResourceGroupId' => ['title' => '资源组ID', 'description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-***************'], + 'DryRunResult' => ['title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', 'description' => 'The result of the dry-run request.'."\n" + ."\n" + .'If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', 'type' => 'boolean', 'example' => 'false'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"ob317v4uif****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": \\"[{\\\\\\"Key\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"Value\\\\\\", \\\\\\"xxx\\\\\\"},{}]\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeTenantTags', - ], - 'ModifyTenantTags' => [ - 'summary' => 'You can call this operation to modify the tags of a tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户id', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't33h8y08k****', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'formData', - 'schema' => [ - 'title' => '标签值', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"Key": "xxx", "Value", "xxx"}]', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ['errorCode' => 'InstanceName.ModifyFailed', 'errorMessage' => 'InstanceName.ModifyFailed', 'description' => ''], + ['errorCode' => 'InstanceClass.InvalidValue', 'errorMessage' => 'InstanceClass.InvalidValue', 'description' => ''], + ['errorCode' => 'InstanceType.Unsupport', 'errorMessage' => 'InstanceType.Unsupport', 'description' => ''], + ['errorCode' => 'ZoneList.Unsupport', 'errorMessage' => 'ZoneList.Unsupport', 'description' => ''], + ['errorCode' => 'InstanceId.Invalid', 'errorMessage' => 'InstanceId.Invalid', 'description' => ''], + ['errorCode' => 'InstanceId.Missing', 'errorMessage' => 'InstanceId.Missing', 'description' => ''], + ['errorCode' => 'Instance.Name.Missing', 'errorMessage' => 'Instance.Name.Missing', 'description' => ''], + ['errorCode' => 'ListCluster.Fail', 'errorMessage' => 'ListCluster.Fail', 'description' => ''], + ['errorCode' => 'GetCluster.Fail', 'errorMessage' => 'GetCluster.Fail', 'description' => ''], + ['errorCode' => 'ListClusterGroup.Fail', 'errorMessage' => 'ListClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'GetClusterGroup.Fail', 'errorMessage' => 'GetClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'ListInstance.Fail', 'errorMessage' => 'ListInstance.Fail', 'description' => ''], + ['errorCode' => 'GetInstance.Fail', 'errorMessage' => 'GetInstance.Fail', 'description' => ''], + ['errorCode' => 'ListTenant.Fail', 'errorMessage' => 'ListTenant.Fail', 'description' => ''], + ['errorCode' => 'GetTenant.Fail', 'errorMessage' => 'GetTenant.Fail', 'description' => ''], + ['errorCode' => 'Instance.ListAliyunInstance.Fail', 'errorMessage' => 'Instance.ListAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'Instance.GetAliyunInstance.Fail', 'errorMessage' => 'Instance.GetAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'ListZone.Fail', 'errorMessage' => 'ListZone.Fail', 'description' => ''], + ['errorCode' => 'ListObServer.Fail', 'errorMessage' => 'ListObServer.Fail', 'description' => ''], + ['errorCode' => 'GetObServer.Fail', 'errorMessage' => 'GetObServer.Fail', 'description' => ''], + ['errorCode' => 'CreateInstanceParameters.Error', 'errorMessage' => 'CreateInstanceParameters.Error', 'description' => ''], + ['errorCode' => 'CreateInstance.Fail', 'errorMessage' => 'CreateInstance.Fail', 'description' => ''], + ['errorCode' => 'InstanceClassSpecification.Invalid', 'errorMessage' => 'InstanceClassSpecification.Invalid', 'description' => ''], + ['errorCode' => 'InstanceOrder.NotAvailable', 'errorMessage' => 'InstanceOrder.NotAvailable', 'description' => ''], + ['errorCode' => 'InstanceNodeNum.Invalid', 'errorMessage' => 'InstanceNodeNum.Invalid', 'description' => ''], + ['errorCode' => 'InstanceLogSize.Invalid', 'errorMessage' => 'InstanceLogSize.Invalid', 'description' => ''], + ['errorCode' => 'Instance.ExpandLogDisk.NotSupport', 'errorMessage' => 'Instance.ExpandLogDisk.NotSupport', 'description' => ''], + ['errorCode' => 'InstanceStatus.Invalid', 'errorMessage' => 'InstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'InstanceDataSize.Invalid', 'errorMessage' => 'InstanceDataSize.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstance.StillOnline', 'errorMessage' => 'StandbyInstance.StillOnline', 'description' => ''], + ['errorCode' => 'InstanceServiceName.Missing', 'errorMessage' => 'InstanceServiceName.Missing', 'description' => ''], + ['errorCode' => 'PrimaryInstanceStatus.Invalid', 'errorMessage' => 'PrimaryInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstanceStatus.Invalid', 'errorMessage' => 'StandbyInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstance.NotSupport', 'errorMessage' => 'StandbyInstance.NotSupport', 'description' => ''], + ['errorCode' => 'StandbyInstance.Disconnect.NotAllowed', 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', 'description' => ''], + ['errorCode' => 'InstanceDiskSize.Invalid', 'errorMessage' => 'InstanceDiskSize.Invalid', 'description' => ''], + ['errorCode' => 'CreateInstance.Spec.NotSupport', 'errorMessage' => 'CreateInstance.Spec.NotSupport', 'description' => ''], + ['errorCode' => 'MissingParameterDiskSize', 'errorMessage' => 'MissingParameterDiskSize', 'description' => ''], + ['errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', 'description' => ''], + ['errorCode' => 'CreateInstance.DeployType.InvalidValue', 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', 'description' => ''], + ['errorCode' => 'ConfigError', 'errorMessage' => 'ConfigError', 'description' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Message' => [ - 'title' => '打标情况', - 'description' => 'The tag modification result.', - 'type' => 'string', - 'example' => 'done', - ], + 500 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ['errorCode' => 'UnknownError', 'errorMessage' => 'UnknownError', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"i-bp67acfmxazb4p****\\",\\n \\"OrderId\\": \\"1234567890\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Creation of Cluster', + 'changeSet' => [ + ['createdAt' => '2024-08-15T13:01:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-16T11:27:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-06T11:29:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-15T11:26:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-02T12:38:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-26T12:16:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-07T09:36:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-20T11:33:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-30T13:51:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-22T09:20:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-13T11:18:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-04T02:52:51.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-05-09T06:35:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-11T02:59:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-06T10:07:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-08T02:12:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-15T03:06:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T06:07:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-10T06:19:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-02-10T06:19:27.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"done\\"\\n}","type":"json"}]', - 'title' => 'ModifyTenantTags', ], - 'DescribeInstanceTags' => [ - 'summary' => 'You can call this operation to query the tags of clusters.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateLabel' => [ + 'summary' => 'This API creates a tag.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceIds', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id列表', - 'description' => 'The list of cluster IDs.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["ob3za5w73as8rk"]', - ], - ], - [ - 'name' => 'Tags', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '标签值', - 'description' => 'The tags.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', - ], + 'schema' => ['description' => 'The name of the label.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned response.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TagResources' => [ - 'title' => '标签列表', - 'description' => 'The list of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'The returned response.', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源id', - 'description' => 'The resource ID.', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource.', - 'type' => 'string', - 'example' => 'instance', - ], - 'Tag' => [ - 'title' => '资源标签', - 'description' => 'The tag of the resource.', - 'type' => 'string', - 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Key-value pairs for populating placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in `Message`.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context for populating placeholders in the `MessageMcmsKey` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in `MessageMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for populating placeholders in the `ReasonMcmsKey` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in `ReasonMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested action for resolving the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggested action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for populating placeholders in the `ProposalMcmsKey` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in `ProposalMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Error details from an upstream service involved in the HTTP request.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This parameter is deprecated. We recommend that you use the `Code` parameter in `ErrorDetail` instead.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This parameter is deprecated. We recommend that you use the `Message` parameter in `ErrorDetail` instead.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggested action. This parameter is deprecated. We recommend that you use the `Proposal` parameter in `ErrorDetail` instead.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The unique request ID. When you contact us, provide this ID for troubleshooting.', 'type' => 'string', 'example' => 'E3D924FB-52****B253-0C1A7EFB778C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Cost' => ['description' => 'The request time in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The ID of the created label.', 'type' => 'string', 'title' => '', 'example' => 'l_****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"ob317v4uif****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": \\"[{\\\\\\"Key\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"Value\\\\\\", \\\\\\"xxx\\\\\\"},{}]\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeInstanceTags', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"l_****\\"\\n}","type":"json"}]', + 'title' => 'Create Label', + 'changeSet' => [], + 'ramActions' => [], ], - 'CreateInstance' => [ - 'summary' => 'You can call this operation to create an OceanBase cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateMySqlDataSource' => [ + 'summary' => 'Use this API to create a MySQL data source.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ChargeType', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '实例的付费方式。取值范围： PrePay：包年包月。选择该类付费方式时，您必须确认自己的账号支持余额支付/信用支付，否则将返回 InvalidPayMethod的错误提示。 PostPay（默认）：按量付费。其默认按小时来计费', - 'description' => 'The billing method of the instance. Valid values: '."\n" - .'- PrePay: the subscription billing method. You must ensure that the remaining balance or credit balance of your account can cover the cost of the subscription. Otherwise, you will receive an InvalidPayMethod error. '."\n" - .'- PostPay: the pay-as-you-go billing method. This is the default value. By default, fees are charged on an hourly basis.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'PrePay' => 'PrePay', - 'PostPay' => 'PostPay', - ], - 'example' => 'PrePay', - 'enum' => [ - 'PrePay', - 'PostPay', - ], - ], + 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'example' => 'source_name'], ], [ - 'name' => 'Series', + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群(需要添加白名单开放)。', - 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" - .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" - .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" - .'- history: History Database Cluster Edition.', + 'description' => 'The type of the data source. Valid values include `INTERNET`, `VPC`, `RDS`, `PolarDB`, and `DG`.', + 'enumValueTitles' => ['RDS' => 'RDS', 'PolarDB' => 'PolarDB', 'DG' => 'DG', 'INTERNET' => 'INTERNET', 'VPC' => 'VPC'], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'Normal', - 'enum' => [ - 'normal', - 'normal_ssd', - 'history', - 'normal_kv', - 'normal_hg', - ], + 'enum' => ['INTERNET', 'VPC', 'RDS', 'DG', 'POLARDB'], + 'title' => '', + 'example' => 'VPC', ], ], [ - 'name' => 'Zones', + 'name' => 'VpcId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例所属的可用区ID。更多详情，请参见DescribeZones获取可用区列表。', - 'description' => 'The ID of the zone to which the instance belongs. '."\n" - .'For more information about how to obtain the list of zones, see [DescribeZones](~~25610~~). ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', - ], + 'schema' => ['description' => 'The unique ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1d2q3mhg9i23ofi****', 'title' => ''], ], [ - 'name' => 'InstanceClass', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '集群规格信息。
当前支持以下套餐：
- 4C16GB：4核 16GB
- 8C32GB：8核 32GB
- 14C70GB：14核 70GB
- 24C120GB：24核 120GB
- 30C180GB：30核 180GB
- 62C400GB：62核 400GB
- 104C600GB：104核 600GB
- 16C70GB：16核 70GB
- 32C160GB：32核 160GB
- 64C380GB：64核 380GB
- 20C32GB：20核 32GB
- 40C64GB：40核 64GB
- 16C32GB：16核 32GB
- 32C70GB：32核 70GB
- 64C180GB：64核 180GB
- 32C180GB：32核 180GB
- 64C400GB：64核 400GB。', - 'description' => 'The specifications of the cluster. '."\n" - .'You can specify one of the following four plans: '."\n" - .' - 8C32GB: indicates 8 CPU cores and 32 GB of memory. '."\n" - .' - 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" - .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory. '."\n" - .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - '64C380GB' => '64C380GB', - '64C400GB' => '64C400GB', - '32C70GB' => '32C70GB', - '14C70GB' => '14C70GB', - '16C32GB' => '16C32GB', - '4C16GB' => '4C16GB', - '32C160GB' => '32C160GB', - '8C32GB' => '8C32GB', - '16C70GB' => '16C70GB', - '24C120GB' => '24C120GB', - '32C180GB' => '32C180GB', - '30C180GB' => '30C180GB', - '40C64GB' => '40C64GB', - '62C400GB' => '62C400GB', - '20C32GB' => '20C32GB', - '104C600GB' => '104C600GB', - '64C180GB' => '64C180GB', - ], - 'example' => '14C70GB', - 'enum' => [ - '8C32GB', - '14C70GB', - '30C180GB', - '62C400GB', - '16C70GB', - '24C120GB', - '32C160GB', - '64C380GB', - '20C32GB', - '40C64GB', - '4C16GB', - '32C180GB', - '64C400GB', - '16C32GB', - '32C70GB', - '64C180GB', - '64C400GB', - '8C32G', - '14C70G', - '30C180G', - '62C400G', - '16C70G', - '24C120G', - '32C160G', - '64C380G', - '20C32G', - '40C64G', - '4C16G', - '32C180G', - '64C400G', - '16C32G', - '32C70G', - '64C180G', - '104C600G', - ], - ], + 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => false, 'example' => 'rm-t4****', 'title' => ''], ], [ - 'name' => 'DiskSize', + 'name' => 'DgInstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '存储空间大小，单位GB。 存储空间的限制根据集群规格不同而不同，具体如下： - 8C32GB：100GB~10000GB - 14C70GB：200GB~10000GB - 30C180GB：400GB~10000GB - 62C400G：800GB-10000GB。 各套餐的存储空间默认值为其最小值。', - 'description' => 'The size of the storage space,in GB. '."\n" - .'The limits on the storage space vary with the cluster specifications: '."\n" - .'- 8C32GB: 100 GB to 10000 GB '."\n" - .'- 14C70GB: 200 GB to 10000 GB '."\n" - .'- 30C180GB: 400 GB to 10000 GB '."\n" - .'- 62C400GB: 800 GB to 10000 GB '."\n" - .'The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans. ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '200', - ], + 'schema' => ['description' => 'The ID of the Database Gateway (DG) instance.', 'type' => 'string', 'required' => false, 'example' => 'dg-x****', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'Ip', 'in' => 'formData', - 'schema' => [ - 'title' => '购买资源的时长，单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。 取值范围： PeriodUnit=Month时，Period取值：{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”}。 PeriodUnit=Year时，Period取值：{“1”, “2”, “3”}。', - 'description' => 'The valid duration of the purchased resources. The unit is specified by the PeriodUnit parameter. '."\n" - .'This parameter is valid and required only when the InstanceChargeType parameter is set to PrePaid. '."\n" - .'Valid values: '."\n" - .'- When the PeriodUnit parameter is set to Month: "1", "2", "3", "4", "5", "6", "7", "8", "9". '."\n" - .'- When the PeriodUnit parameter is set to Year: "1", "2", "3".', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The IP address of the database host.', 'type' => 'string', 'required' => false, 'example' => 'xxx.xxx.xxx.1', 'title' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'Port', 'in' => 'formData', - 'schema' => [ - 'title' => '购买资源的时长。'."\n" - .'包年包月取值范围：Month 或者 Year。'."\n" - .'默认值：包年包月为 Month，按量计费，默认周期为 Hour。', - 'description' => 'The unit of the valid duration of the purchased resources. '."\n" - .'Valid value for subscription: Month or Year.'."\n" - .'Default value: Month for subscription, and Hour for pay-as-you-go.', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'schema' => ['description' => 'The port of the database host.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2883', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'Schema', 'in' => 'formData', - 'schema' => [ - 'title' => '是否要自动续费。当参数ChargeType取值PrePaid时生效。取值范围： true：自动续费。 false（默认）：不自动续费。', - 'description' => 'Specifies whether to enable automatic renewal. '."\n" - .'This parameter is valid only when the ChargeType parameter is set to PrePaid. Valid values: '."\n" - .'- true: enables automatic renewal for the instance. '."\n" - .'- false: disables automatic renewal for the instance. This is the default value. ', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the database. Specifying this parameter restricts data migration or data synchronization to this database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'AutoRenewPeriod', + 'name' => 'UserName', 'in' => 'formData', - 'schema' => [ - 'title' => '每次自动续费的时长，当参数 AutoRenew 取值 True 时，该参数为必填参数。'."\n" - .'PeriodUnit 为 Year 时，AutoRenewPeriod 取值范围为 {"1", "2", "3"}。'."\n" - .'PeriodUnit 为 Month 时，AutoRenewPeriod 取值范围为 {"1", "2", "3", "6", "12"}。', - 'description' => 'The automatic renewal period of the instance. This parameter is required when the AutoRenew parameter is set to true. Valid values: '."\n" - .'- If the PeriodUnit parameter is set to Year: "1", "2", and "3". '."\n" - .'- If the PeriodUnit parameter is set to Month: "1", "2", "3", "6", and "12".', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The username of the database user for data migration or data synchronization.', 'type' => 'string', 'required' => true, 'example' => 'user_name', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Password', 'in' => 'formData', - 'schema' => [ - 'title' => '实例所在的企业资源组ID', - 'description' => 'The ID of the resource group to which the instance belongs. ', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'schema' => ['description' => 'The Base64-encoded password for the database user.', 'type' => 'string', 'required' => true, 'example' => 'cGFzc193b3JK', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '集群名称, 最大长度为20字符。', - 'description' => 'The name of the OceanBase cluster. '."\n" - .'It must be 1 to 20 characters in length. '."\n" - .'If this parameter is not specified, the value is the instance ID of the cluster by default.', - 'type' => 'string', - 'required' => false, - 'example' => 'amap_aos_tx_ob', - 'maxLength' => 64, - 'minLength' => 0, - ], + 'schema' => ['description' => 'A description for the data source, limited to 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ObVersion', + 'name' => 'UseSsl', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase Server的版本号。', - 'description' => 'OceanBase Server version number.', - 'type' => 'string', - 'required' => false, - 'example' => '2.2.77', - ], + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - [ - 'name' => 'DiskType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '集群的存储类型。仅在标准集群版（云盘）下生效。当前支持两种类型：- cloud_essd_pl1：云盘ESSD PL1; -- cloud_essd_pl1：云盘ESSD PL1; - cloud_essd_pl0：云盘ESSD PL0。默认值为cloud_essd_pl1。', - 'description' => 'The type of the storage disk where the cluster is deployed. This parameter takes effect only for Standard Cluster Edition (Cloud Disk).'."\n" - .'Valid values:'."\n" - .'- cloud_essd_pl1: ESSD PL1.'."\n" - .'- cloud_essd_pl0: ESSD PL0. Default value: cloud_essd_pl1.', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd_pl1', - 'default' => 'cloud_essd_pl1', - 'enum' => [ - 'cloud_essd_pl1', - 'cloud_essd_pl0', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'A map of values used to populate placeholders in `Message`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The localization key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The values for placeholders in the message retrieved via `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The localization key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The values for placeholders in the reason text retrieved via `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested action (new).', 'type' => 'string', 'example' => 'Contact the administrator.', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The localization key for the suggested action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The values for placeholders in the suggested action text retrieved via `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The suggested action (legacy).', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The ID of the created MySQL data source.', 'type' => 'string', 'title' => '', 'example' => 'e_edz****'], ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', + 'title' => 'Create a MySQL Data Source', + 'changeSet' => [ + ['createdAt' => '2024-06-26T06:30:06.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [], + ], + 'CreateOasOutlineTask' => [ + 'summary' => 'You can call this operation to initiate outline binding tasks.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'DryRun', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" - .'true：发送检查请求，不会创建实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" - .'false（默认）：发送正常请求，通过检查后直接创建实例。', - 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" - .'- true: Only a dry-run request is sent and the instance is not created. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" - .'- false: The actual request is sent and no dry run is performed. The instance is created if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'ReplicaMode', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '全功能型副本数。3: 表示3个全功能型副本; 2: 表示2个全功能型副本.', - 'description' => 'The number of full-featured replicas.'."\n" - .'- 3F: three full-featured replicas.'."\n" - .'- 2F1L: two full-featured replicas and one log replica.'."\n" - .'- 2F1A: two full-featured replicas and one arbitration service.'."\n" - .'- ApsaraDB for OceanBase earlier than V4.1 supports 3F and 2F1L.'."\n" - .'- ApsaraDB for OceanBase V4.1 or later supports 3F and 2F1A.'."\n" - .'- An ApsaraDB for OceanBase instance deployed across three zones supports only 3F.'."\n" - .'- An ApsaraDB for OceanBase instance deployed across two zones supports 2F1A or 2F1L, depending on the version.'."\n" - .'- An ApsaraDB for OceanBase instance deployed in a single zone supports 3F, 2F1A, or 2F1L, depending on the version.', - 'type' => 'string', - 'required' => false, - 'example' => '3F', - 'enum' => [ - '3', - '2', - ], - ], + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 'ob2mr3oae0****', 'title' => ''], ], [ - 'name' => 'IsolationOptimization', + 'name' => 'SqlText', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to enable the control group feature.'."\n" - .'Valid values:'."\n" - .'- true'."\n" - .'- false', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'enum' => [ - 'true', - 'false', - ], - ], + 'schema' => ['title' => '', 'description' => 'The SQL text.', 'type' => 'string', 'required' => true, 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC'], ], [ - 'name' => 'PrimaryInstance', + 'name' => 'DatabaseName', 'in' => 'formData', - 'schema' => [ - 'title' => '主实例id', - 'description' => 'Primary instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob3h8ytroxxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The name of the database. ', 'type' => 'string', 'required' => true, 'example' => 'test_data'], ], [ - 'name' => 'PrimaryRegion', + 'name' => 'TableName', 'in' => 'formData', - 'schema' => [ - 'title' => '主实例Region', - 'description' => 'Primary instance region.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'test_1'], ], [ - 'name' => 'CpuArch', + 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'title' => 'cpu架构', - 'type' => 'string', - 'example' => 'x86', - ], + 'schema' => ['title' => 'sqlId', 'description' => 'The ID of the SQL statement.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + [ + 'name' => 'IsConcurrentLimit', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => '- When the value is set to True, the throttling information in the database is queried based on the SQL ID. '."\n" + .'- When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the specified SQL statements are dynamic SQL statements.'."\n" + .'> This parameter specifies whether the values of the `SqlId` parameter are the IDs of dynamic SQL statements.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'UId', + 'in' => 'formData', + 'schema' => ['description' => 'The user identifier (UID) of the OceanBase database.', 'type' => 'string', 'required' => false, 'example' => '139*************', 'title' => ''], + ], + [ + 'name' => 'PlanData', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The execution plan.', 'type' => 'string', 'required' => false, 'example' => '********'], + ], + [ + 'name' => 'IndexName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the index.'."\n", 'type' => 'string', 'required' => false, 'example' => 'idx_a'], + ], + [ + 'name' => 'MaxConcurrent', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The maximum number of outline binding tasks that can be initiated at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The start time of querying the TOPSQL parameter. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-05-13T15:40:43Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The end time of querying the SQL execution plan. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-05-13T16:40:43Z'], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the SQL template.', 'type' => 'string', 'required' => false, 'example' => '********'], + ], + [ + 'name' => 'BySqlId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to bind by SQLID/SQLText. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The request ID. ', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID', - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'i-bp67acfmxazb4p****', - ], - 'OrderId' => [ - 'title' => '订单ID。该参数只有创建包年包月ECS实例（请求参数InstanceChargeType=PrePaid）时有返回值。', - 'description' => 'Order ID. The ID of the order that you have placed.'."\n" - .'This parameter returns a value after you create a pre-paid or post-paid cluster.', - 'type' => 'string', - 'example' => '1234567890', - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-***************', - ], - 'DryRunResult' => [ - 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', - 'description' => 'The result of the dry-run request.'."\n" - ."\n" - .'If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" - .'If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - [ - 'errorCode' => 'InstanceName.ModifyFailed', - 'errorMessage' => 'InstanceName.ModifyFailed', - ], - [ - 'errorCode' => 'InstanceClass.InvalidValue', - 'errorMessage' => 'InstanceClass.InvalidValue', - ], - [ - 'errorCode' => 'InstanceType.Unsupport', - 'errorMessage' => 'InstanceType.Unsupport', - ], - [ - 'errorCode' => 'ZoneList.Unsupport', - 'errorMessage' => 'ZoneList.Unsupport', - ], - [ - 'errorCode' => 'InstanceId.Invalid', - 'errorMessage' => 'InstanceId.Invalid', - ], - [ - 'errorCode' => 'InstanceId.Missing', - 'errorMessage' => 'InstanceId.Missing', - ], - [ - 'errorCode' => 'Instance.Name.Missing', - 'errorMessage' => 'Instance.Name.Missing', - ], - [ - 'errorCode' => 'ListCluster.Fail', - 'errorMessage' => 'ListCluster.Fail', - ], - [ - 'errorCode' => 'GetCluster.Fail', - 'errorMessage' => 'GetCluster.Fail', - ], - [ - 'errorCode' => 'ListClusterGroup.Fail', - 'errorMessage' => 'ListClusterGroup.Fail', - ], - [ - 'errorCode' => 'GetClusterGroup.Fail', - 'errorMessage' => 'GetClusterGroup.Fail', - ], - [ - 'errorCode' => 'ListInstance.Fail', - 'errorMessage' => 'ListInstance.Fail', - ], - [ - 'errorCode' => 'GetInstance.Fail', - 'errorMessage' => 'GetInstance.Fail', - ], - [ - 'errorCode' => 'ListTenant.Fail', - 'errorMessage' => 'ListTenant.Fail', - ], - [ - 'errorCode' => 'GetTenant.Fail', - 'errorMessage' => 'GetTenant.Fail', - ], - [ - 'errorCode' => 'Instance.ListAliyunInstance.Fail', - 'errorMessage' => 'Instance.ListAliyunInstance.Fail', - ], - [ - 'errorCode' => 'Instance.GetAliyunInstance.Fail', - 'errorMessage' => 'Instance.GetAliyunInstance.Fail', - ], - [ - 'errorCode' => 'ListZone.Fail', - 'errorMessage' => 'ListZone.Fail', - ], - [ - 'errorCode' => 'ListObServer.Fail', - 'errorMessage' => 'ListObServer.Fail', - ], - [ - 'errorCode' => 'GetObServer.Fail', - 'errorMessage' => 'GetObServer.Fail', - ], - [ - 'errorCode' => 'CreateInstanceParameters.Error', - 'errorMessage' => 'CreateInstanceParameters.Error', - ], - [ - 'errorCode' => 'CreateInstance.Fail', - 'errorMessage' => 'CreateInstance.Fail', - ], - [ - 'errorCode' => 'InstanceClassSpecification.Invalid', - 'errorMessage' => 'InstanceClassSpecification.Invalid', - ], - [ - 'errorCode' => 'InstanceOrder.NotAvailable', - 'errorMessage' => 'InstanceOrder.NotAvailable', - ], - [ - 'errorCode' => 'InstanceNodeNum.Invalid', - 'errorMessage' => 'InstanceNodeNum.Invalid', - ], - [ - 'errorCode' => 'InstanceLogSize.Invalid', - 'errorMessage' => 'InstanceLogSize.Invalid', - ], - [ - 'errorCode' => 'Instance.ExpandLogDisk.NotSupport', - 'errorMessage' => 'Instance.ExpandLogDisk.NotSupport', - ], - [ - 'errorCode' => 'InstanceStatus.Invalid', - 'errorMessage' => 'InstanceStatus.Invalid', - ], - [ - 'errorCode' => 'InstanceDataSize.Invalid', - 'errorMessage' => 'InstanceDataSize.Invalid', - ], - [ - 'errorCode' => 'StandbyInstance.StillOnline', - 'errorMessage' => 'StandbyInstance.StillOnline', - ], - [ - 'errorCode' => 'InstanceServiceName.Missing', - 'errorMessage' => 'InstanceServiceName.Missing', - ], - [ - 'errorCode' => 'PrimaryInstanceStatus.Invalid', - 'errorMessage' => 'PrimaryInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstanceStatus.Invalid', - 'errorMessage' => 'StandbyInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstance.NotSupport', - 'errorMessage' => 'StandbyInstance.NotSupport', - ], - [ - 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', - 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', - ], - [ - 'errorCode' => 'InstanceDiskSize.Invalid', - 'errorMessage' => 'InstanceDiskSize.Invalid', - ], - [ - 'errorCode' => 'CreateInstance.Spec.NotSupport', - 'errorMessage' => 'CreateInstance.Spec.NotSupport', - ], - [ - 'errorCode' => 'MissingParameterDiskSize', - 'errorMessage' => 'MissingParameterDiskSize', - ], - [ - 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', - 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', - ], - [ - 'errorCode' => 'CreateInstance.DeployType.InvalidValue', - 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', - ], - [ - 'errorCode' => 'ConfigError', - 'errorMessage' => 'ConfigError', - ], - ], - 500 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'UnknownError', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"i-bp67acfmxazb4p****\\",\\n \\"OrderId\\": \\"1234567890\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DryRunResult\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n i-bp67acfmxazb4p****\\n 1234567890\\n rg-***************\\n \\n","errorExample":""}]', - 'title' => 'CreateInstance', + 'title' => 'CreateOasOutlineTask', + 'description' => '任务绑定采用异步执行机制，您可通过 DescribeOutlineBinding 接口查询绑定结果。', + 'requestParamsDescription' => '* 发起限流：IsConcurrentLimit 和 MaxConcurrent 不能为空 '."\n" + .'* 绑定索引：TableName 和 IndexName 不能为空 '."\n" + .'* 绑定执行计划：PlanData 不能为空', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', ], - 'DescribeInstance' => [ - 'summary' => 'You can call this operation to query the detailed information of an OceanBase cluster. ', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateOceanBaseDataSource' => [ + 'summary' => 'This API creates an OceanBase data source.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'source_name'], + ], + [ + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'title' => 'OceanBase 集群 ID。', - 'description' => 'The ID of the OceanBase cluster. ', + 'description' => 'The type of the data source.', + 'enumValueTitles' => ['OB_MYSQL_VPC' => 'OB\\_MYSQL\\_VPC', 'OB_ORACLE_VPC' => 'OB\\_ORACLE\\_VPC', 'OB_ORACLE_TENANT' => 'OB\\_ORACLE\\_TENANT', 'OB_ORACLE' => 'OB\\_ORACLE', 'OB_MYSQL' => 'OB\\_MYSQL', 'OB_MYSQL_TENANT' => 'OB\\_MYSQL\\_TENANT'], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'title' => '', + 'example' => 'OB_MYSQL_VPC', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Tenant', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。
起始值：1， 默认值：1', - 'description' => 'The number of the page to return.'."\n" - .'- Pages start from page 1.'."\n" - .'- Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the OceanBase tenant.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tenant_name'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求 ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Instance' => [ - 'title' => 'OceanBase 集群信息。', - 'description' => 'The information of the OceanBase cluster. ', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'OceanBase 集群 ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'InstanceName' => [ - 'title' => 'OceanBase 集群名称。', - 'description' => 'The name of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob4test', - ], - 'InstanceClass' => [ - 'title' => '集群规格信息。
当前支持以下套餐：
- 4C16GB：4核 16GB
- 8C32GB：8核 32GB
- 14C70GB：14核 70GB
- 24C120GB：24核 120GB
- 30C180GB：30核 180GB
- 62C400GB：62核 400GB
- 104C600GB：104核 600GB
- 16C70GB：16核 70GB
- 32C160GB：32核 160GB
- 64C380GB：64核 380GB
- 20C32GB：20核 32GB
- 40C64GB：40核 64GB
- 16C32GB：16核 32GB
- 32C70GB：32核 70GB
- 64C180GB：64核 180GB
- 32C180GB：32核 180GB
- 64C400GB：64核 400GB。', - 'description' => 'The specifications of the cluster. You can specify one of the following four plans: '."\n" - .'- 8C32G: indicates 8 CPU cores and 32 GB of memory. '."\n" - .'- 14C70G: indicates 14 CPU cores and 70 GB of memory. '."\n" - .'- 30C180G: indicates 30 CPU cores and 180 GB of memory. '."\n" - .'- 62C400G: indicates 62 CPU cores and 400 GB of memory. ', - 'type' => 'string', - 'example' => '14C70G', - ], - 'Series' => [ - 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', - 'description' => 'The series of the instance. Valid values:'."\n" - ."\n" - .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" - ."\n" - .'- normal_ssd: Standard Cluster Edition (Local Disk)'."\n" - ."\n" - .'- history: History Database Cluster Edition', - 'type' => 'string', - 'example' => 'Normal', - ], - 'PayType' => [ - 'title' => 'OceanBase 集群的付费类型
- PREPAY：预付费
- POSTPAY：按量付费', - 'description' => 'The billing method of the OceanBase cluster. Valid values: '."\n" - .'- PREPAY: the subscription billing method. '."\n" - .'- POSTPAY: the pay-as-you-go billing method. ', - 'type' => 'string', - 'example' => 'PREPAY', - ], - 'CreateTime' => [ - 'title' => '集群的创建时间（UTC时间）。', - 'description' => 'The time in UTC when the cluster was created. ', - 'type' => 'string', - 'example' => '2021-10-19T07:13:41Z', - ], - 'ExpireTime' => [ - 'title' => '集群过期时间（UTC格式）。', - 'description' => 'The time in UTC when the cluster expires. ', - 'type' => 'string', - 'example' => '2021-10-17T16:00:00Z', - ], - 'Version' => [ - 'title' => 'OBServer 版本信息。', - 'description' => 'The version of OceanBase Database.', - 'type' => 'string', - 'example' => '2.2.77', - ], - 'DeployType' => [ - 'title' => '集群的部署类型。
- multiple：多机房
- single：单机房
- dual：双机房', - 'description' => 'The deployment type of the cluster. Valid values: '."\n" - .'- multiple: multi-IDC deployment '."\n" - .'- single: single-IDC deployment '."\n" - .'- dual: dual-IDC deployment ', - 'type' => 'string', - 'example' => 'multiple', - ], - 'DeployMode' => [ - 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', - 'description' => 'The data replica distribution mode of the cluster. Valid values: '."\n" - .'- n: indicates the single-IDC mode. '."\n" - .'- n-n: indicates the dual-IDC mode. '."\n" - .'- n-n-n: indicates the multi-IDC mode. '."\n" - ."\n" - .'>
The integer n represents the number of OBServer nodes in each IDC. ', - 'type' => 'string', - 'example' => '1-1-1', - ], - 'DiskType' => [ - 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', - 'description' => 'The type of the storage disk where the cluster is deployed. '."\n" - ."\n" - .'The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', - 'type' => 'string', - 'example' => 'cloud_essd_pl1', - ], - 'MaintainTime' => [ - 'title' => '集群的每天例行维护时间，UTC时间。', - 'description' => 'The period in UTC for the daily routine maintenance of the cluster.', - 'type' => 'string', - 'example' => '19:00Z-20:00Z', - ], - 'DataMergeTime' => [ - 'title' => '集群的数据合并时间。', - 'description' => 'The time when the major compaction of cluster data is performed. ', - 'type' => 'string', - 'example' => '02:00', - ], - 'AutoRenewal' => [ - 'title' => '是否开启自动续费。该参数只在预付费（PREPAY）集群有意义。', - 'description' => 'Indicates whether automatic renewal is enabled. '."\n" - ."\n" - .'This parameter is valid only for clusters whose billing methods are set to PREPAY. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsTrustEcs' => [ - 'title' => '是否使用可信ecs', - 'description' => 'Indicates whether trusted ECS instances are used. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'title' => '集群状态。
- PENDING_CREATE: 创建中
- ONLINE: 运行中
- TENANT_CREATING：租户创建中
- TENANT_SPEC_MODIFYING：租户规格修改中
- EXPANDING: 节点扩容中
- REDUCING: 节点缩容中
- SPEC_UPGRADING:套餐规格扩容中
- DISK_UPGRADING:存储规格扩容中
- WHITE_LIST_MODIFYING: 修改白名单中
- PARAMETER_MODIFYING: 修改参数中
- SSL_MODIFYING: SSL变更中
- PREPAID_EXPIRE_CLOSED: 预付费集群欠费中
- ARREARS_CLOSED: 后付费集群欠费中
- PENDING_DELETE: 删除中。 集群一般为运行中的状态（ONLINE）。', - 'description' => 'The status of the cluster. Valid values: '."\n" - .' - PENDING_CREATE: The cluster is being created. '."\n" - .' - ONLINE: The cluster is running. '."\n" - .' - TENANT_CREATING: The tenant is being created. '."\n" - .'- TENANT_SPEC_MODIFYING: The tenant specifications are being modified. '."\n" - .'- EXPANDING: Nodes are being added to the cluster to increase its capacity. '."\n" - .'- REDUCING: Nodes are being removed from the cluster to reduce its capacity. '."\n" - .'- SPEC_UPGRADING: The service plan is being upgraded. '."\n" - .'- DISK_UPGRADING: The storage space is being expanded. '."\n" - .'- WHITE_LIST_MODIFYING: The whitelist is being modified. '."\n" - .'- PARAMETER_MODIFYING: Parameters are being modified. '."\n" - .'- SSL_MODIFYING: The SSL certificate is being changed. '."\n" - .'- PREPAID_EXPIRE_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to PREPAY. '."\n" - .'- ARREARS_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to POSTPAY. '."\n" - .'- PENDING_DELETE: The cluster is being deleted. '."\n" - .'Generally, the cluster is in the ONLINE state. ', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'Resource' => [ - 'title' => '集群的资源信息', - 'description' => 'The information about cluster resources. ', + [ + 'name' => 'Cluster', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the cluster where the OceanBase tenant resides.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cluster_name'], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => ['title' => 'vpc ID', 'description' => 'The unique ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => ['title' => 'IP', 'description' => 'The IP address of the database host.', 'type' => 'string', 'required' => false, 'example' => 'xxx.xxx.xxx.1'], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => ['description' => 'The port number of the database host.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2883'], + ], + [ + 'name' => 'LogProxyIp', + 'in' => 'formData', + 'schema' => ['title' => 'LogProxy IP', 'description' => 'The IP address of LogProxy.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'LogProxyPort', + 'in' => 'formData', + 'schema' => ['description' => 'The port of LogProxy.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['description' => 'The database user name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user_name'], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['description' => 'The Base64-encoded password for the database user.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cGFzc193b3JK'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the data source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'ConfigUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The URL for retrieving the address of the underlying OceanBase server.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://xxx.xxx.xxx.2:2883/services?Action=ObRootServiceInfo&User_ID=alibaba&UID=ocpmaster&ObRegion=ob_1***29.admin'], + ], + [ + 'name' => 'DrcUserName', + 'in' => 'formData', + 'schema' => ['description' => 'The user name for reading incremental logs and the database object schema from OceanBase. Create this user in the `sys` tenant of your business cluster.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'user_na***'], + ], + [ + 'name' => 'DrcPassword', + 'in' => 'formData', + 'schema' => ['description' => 'The Base64-encoded password for the user in the `sys` tenant.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pas***'], + ], + [ + 'name' => 'InnerDrcPassword', + 'in' => 'formData', + 'schema' => ['description' => 'The Base64-encoded password for the \\_\\_oceanbase\\_inner\\_drc\\_user account.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'in***'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error detail.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Contains key-value pairs that populate placeholders in the `Message` parameter.', 'type' => 'object', - 'properties' => [ - 'Cpu' => [ - 'title' => '集群的CPU资源信息', - 'description' => 'The information about the CPU resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalCpu' => [ - 'title' => '集群总CPU，单位：核数', - 'description' => 'The total number of CPU cores of the cluster. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'UsedCpu' => [ - 'title' => '集群已使用的CPU，单位：核数', - 'description' => 'The number of CPU cores used in the cluster. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'UnitCpu' => [ - 'title' => '集群中每个副本节点的CPU，单位：核数', - 'description' => 'The number of CPU cores of each replica node in the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OriginalTotalCpu' => [ - 'title' => '原始CPU', - 'description' => 'The number of original CPU cores in the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - ], - ], - 'Memory' => [ - 'title' => '集群的内存资源信息', - 'description' => 'The information about the memory resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalMemory' => [ - 'title' => '集群总内存，单位：GB', - 'description' => 'The total memory size of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'UsedMemory' => [ - 'title' => '集群已使用的内存，单位：GB', - 'description' => 'The size of used memory in the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'UnitMemory' => [ - 'title' => '集群中每个副本的内存，单位：GB', - 'description' => 'The memory size of each replica node in the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OriginalTotalMemory' => [ - 'title' => '原始内存', - 'description' => 'The original memory size of the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - ], - ], - 'DiskSize' => [ - 'title' => '集群的存储资源信息', - 'description' => 'The information about the storage resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'title' => '集群总存储空间，单位：GB', - 'description' => 'The total storage space of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'UsedDiskSize' => [ - 'title' => '集群已使用的存储空间，单位：GB', - 'description' => 'The size of used storage space of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'UnitDiskSize' => [ - 'title' => '集群每个副本的存储空间，单位：GB', - 'description' => 'The storage space of each replica node in the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'DataUsedSize' => [ - 'description' => 'The size of the data disk, in GB. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '200', - ], - 'MaxDiskUsedPercent' => [ - 'description' => 'The maximum disk usage, in percentage. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.14', - ], - 'MaxDiskUsedObServer' => [ - 'description' => 'The maximum disk usage of the OBServer node.', - 'type' => 'array', - 'items' => [ - 'description' => 'The maximum disk usage of the OBServer node.', - 'type' => 'string', - 'example' => 'i-bp1fhj23fs32dfbg4****', - ], - ], - 'OriginalTotalDiskSize' => [ - 'title' => '原始磁盘', - 'description' => 'The original size of the disk.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'MaxDiskSize' => [ - 'title' => '最大可创建磁盘大小', - 'description' => 'The maximum disk size that can be created.', - 'type' => 'number', - 'format' => 'double', - 'example' => '80000', - ], - ], - ], - 'UnitCount' => [ - 'title' => '集群的资源Unit数量。', - 'description' => 'The number of resource units in the cluster. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LogDiskSize' => [ - 'title' => '集群的日志盘资源信息', - 'description' => 'The information about the log disk space of the cluster.', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'title' => '集群总日志盘空间，单位GB。', - 'description' => 'The total log disk space of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '400', - ], - 'UnitDiskSize' => [ - 'title' => '集群每个副本的日志存储空间，单位：GB', - 'description' => 'The log disk space of each replica node in the cluster. Unit: GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'LogAssignedSize' => [ - 'description' => 'The allocated disk space for log storage, in GB.', - 'type' => 'string', - 'example' => '0.0', - ], - 'MaxLogAssignedObServer' => [ - 'description' => 'The maximum storage space allocated for.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of the OBServer nodes that are allocated the maximum log storage space.', - 'type' => 'string', - 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', - ], - ], - 'MaxLogAssignedPercent' => [ - 'description' => 'The maximum percentage of space allocated for log storage.', - 'type' => 'string', - 'example' => '6.68', - ], - 'OriginalTotalDiskSize' => [ - 'title' => '日志盘原始大小', - 'description' => 'The original size of the disk.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], - ], - 'CapacityUnit' => [ - 'description' => 'The information about capacity units.', - 'type' => 'object', - 'properties' => [ - 'MaxCapacityUnit' => [ - 'description' => 'The maximum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MinCapacityUnit' => [ - 'description' => 'The minimum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsedCapacityUnit' => [ - 'description' => 'The number of used capacity units.', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], - ], - 'AutoUpgradeObVersion' => [ - 'title' => '是否开启自动升级 OBServer 版本。', - 'description' => 'Indicates whether automatic upgrade of the OBServer version is enabled. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ObRpmVersion' => [ - 'title' => 'OBServer 详细版本信息。', - 'description' => 'The detailed information of the OBServer version. ', - 'type' => 'string', - 'example' => '2.2.77-20210526202046', - ], - 'IsLatestObVersion' => [ - 'title' => 'OBServer版本是否为最新版本。', - 'description' => 'Indicates whether the OBServer version is the latest. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AvailableZones' => [ - 'title' => '可用区列表。', - 'description' => 'The list of zones. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of zones. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - ], - 'EnableUpgradeLogDisk' => [ - 'title' => '是否允许升级日志盘规格。', - 'description' => 'Indicates whether the log disk specifications can be upgraded. ', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Zones' => [ - 'description' => 'The ID of the zone to which the instance belongs.'."\n" - .'For more information about how to obtain the list of zones, see [DescribeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describezones).', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the zone to which the instance belongs.'."\n" - .'For more information about how to obtain the list of zones, see [DescribeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describezones).', - 'type' => 'string', - 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', - ], - ], - 'InstanceRole' => [ - 'title' => '实例角色', - 'description' => 'The role of the instance.', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'NodeNum' => [ - 'description' => 'The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.', - 'type' => 'integer', - 'example' => '6', - 'format' => 'int64', - ], - 'ReplicaMode' => [ - 'description' => 'The number of full-featured replicas. Return value: 3 or 2.'."\n" - .'- 3: three full-featured replicas.'."\n" - .'- 2: two full-featured replicas.'."\n" - ."\n" - .'An OceanBase cluster deployed in three-zone mode supports only three full-featured replicas. An OceanBase cluster deployed in two-zone mode supports only two full-featured replicas. An OceanBase cluster deployed in one single zone supports two or three full-featured replicas.', - 'type' => 'string', - 'example' => '2F1A', - ], - 'IsolationOptimization' => [ - 'title' => '是否开启Cgroup', - 'description' => 'Specifies whether to enable the control group feature.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EnableIsolationOptimization' => [ - 'title' => '是否允许开通隔离优化', - 'description' => 'Specifies whether to enable isolation optimization.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'InTempCapacityStatus' => [ - 'description' => 'Specifies whether to indicate the temporary status of the capacity.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DataDiskAutoScale' => [ - 'title' => '是否开启数据自动协调', - 'description' => 'Specifies whether to enable automatic scaling of the data disk.'."\n" - .'>
This parameter is deprecated.', - 'type' => 'boolean', - 'example' => '-', + 'additionalProperties' => ['description' => 'A key-value pair for a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'TenantCreatable' => [ - 'description' => 'Specifies whether a tenant can be created.', + 'MessageMcmsKey' => ['description' => 'The localization key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Populates placeholders in the message template identified by `MessageMcmsKey`.', 'type' => 'object', - 'properties' => [ - 'EnableCreateTenant' => [ - 'title' => '集群是否允许创建租户', - 'description' => 'Specifies whether a tenant can be created.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DisableCreateTenantReason' => [ - 'title' => '集群不允许创建租户的原因', - 'description' => 'The reason why you cannot create a tenant in the cluster.', - 'type' => 'string', - 'example' => 'CPU_NOT_ENOUGH, MEMORY_NOT_ENOUGH, TENANT_COUNT_EXCEEDS_LIMIT', - ], - ], + 'additionalProperties' => ['description' => 'A key-value pair for a placeholder in the localized message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DataDiskAutoScaleConfig' => [ - 'title' => '数据盘自动协调配置', - 'description' => 'Specifies parameters for the automatic scaling of the data disk.', + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The localization key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Populates placeholders in the reason template identified by `ReasonMcmsKey`.', 'type' => 'object', - 'properties' => [ - 'AutoScale' => [ - 'title' => '是否开启', - 'description' => 'Specifies whether to enable the automatic scaling of the data disk.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Upperbound' => [ - 'title' => '扩容上限', - 'description' => 'The maximum space, in GB, to which the data disk can be scaled.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'UpperThreshold' => [ - 'title' => '日常扩容阈值', - 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'UpperMergeThreshold' => [ - 'title' => '合并扩容阈值', - 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - ], - 'MaxDiskSize' => [ - 'title' => '磁盘最大值', - 'description' => 'The maximum size of the disk, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80000', - ], - 'ScaleStepInNormal' => [ - 'title' => '日常扩容步长', - 'description' => 'The size of scaling step during daily use.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'ScaleStepInMerge' => [ - 'title' => '合并扩容步长', - 'description' => 'The size of scaling step during a major compaction.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'UpperScaleStrategy' => [ - 'title' => '扩容策略（RAW/PERCENTAGE）', - 'description' => 'The scale-out strategy. Valid values: RAW and PERCENTAGE.', - 'type' => 'string', - 'example' => 'RAW', - ], - 'UpperScaleStep' => [ - 'title' => '扩容步长', - 'description' => 'The step size of the scale-out.', - 'type' => 'string', - 'example' => '5', - ], - ], - ], - 'EnableProxyService' => [ - 'description' => 'Specifies whether to enable the proxy service.'."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProxyServiceStatus' => [ - 'title' => '代理服务状态', - 'description' => 'The status of the proxy service.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'ProxyClusterId' => [ - 'title' => '代理集群 ID', - 'description' => 'The ID of the proxy cluster.'."\n" - .'> This parameter returns a value only if you set the **EnableProxyService** parameter to true.', - 'type' => 'string', - 'required' => false, - 'example' => 'proxy-56****a6tg2o', - ], - 'CpuArchitecture' => [ - 'title' => '集群的 CPU 架构', - 'description' => 'The CPU architecture of the cluster.', - 'type' => 'string', - 'example' => 'X86', - 'enum' => [ - 'X86', - 'ARM', - ], + 'additionalProperties' => ['description' => 'A key-value pair for a placeholder in the localized reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ReadOnlyResource' => [ - 'title' => '集群的资源信息', - 'description' => 'The information about cluster resources.', + 'Proposal' => ['description' => 'The new suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The localization key for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Populates placeholders in the suggestion template identified by `ProposalMcmsKey`.', 'type' => 'object', - 'properties' => [ - 'Cpu' => [ - 'title' => '集群的CPU资源信息', - 'description' => 'The information about the CPU resources of the cluster.', - 'type' => 'object', - 'properties' => [ - 'TotalCpu' => [ - 'title' => '集群总CPU，单位：核数', - 'description' => 'The total number of CPU cores of the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'UsedCpu' => [ - 'title' => '集群已使用的CPU，单位：核数', - 'description' => 'The number of CPU cores used by the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'UnitCpu' => [ - 'title' => '集群中每个副本节点的CPU，单位：核数', - 'description' => 'The number of CPU cores of each replica node in the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OriginalTotalCpu' => [ - 'title' => '原始CPU', - 'description' => 'The number of original CPU cores in the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - ], - ], - 'Memory' => [ - 'title' => '集群的内存资源信息', - 'description' => 'The information about the memory resources of the cluster.', - 'type' => 'object', - 'properties' => [ - 'TotalMemory' => [ - 'title' => '集群总内存，单位：GB', - 'description' => 'The total memory size of the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'UsedMemory' => [ - 'title' => '集群已使用的内存，单位：GB', - 'description' => 'The size of memory used by the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'UnitMemory' => [ - 'title' => '集群中每个副本的内存，单位：GB', - 'description' => 'The memory size of each replica node in the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OriginalTotalMemory' => [ - 'title' => '原始内存', - 'description' => 'The original memory size of the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - ], - ], - 'DiskSize' => [ - 'title' => '集群的存储资源信息', - 'description' => 'The information about the storage resources of the cluster.', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'title' => '集群总存储空间，单位：GB', - 'description' => 'The total storage space of the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'UsedDiskSize' => [ - 'title' => '集群已使用的存储空间，单位：GB', - 'description' => 'The size of used storage space of the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'UnitDiskSize' => [ - 'title' => '集群每个副本的存储空间，单位：GB', - 'description' => 'The storage space of each replica node in the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'DataUsedSize' => [ - 'description' => 'The size of the data disk, in GB.', - 'type' => 'number', - 'format' => 'double', - 'example' => '200', - ], - 'MaxDiskUsedPercent' => [ - 'description' => 'The maximum disk usage, in percentage.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.14', - ], - 'MaxDiskUsedObServer' => [ - 'description' => 'The maximum disk usage of the OBServer node.', - 'type' => 'array', - 'items' => [ - 'description' => 'The maximum disk usage of the OBServer node.', - 'type' => 'string', - 'example' => 'i-bp1fhj23fs32dfbg4****', - ], - ], - 'OriginalTotalDiskSize' => [ - 'title' => '原始磁盘', - 'description' => 'The original size of the disk.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'MaxDiskSize' => [ - 'title' => '最大可创建磁盘大小', - 'description' => 'The maximum disk size that can be created.', - 'type' => 'number', - 'format' => 'double', - 'example' => '80000', - ], - ], - ], - 'UnitCount' => [ - 'title' => '集群的资源Unit数量。', - 'description' => 'The number of resource units in the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LogDiskSize' => [ - 'title' => '集群的日志盘资源信息', - 'description' => 'The information about the log disk space of the cluster.', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'title' => '集群总日志盘空间，单位GB。', - 'description' => 'The information about the log disk space of the cluster.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '400', - ], - 'UnitDiskSize' => [ - 'title' => '集群每个副本的日志存储空间，单位：GB', - 'description' => 'The log disk space of each replica node in the cluster, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'LogAssignedSize' => [ - 'description' => 'The allocated disk space for log storage, in GB.', - 'type' => 'string', - 'example' => '0.0', - ], - 'MaxLogAssignedObServer' => [ - 'description' => 'The maximum storage space allocated for.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of the OBServer nodes that are allocated the maximum log storage space.', - 'type' => 'string', - 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', - ], - ], - 'MaxLogAssignedPercent' => [ - 'description' => 'The maximum percentage of space allocated for log storage.', - 'type' => 'string', - 'example' => '6.68', - ], - ], - ], - 'CapacityUnit' => [ - 'description' => 'The information about capacity units.', - 'type' => 'object', - 'properties' => [ - 'MaxCapacityUnit' => [ - 'description' => 'The maximum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MinCapacityUnit' => [ - 'description' => 'The minimum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsedCapacityUnit' => [ - 'description' => 'The number of used capacity units.', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], - ], - 'UnitSpec' => [ - 'title' => '代理服务的单元规格', - 'description' => 'The unit specification of the proxy service.', - 'type' => 'string', - 'example' => '2C4G', - ], - 'SharedUnitNumLimit' => [ - 'title' => '共享模式代理服务的单元数量上限', - 'description' => 'The maximum number of units of the proxy service in shared mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ExclusiveUnitNumLimit' => [ - 'title' => '独占模式代理服务的单元数量上限', - 'description' => 'The maximum number of units of the proxy service in exclusive mode.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EnableReadOnlyReplica' => [ - 'description' => 'Indicates whether read-only replicas are supported.', - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'EnableReadOnlyReplicaManagement' => [ - 'description' => 'Indicates whether read-only replicas can be purchased for the cluster.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PrimaryInstance' => [ - 'title' => "\n" - .'主实例Id', - 'description' => 'The ID of the primary cluster.', - 'type' => 'string', - 'example' => 'ob3h8ytroxxxxx', - ], - 'PrimaryRegion' => [ - 'title' => '主实例Region', - 'description' => 'The region of the primary cluster.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SpecType' => [ - 'title' => '规格类型', - 'description' => 'The specification type.', - 'type' => 'string', - 'example' => 'dedicatedspec', - ], - 'AllowModifyInternetAddressConnectionLimit' => [ - 'title' => '是否允许修改公网最大连接数', - 'description' => 'Indicates whether the maximum number of public connections can be modified.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AllowCreateProxySqlFirewallRule' => [ - 'title' => '是否允许使用 ODP SQL 防火墙', - 'description' => 'Indicates whether the OceanBase Database Proxy (ODP) SQL firewall is supported.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Iops' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'InstanceType' => [ - 'title' => '实例类型', - 'type' => 'string', - ], - 'MigrationInfo' => [ - 'title' => '切换到云市场信息', - 'type' => 'object', - 'properties' => [ - 'Migratable' => [ - 'title' => '是否可切换', - 'type' => 'boolean', - ], - 'CheckResult' => [ - 'title' => '如果不支持切换，此处有详细原因', - 'type' => 'object', - 'properties' => [ - 'Level' => [ - 'title' => '结果等级', - 'type' => 'string', - ], - 'Code' => [ - 'title' => '检查项代码', - 'type' => 'string', - ], - 'CodeName' => [ - 'title' => '检查项文案', - 'type' => 'string', - ], - 'Module' => [ - 'title' => '模块名', - 'type' => 'string', - ], - 'ModuleName' => [ - 'title' => '模块名文案', - 'type' => 'string', - ], - 'SubModule' => [ - 'title' => '子模块名', - 'type' => 'string', - ], - 'SubModuleName' => [ - 'title' => '子模块文案', - 'type' => 'string', - ], - ], - ], - ], + 'additionalProperties' => ['description' => 'A key-value pair for a placeholder in the localized suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Details of an error from an upstream service involved in processing the HTTP request.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'null'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The suggestion (legacy).', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The current page number. This parameter applies to paginated results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter applies to paginated results.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query. This parameter applies to paginated results.', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'Cost' => ['description' => 'The request duration in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The ID of the OceanBase data source.', 'type' => 'string', 'title' => '', 'example' => 'e_edz****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"Series\\": \\"Normal\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DataMergeTime\\": \\"02:00\\",\\n \\"AutoRenewal\\": true,\\n \\"IsTrustEcs\\": true,\\n \\"Status\\": \\"ONLINE\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\",\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"AutoUpgradeObVersion\\": true,\\n \\"ObRpmVersion\\": \\"2.2.77-20210526202046\\",\\n \\"IsLatestObVersion\\": true,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"EnableUpgradeLogDisk\\": false,\\n \\"Zones\\": [\\n \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\"\\n ],\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"NodeNum\\": 6,\\n \\"ReplicaMode\\": \\"2\\",\\n \\"IsolationOptimization\\": false,\\n \\"EnableIsolationOptimization\\": false,\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScale\\": true,\\n \\"TenantCreatable\\": {\\n \\"EnableCreateTenant\\": true,\\n \\"DisableCreateTenantReason\\": \\"CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT\\"\\n },\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\",\\n \\"UpperScaleStep\\": \\"5\\"\\n },\\n \\"EnableProxyService\\": true,\\n \\"ProxyServiceStatus\\": \\"ONLINE\\",\\n \\"ProxyClusterId\\": \\"proxy-56****a6tg2o\\",\\n \\"CpuArchitecture\\": \\"X86\\",\\n \\"ReadOnlyResource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\"\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"UnitSpec\\": \\"2C4G\\",\\n \\"SharedUnitNumLimit\\": 3,\\n \\"ExclusiveUnitNumLimit\\": 1,\\n \\"EnableReadOnlyReplica\\": true,\\n \\"EnableReadOnlyReplicaManagement\\": false,\\n \\"PrimaryInstance\\": \\"ob3h8ytroxxxxx\\",\\n \\"PrimaryRegion\\": \\"cn-hangzhou\\",\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"AllowModifyInternetAddressConnectionLimit\\": false,\\n \\"AllowCreateProxySqlFirewallRule\\": false,\\n \\"Iops\\": 10000,\\n \\"InstanceType\\": \\"\\",\\n \\"MigrationInfo\\": {\\n \\"Migratable\\": true,\\n \\"CheckResult\\": {\\n \\"Level\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"CodeName\\": \\"\\",\\n \\"Module\\": \\"\\",\\n \\"ModuleName\\": \\"\\",\\n \\"SubModule\\": \\"\\",\\n \\"SubModuleName\\": \\"\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n ob317v4uif****\\n ob4test\\n 14C70G\\n NORMAL\\n PREPAY\\n 2021-10-19T07:13:41Z\\n 2021-10-17T16:00:00Z\\n 2.2.77\\n multiple\\n 1-1-1\\n cloud_essd_pl1\\n 19:00Z-20:00Z\\n 02:00\\n true\\n ONLINE\\n \\n \\n 14\\n 10\\n 10\\n \\n \\n 70\\n 10\\n 10\\n \\n \\n 200\\n 100\\n 200\\n \\n 1\\n \\n true\\n 2.2.77-20210526202046\\n true\\n cn-hangzhou-i\\n \\n","errorExample":""}]', - 'title' => 'DescribeInstance', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"null\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', + 'title' => 'Create an OceanBase data source', + 'changeSet' => [], + 'ramActions' => [], ], - 'DescribeInstances' => [ - 'summary' => 'You can call this operation to obtain the list of OceanBase clusters. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateOmsMysqlDataSource' => [ + 'summary' => 'You can call this operation to create a MySQL data source. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'formData', 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', + 'title' => 'The name of the data source. It must be 2 to 128 characters in length. It can contain letters, digits, underscores (_), periods (.), and hyphens (-). Invalid characters, such as slashes (/), are not allowed.', + 'description' => 'The name of the data source. '."\n" + .'It must be 2 to 128 characters in length and can contain letters, digits, underscores (_), periods (.), and hyphens (-). '."\n" + ."\n" + .'>
Invalid characters, such as slashes (/), are not allowed.', 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ob317v4uif****', + 'required' => true, + 'docRequired' => true, + 'example' => 'oms-mysql', + 'enum' => [], ], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'title' => '资源组ID信息。如果不填写，返回全部资源。', - 'description' => 'The ID of the resource group. If you do not specify this parameter, all resources are returned.', + 'title' => 'All MySQL data types include:'."\n" + .'INTERNET, VPC, RDS, POLARDB, and DG.', + 'description' => 'The type of the MySQL data source. '."\n" + .'Valid values: INTERNET, VPC, RDS, PolarDB, and DG.', 'type' => 'string', - 'required' => false, - 'example' => 'group1', + 'required' => true, + 'docRequired' => true, + 'example' => 'INTERNET', + 'enum' => [], ], ], [ - 'name' => 'PageSize', + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the VPC to which the data source belongs. If Type is set to VPC, this parameter is required. ', 'description' => 'The ID of the VPC to which the data source belongs. '."\n" + ."\n" + .'>
If Type is set to VPC, this parameter is required. ', 'type' => 'string', 'required' => false, 'example' => 'vpc-12345abcde*******'], + ], + [ + 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows to return on each page.'."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', + 'title' => 'The ID of the ECS instance of the data source. If Type is set to RDS, POLARDB, or DG, this parameter is required. ', + 'description' => 'The ID of the ECS instance of the data source. '."\n" + ."\n" + .'>
If Type is set to RDS, PolarDB, or DG, this parameter is required.', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'pc-12ab34cd56******', + 'enum' => [], ], ], [ - 'name' => 'PageNumber', + 'name' => 'DgDatabaseId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the database gateway instance. If Type is set to DG, this parameter is required. ', 'description' => 'The ID of the database gateway instance. '."\n" + ."\n" + .'>
If Type is set to DG, this parameter is required. ', 'type' => 'string', 'required' => false, 'example' => 'dg-yhss6sdlaff****'], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => ['title' => 'The IP address of the data source. If Type is set to INTERNET or VPC, this parameter is required. ', 'description' => 'The IP address of the data source. '."\n" + ."\n" + .'>
If Type is set to INTERNET or VPC, this parameter is required. ', 'type' => 'string', 'required' => false, 'example' => '10.0.****'], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => ['title' => 'The port number of the data source. If Type is set to INTERNET or VPC, this parameter is required. ', 'description' => 'The port number of the data source. '."\n" + ."\n" + .'>
If Type is set to INTERNET or VPC, this parameter is required. ', 'type' => 'string', 'required' => false, 'example' => '3306'], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database. If you specify this parameter, subsequent migration or synchronization operations will take effect on this database only.', 'description' => 'The name of the database. '."\n" + ."\n" + .'>
If you specify this parameter, subsequent migration or synchronization operations will take effect on this database only. ', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => ['title' => 'The username that is used to access the database. ', 'description' => 'The username that is used to access the database. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'omsTestUser'], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['title' => 'The plaintext password of the username that is used to access the database. It must be Base64 encoded. ', 'description' => 'The password of the username that is used to access the database. It must be Base64 encoded. '."\n" + .'For example, for the password abcd123@!, the Base64-encoded value is YWJjZDEyM0Ah. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'YWJjZDEyM0Ah'], + ], + [ + 'name' => 'Description', 'in' => 'formData', + 'schema' => ['title' => 'The description of the data source. It must be 2 to 256 characters in length. The default value is null. ', 'description' => 'The description of the data source. '."\n" + ."\n" + .'It must be 2 to 256 characters in length. The default value is null.', 'type' => 'string', 'required' => false, 'example' => 'OMS 测试 MySQL 数据源'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page to return.'."\n" - .'- Pages start from page 1.'."\n" - .'- Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Data' => [ + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => ['description' => 'The ID of the data source record. ', 'type' => 'string', 'example' => 'e_1234abcd*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": {\\n \\"EndpointId\\": \\"e_1234abcd*****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n e_1234abcd*****\\n \\n","errorExample":""}]', + 'title' => ' ', + 'description' => 'To call this operation, you must add the IP address of the OceanBase Migration Service (OMS) server to the whitelist of the Alibaba Cloud database instance, the security rules of the ECS instance, or the security settings of your self-managed database (usually the firewall of your self-managed database) to ensure that OMS can successfully access your database instance. To obtain the IP address of the OMS server, go to the OMS data source management page in the OMS console.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateOmsMysqlDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateProject' => [ + 'summary' => 'This API is used to create a data migration or data synchronization task. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceName', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'UseOss', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Indicates whether to use OSS for Creation.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'OssKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The OssKey obtained by calling GetUploadOssUrl.', 'type' => 'string', 'required' => false, 'example' => 'open_api_create_project/oacp_xxx'], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization task. You can obtain the ID of the task to be configured by invoking the ListProjects API.', 'title' => 'Project ID', 'type' => 'string', 'required' => true, 'example' => 'np_fe****'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', - 'description' => 'The name of the OceanBase cluster. It must be 1 to 20 characters in length. If this parameter is not specified, the value is the instance ID of the cluster by default.', + 'title' => '', + 'description' => 'The type of the job, which can be `MIGRATION` (indicating a data migration task) or `SYNC` (indicating a data synchronization task).', 'type' => 'string', - 'required' => false, - 'example' => 'ob4prod', + 'required' => true, + 'example' => 'MIGRATION', + 'enum' => ['MIGRATION', 'SYNC'], ], ], [ - 'name' => 'SearchKey', + 'name' => 'LabelIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '查询列表的删选关键字。', - 'description' => 'The keyword for fuzzy search, which can be an instance ID, instance name, tenant ID, or tenant name.', - 'type' => 'string', + 'title' => '', + 'description' => 'A collection of label IDs. Up to 5 labels are supported.', + 'type' => 'array', + 'items' => ['description' => 'Label ID.', 'type' => 'string', 'required' => false, 'example' => 'I_dfe****', 'title' => ''], 'required' => false, - 'example' => 'pay', + 'example' => 'MIGRATION', ], ], [ - 'name' => 'WithOBCloudInstances', + 'name' => 'WorkerGradeId', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID of the transmission instance. You must invoke the ListProjects API to obtain the ID of the task to be configured.', 'type' => 'string', 'required' => true, 'example' => 'g_abcdefj***'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'SourceEndpointId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the source data source. You can obtain the ID by invoking the `ListDataSource` API. The format is e_****.', 'type' => 'string', 'required' => true, 'example' => 'e_4j0c12z****'], + ], + [ + 'name' => 'SinkEndpointId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The DataSource ID of the target endpoint. You can obtain the ID by invoking the `ListDataSource` API. The format is e_****.', 'type' => 'string', 'required' => true, 'example' => 'e_4j0cz****'], + ], + [ + 'name' => 'TransferMapping', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request. ', + 'title' => '', + 'description' => 'Mapping information of transfer objects.', 'type' => 'object', 'properties' => [ - 'Instances' => [ - 'title' => 'Oceanbase集群列表。', - 'description' => 'The information of the OceanBase cluster. ', + 'Mode' => [ + 'title' => '', + 'description' => 'The transfer object mapping mode, which includes `SPECIFIC` (indicating specific objects) and `WILDCARD` (indicating pattern matching).', + 'type' => 'string', + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => ['SPECIFIC', 'WILDCARD'], + ], + 'Databases' => [ + 'title' => '', + 'description' => 'Database information.', 'type' => 'array', 'items' => [ - 'description' => 'The information of the OceanBase cluster. ', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'vpcId', - 'description' => 'vpcId', - 'type' => 'string', - 'example' => 'vpc-8vb8qjrixzovjpy******', - ], - 'CommodityCode' => [ - 'title' => 'Oceanbase集群的产品码。 - oceanbase_oceanbasepre_public_cn：国内站云数据库包年包月套餐。 - oceanbase_oceanbasepost_public_cn：国内站云数据库按小时付费套餐。 - oceanbase_obpre_public_intl：国际站云数据库包年包月套餐。', - 'description' => 'The product code of the OceanBase cluster. '."\n" - .'- oceanbase_oceanbasepre_public_cn: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in a China site. '."\n" - .'- oceanbase_oceanbasepost_public_cn: indicates an OceanBase cluster that is billed based on the pay-as-you-go plan and that is deployed in a China site. '."\n" - .'- oceanbase_obpre_public_intl: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in an international site. ', - 'type' => 'string', - 'example' => 'oceanbase_oceanbasepost_public_cn', - ], - 'ExpireTime' => [ - 'title' => '集群过期时间（UTC格式）。', - 'description' => 'The time in UTC when the cluster expires. '."\n" - .'> This parameter is valid only for subscription instances.', - 'type' => 'string', - 'example' => '2021-10-17T16:00:00Z', - ], - 'State' => [ - 'title' => '集群状态。 - PENDING_CREATE: 创建中 - ONLINE: 运行中 - TENANT_CREATING：租户创建中 - TENANT_SPEC_MODIFYING：租户规格修改中 - EXPANDING: 节点扩容中 - REDUCING: 节点缩容中 - SPEC_UPGRADING:套餐规格扩容中 - DISK_UPGRADING:存储规格扩容中 - WHITE_LIST_MODIFYING: 修改白名单中 - PARAMETER_MODIFYING: 修改参数中 - SSL_MODIFYING: SSL变更中 - PREPAID_EXPIRE_CLOSED: 预付费集群欠费中 - ARREARS_CLOSED: 后付费集群欠费中 - PENDING_DELETE: 删除中。 集群一般为运行中的状态（ONLINE）。', - 'description' => 'The status of the cluster. Valid values: '."\n" - .'- ONLINE: The cluster is running. '."\n" - .'- PENDING_CREATE: The cluster is being created. '."\n" - .'- ARREARS_CLOSED("arrears_closed"): The cluster is suspended due to insufficient balance.'."\n" - .'- PREPAID_EXPIRE_CLOSED("prepaid_expire_closed"): The cluster is suspended because the subscription has expired.'."\n" - .'- WHITE_LIST_MODIFYING("white_list_modifying"): The allowlist of the cluster is being modified.'."\n" - .'- SSL_MODIFYING("ssl_modifying"): The Secure Sockets Layer (SSL) settings of the cluster are being modified.'."\n" - .'- PARAMETER_MODIFYING("parameter_modifying"): Parameters of the cluster are being modified.'."\n" - .'- TENANT_CREATING("tenant_creating"): A tenant is being created in the cluster.'."\n" - .'- TENANT_SPEC_MODIFYING("tenant_spec_modifying"): The specifications of a tenant in the cluster are being modified.'."\n" - .'- EXPANDING("expanding"): Nodes are being added to the cluster.'."\n" - .'- REDUCING("reducing"): Nodes are being removed from the cluster.'."\n" - .'- ZONE_CHANGING("zone_changing"): Zones of the cluster are being modified.'."\n" - .'- SPEC_UPGRADING: The service plan is being upgraded.'."\n" - .'- SPEC_DOWNGRADING("spec_downgrading"): The plan specification is being downgraded.'."\n" - .'- DISK_UPGRADING: The storage space is being expanded.'."\n" - .'- UPGRADING("upgrading"): The version of the cluster is being upgraded.'."\n" - .'- PENDING_DELETE("pending_delete"): The cluster is being deleted.'."\n" - .'- DELETED("deleted"): The cluster has been deleted.'."\n" - .'- ABNORMAL("abnormal"): The cluster is abnormal.'."\n" - .'- OFFLINE("offline"): The cluster is offline.'."\n" - .'- STANDBY_CREATING("standby_creating"): A standby cluster is being created for the cluster.'."\n" - .'- STANDBY_DELETING("standby_deleting"): A standby cluster of the cluster is being deleted.'."\n" - .'- SWITCHOVER_SWITCHING("switchover_switching"): The cluster is undergoing a primary/standby switchover.'."\n" - .'- STANDBY_DISCONNECTING("standby_disconnecting"): The cluster is being decoupled from its standby cluster.'."\n" - .'- LOG_DISK_UPGRADING("log_disk_upgrading"): The log disk of the cluster is being scaled out.'."\n" - .'- ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying"): The isolation optimization settings of the cluster are being modified.'."\n" - .'- DISKTYPE_MODIFYING("disktype_modifying"): The data disk type of the cluster is being modified.'."\n" - .'- PROXY_SERVICE_CREATING("proxy_service_creating"): The proxy service is being enabled for the cluster.'."\n" - .'- PROXY_SERVICE_DELETING("proxy_service_deleting"): The proxy service is being disabled for the cluster.'."\n" - .'- PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying"): The proxy service specification is being modified for the cluster.'."\n" - .'- READONLY_ADD_NODE("readonly_add_node"): A read-only node is being added to the cluster.'."\n" - .'- READONLY_REDUCE_NODE("readonly_reduce_node"): A read-only node is being removed from the cluster.'."\n" - .'- READONLY_REDUCE_ZONE("readonly_reduce_zone"): A read-only zone is being removed from the cluster.'."\n" - .'- READONLY_ADD_ZONE("readonly_add_zone"): A read-only zone is being added to the cluster.'."\n" - .'- READONLY_UPGRADE_SPEC("readonly_upgrade_spec"): The specification of read-only replicas is being upgraded.'."\n" - .'- READONLY_UPGRADE_DISK("readonly_upgrade_disk"): The disk space of read-only replicas is being scaled out.'."\n" - .'- READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec"): The specification of read-only replicas is being downgraded.'."\n" - .'- READONLY_DOWNGRADE_DISK("readonly_downgrade_disk"): The disk space of read-only replicas is being scaled in.'."\n" - .'- CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica"): A read-only replica is being created for a tenant in the cluster.'."\n" - .'- DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica"): A read-only replica is being deleted for a tenant in the cluster.'."\n" - .'- DISK_DOWNGRADING("disk_downgrading"): The disk space of the cluster is being scaled in.'."\n" - .'- DEPLOY_MODE_MODIFYING("deploy_mode_modifying"): The deployment mode of the cluster is being modified.'."\n" - .'> Generally, the cluster is in the ONLINE state.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'InstanceClass' => [ - 'title' => '集群规格信息。
当前支持以下套餐：
- 4C16GB：4核 16GB
- 8C32G：8核 32GB
- 14C70G：14核 70GB
- 16C32G：16核 32GB
- 16C70G：16核 70GB
- 20C32G：20核 32GB
- 24C120G：24核 120GB
- 30C180G：30核 180GB
- 32C70G：32核 70GB
- 32C160G：32核 160GB
- 32C180G：32核 180GB
- 40C64G：40核 64GB
- 62C400G：62核 400GB
- 64C180G：64核 180GB
- 64C380G：64核 380GB
- 64C400G：64核 400GB 。', - 'description' => 'The specifications of the cluster. You can specify one of the following four plans: '."\n" - .'- 8C32G: indicates 8 CPU cores and 32 GB of memory. '."\n" - .'- 14C70G: indicates 14 CPU cores and 70 GB of memory. '."\n" - .'- 30C180G: indicates 30 CPU cores and 180 GB of memory. '."\n" - .'- 62C400G: indicates 62 CPU cores and 400 GB of memory. ', - 'type' => 'string', - 'example' => '14C70G', - ], - 'CreateTime' => [ - 'title' => '集群的创建时间，UTC时间。', - 'description' => 'The time in UTC when the cluster was created. ', - 'type' => 'string', - 'example' => '2021-10-19T07:13:41Z', - ], - 'DeployMode' => [ - 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', - 'description' => 'The data replica distribution mode of the cluster. The value is in the n-n-n format, where n is the number of OBServer nodes in each IDC.', - 'type' => 'string', - 'example' => '1-1-1', - ], - 'CpuArchitecture' => [ - 'title' => '集群的 CPU 架构', - 'description' => 'The CPU architecture of the cluster.', - 'type' => 'string', - 'example' => 'X86_64, AARCH64', - ], - 'MaintainTime' => [ - 'title' => '集群的每天例行维护时间，UTC时间。', - 'description' => 'The time period in UTC for the daily routine maintenance of the cluster. ', - 'type' => 'string', - 'example' => '2021-10-19T07:13:41Z', - ], - 'DeployType' => [ - 'title' => '集群的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房', - 'description' => 'The deployment type of the cluster. Valid values: '."\n" - .'- multiple: multi-IDC deployment '."\n" - .'- single: single-IDC deployment '."\n" - .'- dual: dual-IDC deployment ', - 'type' => 'string', - 'example' => 'multiple', - ], - 'PayType' => [ - 'title' => 'Oceanbase集群的付费类型 - PREPAY：预付费 - POSTPAY：按量付费', - 'description' => 'The billing method for the OceanBase cluster. Valid values: '."\n" - .'- PREPAY: the subscription billing method. '."\n" - .'- POSTPAY: the pay-as-you-go billing method. ', - 'type' => 'string', - 'example' => 'PREPAY', - ], - 'DiskSize' => [ - 'description' => 'The size of the storage space, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - 'title' => 'The size of the storage space, in GB. ', - ], - 'DiskType' => [ - 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', - 'description' => 'The type of the storage disk where the cluster is deployed. '."\n" - .'The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', - 'type' => 'string', - 'example' => 'cloud_essd_pl1', - ], - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'ExpireSeconds' => [ - 'title' => '集群已过期时间，单位：秒(s)。', - 'description' => 'The time elapsed since the expiration of the cluster, in seconds. '."\n" - .'> In subscription mode, if the cluster has not expired, this parameter indicates the remaining validity period of the cluster. If the cluster has expired, this parameter indicates the time elapsed since the expiration.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2606682', - ], - 'Mem' => [ - 'title' => '实例的内存大小，单位GB。', - 'description' => 'The memory size of the instance, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'EnableUpgradeNodes' => [ - 'title' => '是否允许新增节点。', - 'description' => 'Indicates whether new nodes can be added. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Cpu' => [ - 'title' => '集群的CPU核数。', - 'description' => 'The number of CPU cores of the cluster. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - ], - 'AvailableZones' => [ - 'title' => '集群部署所在的可用区信息。', - 'description' => 'The information about the zone in which the cluster is deployed. ', + 'Id' => ['title' => '', 'description' => 'The ID of the database.', 'type' => 'string', 'required' => false, 'example' => 'gez3***'], + 'Name' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'db_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the database.', 'type' => 'string', 'required' => false, 'example' => 'mapped_db'], + 'ClusterName' => ['title' => '', 'description' => 'The cluster where the Mapping Object resides. This parameter takes effect only when the source data source is OceanBase. '."\n" + .'>This parameter is deprecated.> ', 'type' => 'string', 'required' => false, 'example' => 'cluster_name'], + 'TenantName' => ['title' => '', 'description' => 'The tenant where the mapping object resides. This parameter takes effect only when the source is an OceanBase data source. >This parameter is deprecated.>', 'type' => 'string', 'required' => false, 'example' => 'tenant_name'], + 'Tables' => [ + 'title' => '', + 'description' => 'The configuration of table objects to be transferred in the current database. When `Mode` is `WILDCARD`, this parameter specifies the exact blacklist or whitelist configuration, which is shared by tables and views. ', 'type' => 'array', 'items' => [ - 'description' => 'The information about the zone in which the cluster is deployed. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - ], - 'Version' => [ - 'title' => 'Observer版本信息。', - 'description' => 'The OBServer version. ', - 'type' => 'string', - 'example' => '2.2.77', - ], - 'InstanceName' => [ - 'title' => 'Oceanbase集群名称。', - 'description' => 'The name of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob4test', - ], - 'Series' => [ - 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', - 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" - .'- NORMAL: the high availability edition. '."\n" - .'- BASIC: the basic edition. ', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'UsedDiskSize' => [ - 'title' => '已使用的存储空间，单位GB。', - 'description' => 'The size of used storage space of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID信息。', - 'description' => 'The ID of the resource group. ', - 'type' => 'string', - 'example' => 'group1', - ], - 'Resource' => [ - 'title' => '集群的资源信息', - 'description' => 'The information about cluster resources. ', - 'type' => 'object', - 'properties' => [ - 'Cpu' => [ - 'title' => '集群的CPU资源信息', - 'description' => 'The information about the CPU resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalCpu' => [ - 'description' => 'The total number of CPU cores of the cluster. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '14', - 'title' => 'The total number of CPU cores of the cluster.', - ], - 'UsedCpu' => [ - 'description' => 'The number of CPU cores used in the cluster. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - 'title' => 'The number of CPU cores used in the cluster.', - ], - 'UnitCpu' => [ - 'description' => 'The number of CPU cores of each replica node in the cluster. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - 'title' => 'The number of CPU cores of each replica node in the cluster.', - ], - 'OriginalTotalCpu' => [ - 'description' => 'The number of original CPU cores in the cluster.', - 'type' => 'number', - 'format' => 'double', - 'example' => '14', - 'title' => '原始CPU', - ], + 'description' => 'Table information in the database. ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the table.', 'type' => 'string', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['title' => '', 'description' => 'The ID of the table.', 'type' => 'string', 'required' => false, 'example' => 'e_4l085bu7***'], + 'WhereClause' => ['title' => '', 'description' => 'The `WHERE` clause in a standard SQL statement, used to configure row filtering. ', 'type' => 'string', 'required' => false, 'example' => 'id > 1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filtered columns.', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', ], - ], - 'Memory' => [ - 'title' => '集群的内存资源信息', - 'description' => 'The information about the memory resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalMemory' => [ - 'description' => 'The total memory size of the cluster, in GB. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '70', - 'title' => 'The total memory size of the cluster, in GB.', - ], - 'UsedMemory' => [ - 'title' => '集群已使用的内存，单位：GB', - 'description' => 'The size of used memory in the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'UnitMemory' => [ - 'title' => '集群中每个副本的内存，单位：GB', - 'description' => 'The memory size of each replica node in the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OriginalTotalMemory' => [ - 'description' => 'The original memory size of the cluster, in GB.', - 'type' => 'number', - 'format' => 'double', - 'example' => '72', - 'title' => '原始内存', - ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'Collection of sharding columns. ', + 'type' => 'array', + 'items' => ['description' => 'Sharding key column. ', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', ], - ], - 'DiskSize' => [ - 'title' => '集群的存储资源信息', - 'description' => 'The information about the storage resources of the cluster. ', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'description' => 'The total storage space of the cluster, in GB. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '200', - 'title' => 'The total storage space of the cluster, in GB.', - ], - 'UsedDiskSize' => [ - 'title' => '集群已使用的存储空间，单位：GB', - 'description' => 'The size of used storage space of the cluster, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'UnitDiskSize' => [ - 'description' => 'The storage space of each replica node in the cluster, in GB. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '200', - 'title' => 'The storage space of each replica node in the cluster, in GB.', + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'Mapping information for the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk_col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], - 'OriginalTotalDiskSize' => [ - 'description' => 'The original size of the disk.', - 'type' => 'number', - 'format' => 'double', - 'example' => '200', - 'title' => '原始磁盘', + 'required' => false, + 'example' => '', + ], + 'ObkvPartitionConfig' => [ + 'description' => 'HBase pattern partition configuration, used only in migration to OBKV scenarios.', + 'title' => 'HBase pattern partition configuration, used only in migration to OBKV scenarios', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'description' => 'Partition type.', + 'type' => 'string', + 'enum' => ['KEY', 'RANGE', 'NONE'], + 'required' => false, + 'example' => 'RANGE', + 'title' => '', + ], + 'VirtualColumn' => ['description' => 'Virtual column. Currently, only virtual columns built using substring are supported.', 'type' => 'string', 'required' => false, 'example' => 'substring(K, 1, 4)', 'title' => ''], + 'PartitionSize' => ['description' => 'The partition size, with a value range of [1, 1024].', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1024', 'minimum' => '1', 'required' => false, 'example' => '3', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], - 'UnitCount' => [ - 'title' => '集群的资源Unit数量。', - 'description' => 'The number of resource units in the cluster. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CapacityUnit' => [ - 'description' => 'The information about capacity units.', - 'type' => 'object', - 'properties' => [ - 'MaxCapacityUnit' => [ - 'description' => 'The maximum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'MinCapacityUnit' => [ - 'description' => 'The minimum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsedCapacityUnit' => [ - 'description' => 'The number of used capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Views' => [ + 'title' => '', + 'description' => 'The configuration list of view objects to be transferred in the current database.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration list of view objects to be transferred in the current database.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the view.', 'type' => 'string', 'required' => false, 'example' => 'view_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the view.', 'type' => 'string', 'required' => false, 'example' => 'mapped_view'], + 'Id' => ['description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'e_4himpq4z***', 'title' => ''], + 'WhereClause' => ['title' => '', 'description' => 'The `WHERE` clause from a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'required' => false, 'example' => 'id>1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'Filter column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The collection of sharding columns.', + 'type' => 'array', + 'items' => ['description' => 'Sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'Primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk_col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'Distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'InstanceType' => [ - 'description' => 'The instance type.'."\n" - .'- cluster: indicates a cluster instance.'."\n" - .'- mtenant: indicates a tenant instance in MySQL mode.'."\n" - .'- mtenant_serverless: indicates a serverless instance in MySQL mode.', - 'type' => 'string', - 'example' => 'CLUSTER', - ], - 'InstanceRole' => [ - 'description' => 'The role of the instance.', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'InTempCapacityStatus' => [ - 'description' => 'Specifies whether to indicate the temporary status of the capacity.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DataDiskAutoScaleConfig' => [ - 'title' => '数据盘自动协调配置', - 'description' => 'Specifies parameters for the automatic scaling of the data disk.', - 'type' => 'object', - 'properties' => [ - 'AutoScale' => [ - 'title' => '是否开启', - 'description' => 'Specifies whether to enable the automatic scaling of the data disk.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Upperbound' => [ - 'description' => 'The maximum space, in GB, to which the data disk can be scaled.', - 'type' => 'number', - 'format' => 'double', - 'example' => '16', - 'title' => '扩容上限', - ], - 'UpperThreshold' => [ - 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.', - 'type' => 'number', - 'format' => 'double', - 'example' => '80', - 'title' => '日常扩容阈值', - ], - 'UpperMergeThreshold' => [ - 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '90', - 'title' => '合并扩容阈值', - ], - 'MaxDiskSize' => [ - 'title' => '磁盘最大值', - 'description' => 'The maximum size of the disk, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80000', - ], - 'ScaleStepInNormal' => [ - 'description' => 'The size of scaling step during daily use.', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - 'title' => '日常扩容步长'."\n", - ], - 'ScaleStepInMerge' => [ - 'description' => 'The size of scaling step during a major compaction.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - 'title' => '合并扩容步长', - ], - 'UpperScaleStrategy' => [ - 'title' => '扩容策略（RAW/PERCENTAGE）', - 'description' => 'The scale-out strategy. Valid values: RAW and PERCENTAGE.', - 'type' => 'string', - 'example' => 'RAW', + 'SpecificTables' => [ + 'title' => '', + 'description' => 'A collection of configurations for specific table objects. When `mode` is `WILDCARD`, this parameter specifies renaming and row filtering configurations for specific table objects. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the table.', 'type' => 'string', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['description' => 'The ID of the table. ', 'type' => 'string', 'required' => false, 'example' => 'e_4azdil4lu7***', 'title' => ''], + 'WhereClause' => ['title' => '', 'description' => 'Configures row filtering by using the `WHERE` clause from standard SQL statements. ', 'type' => 'string', 'required' => false, 'example' => 'id<5'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'Filter columns. ', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding columns. ', + 'type' => 'array', + 'items' => ['description' => 'Sharding key column. ', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'Mapping information of the ADB data source. ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'Collection of primary key columns. ', + 'type' => 'array', + 'items' => ['description' => 'Primary key column. ', 'type' => 'string', 'required' => false, 'example' => 'pk_col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'Collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'Distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'Partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'EnableReadOnlyReplicaManagement' => [ - 'description' => 'Indicates whether the cluster supports read-only replicas.', - 'type' => 'boolean', - 'example' => 'yes', - ], - 'SpecType' => [ - 'title' => '规格类型', - 'description' => 'The specification type.', - 'type' => 'string', - 'example' => 'dedicatedspec', - ], - 'ObRpmVersion' => [ - 'title' => '集群的RPM版本信息'."\n" - ."\n", - 'description' => 'The version of the OceanBase Database RedHat Package Managerment (RPM) package.', - 'type' => 'string', - 'example' => '4.2.1.7-107030032024062709', - ], - 'ReplicaMode' => [ - 'title' => '集群的副本模式', - 'type' => 'string', - 'example' => '3F、2F1A', - ], - 'Migratable' => [ - 'type' => 'boolean', - ], - 'MigrationInfo' => [ - 'title' => '切换到云市场信息', - 'type' => 'object', - 'properties' => [ - 'Migratable' => [ - 'title' => '是否可切换', - 'type' => 'boolean', - ], - 'CheckResult' => [ - 'title' => '如果不支持切换，此处有详细原因', - 'type' => 'object', - 'properties' => [ - 'Level' => [ - 'title' => '结果等级', - 'type' => 'string', - ], - 'Code' => [ - 'title' => '检查项代码', - 'type' => 'string', - ], - 'CodeName' => [ - 'title' => '检查项文案', - 'type' => 'string', - ], - 'Module' => [ - 'title' => '模块名', - 'type' => 'string', - ], - 'ModuleName' => [ - 'title' => '模块名文案', - 'type' => 'string', - ], - 'SubModule' => [ - 'title' => '子模块名', - 'type' => 'string', - ], - 'SubModuleName' => [ - 'title' => '子模块文案', - 'type' => 'string', + 'SpecificViews' => [ + 'title' => '', + 'description' => 'The configuration for specific view objects. When `mode` is `WILDCARD`, this parameter specifies the renaming configuration for specific view objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a specific view object. When mode is WILDCARD, this parameter specifies the renaming configuration for the specific view object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the view.', 'type' => 'string', 'required' => false, 'example' => 'view_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the view.', 'type' => 'string', 'required' => false, 'example' => 'mapped_view'], + 'Id' => ['description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'e_3wsmjv49a***', 'title' => ''], + 'WhereClause' => ['title' => '', 'description' => 'The `WHERE` clause from a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'required' => false, 'example' => 'id<5'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of shard columns.', + 'type' => 'array', + 'items' => ['description' => 'A shard key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk_col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'Iops' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'TotalCount' => [ - 'title' => '查询到的Oceanbase集群个数。', - 'description' => 'The number of OceanBase clusters queried. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Instances\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vb8qjrixzovjpy******\\",\\n \\"CommodityCode\\": \\"oceanbase_oceanbasepost_public_cn\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"State\\": \\"ONLINE\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CpuArchitecture\\": \\"X86_64、 AARCH64\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"DiskSize\\": 200,\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"ExpireSeconds\\": 2606682,\\n \\"Mem\\": 70,\\n \\"EnableUpgradeNodes\\": true,\\n \\"Cpu\\": 14,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"Version\\": \\"2.2.77\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"UsedDiskSize\\": 20,\\n \\"ResourceGroupId\\": \\"group1\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"UnitCount\\": 1,\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": 2\\n }\\n },\\n \\"InstanceType\\": \\"CLUSTER\\",\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\"\\n },\\n \\"EnableReadOnlyReplicaManagement\\": true,\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"ObRpmVersion\\": \\"4.2.1.7-107030032024062709\\",\\n \\"ReplicaMode\\": \\"3F、2F1A\\",\\n \\"Migratable\\": true,\\n \\"MigrationInfo\\": {\\n \\"Migratable\\": true,\\n \\"CheckResult\\": {\\n \\"Level\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"CodeName\\": \\"\\",\\n \\"Module\\": \\"\\",\\n \\"ModuleName\\": \\"\\",\\n \\"SubModule\\": \\"\\",\\n \\"SubModuleName\\": \\"\\"\\n }\\n },\\n \\"Iops\\": 10000\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n vpc-8vb8qjrixzovjpy******\\n oceanbase_oceanbasepost_public_cn\\n 2021-10-17T16:00:00Z\\n ONLINE\\n 14C70G\\n 2021-10-19T07:13:41Z\\n 1-1-1\\n 2021-10-19T07:13:41Z\\n multiple\\n PREPAY\\n 200\\n cloud_essd_pl1\\n ob317v4uif****\\n 2606682\\n 70\\n true\\n 14\\n cn-hangzhou-i\\n 2.2.77\\n ob4test\\n NORMAL\\n 20\\n -\\n group1\\n \\n \\n 14\\n 10\\n 10\\n \\n \\n 70\\n 10\\n 10\\n \\n \\n 200\\n 100\\n 200\\n \\n 1\\n \\n \\n 2\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeInstances', - ], - 'DescribeInstanceTopology' => [ - 'summary' => 'You can call this operation to query the topology of an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'InstanceTopology' => [ - 'title' => '集群的拓扑信息。', - 'description' => 'The topology of the cluster.', - 'type' => 'object', - 'properties' => [ - 'Tenants' => [ - 'title' => '租户信息。', - 'description' => 'The information about the tenants.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the tenants.', - 'type' => 'object', - 'properties' => [ - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'TenantName' => [ - 'title' => '租户名称。', - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'pay_online', - ], - 'TenantCpu' => [ - 'title' => '租户CPU，单位：核。', - 'description' => 'The number of CPU cores of the tenant.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'TenantMemory' => [ - 'title' => '租户内存大小，单位：GB。', - 'description' => 'The memory size of the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'TenantMode' => [ - 'title' => '租户模式。 - Oracle：Oracle模式 - MySQL：MySQL模式。', - 'description' => 'The mode of the tenant. Valid values: '."\n" - .'* Oracle '."\n" - .'* MySQL', - 'type' => 'string', - 'example' => 'Oracle', - ], - 'TenantZones' => [ - 'title' => '租户的可用区信息。', - 'description' => 'The information about the zones.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the zones.', + 'DatabasesBlack' => [ + 'title' => '', + 'description' => 'Pattern matching mode: a blacklist of database objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'Pattern matching mode: a blacklist of database objects.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the database.', 'type' => 'string', 'required' => false, 'example' => 'e_3y6v5v1x94f4', 'title' => ''], + 'Name' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'db_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the database.', 'type' => 'string', 'required' => false, 'example' => 'mapped_db'], + 'ClusterName' => ['title' => '', 'description' => 'The cluster where the mapping object resides. This parameter takes effect only when the source is an OceanBase data source. >This parameter is deprecated.>', 'type' => 'string', 'required' => false, 'example' => 'cluster_name'], + 'TenantName' => ['title' => '', 'description' => 'The tenant where the mapping object resides. This parameter takes effect only when the source is an OceanBase data source. >This parameter is deprecated.>', 'type' => 'string', 'required' => false, 'example' => 'tenant_name'], + 'Tables' => [ + 'title' => '', + 'description' => 'The configuration of table objects to be transferred in the current database. When `Mode` is `WILDCARD`, this parameter specifies the exact blacklist or whitelist configuration, which is shared by tables and views.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of table objects to be transferred in the current database.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the Table.', 'type' => 'string', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['title' => '', 'description' => 'Mapped name of the table.', 'type' => 'string', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['title' => '', 'description' => 'The ID of the table. ', 'type' => 'string', 'required' => false, 'example' => 'e_474hmh5iqo***'], + 'WhereClause' => ['title' => '', 'description' => 'The `WHERE` clause from a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A set of columns to filter. ', + 'type' => 'array', + 'items' => ['description' => 'A column to filter. ', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The collection of sharding columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'Mapping information for the ADB data source. ', 'type' => 'object', 'properties' => [ - 'TenantZoneRole' => [ - 'title' => '可用区的访问角色。 - ReadWrite：可读可写 - ReadOnly：只读。', - 'description' => 'The role to access the zone. Valid values: '."\n" - .'* ReadWrite: a role that has the read and write privileges. '."\n" - .'* ReadOnly: a role that has only the read-only privilege.', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'IsPrimaryTenantZone' => [ - 'description' => 'Indicates whether the zone is the primary zone.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TenantZoneId' => [ - 'title' => '可用区ID。', - 'description' => 'The ID of the zone.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Units' => [ - 'title' => '资源节点信息列表', - 'description' => 'The information about the resource units.', + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns. ', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the resource units.', - 'type' => 'object', - 'properties' => [ - 'UnitId' => [ - 'title' => '资源节点ID', - 'description' => 'The ID of the resource unit.', - 'type' => 'string', - 'example' => '1002', - ], - 'UnitStatus' => [ - 'title' => '资源节点的状态。 ONLINE: 运行中 IMMIGRATING 迁入中 EMIGRATING: 迁出中 CANCEL_EMIGRATING: 取消迁入中 CANCEL_EMIGRATING：取消迁出中 DELETING：删除中', - 'description' => 'The status of the resource unit. Valid values: '."\n" - .'* ONLINE: The resource unit is running. '."\n" - .'* IMMIGRATING: The resource unit is being immigrated. '."\n" - .'* EMIGRATING: The resource unit is being emigrated. '."\n" - .'* CANCEL_EMIGRATING: The immigration of the resource unit is being canceled. '."\n" - .'* CANCEL_EMIGRATING: The emigration of the resource unit is being canceled. '."\n" - .'* DELETING: The resource unit is being deleted.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'NodeId' => [ - 'title' => '资源节点所在的observer节点ID', - 'description' => 'The ID of the OBServer node in which the resource unit resides.', - 'type' => 'string', - 'example' => 'i-bp16niirq4zdmgvm****', - ], - 'UnitCpu' => [ - 'title' => '资源节点CPU，单位：核。', - 'description' => 'The number of CPU cores of the resource unit.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'UnitMemory' => [ - 'title' => '资源节点内存大小，单位：GB。', - 'description' => 'The memory size of the resource unit, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'EnableMigrateUnit' => [ - 'title' => '是否可做迁移。', - 'description' => 'Indicates whether the resource unit can be migrated.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ManualMigrate' => [ - 'title' => '是否为手动迁移。', - 'description' => 'Indicates whether the resource unit is manually migrated.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableCancelMigrateUnit' => [ - 'title' => '是否可以取消迁移。该字段只对正在手动迁入中或手动迁出中的unit有效。', - 'description' => 'Indicates whether the migration can be canceled. This parameter is valid only for resource units that are being manually immigrated or emigrated.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'UnitDataSize' => [ - 'title' => 'Unit使用的数据量大小。', - 'description' => 'The data size of the resource unit.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ReplicaType' => [ - 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" - .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" - .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried. '."\n" - .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', - 'type' => 'string', - 'example' => 'FULL', - ], - ], - ], - ], - 'LogicalZone' => [ - 'title' => '副本ID', - 'description' => 'The ID of the replica.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h-z0', - ], - 'ReplicaType' => [ - 'title' => '租户的副本类型', - 'description' => 'The replica type of the tenant.', - 'type' => 'string', - 'example' => 'FULL', + 'items' => ['description' => 'Primary key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'ReadOnlyReplicaType' => [ - 'description' => 'The type of the read-only replica.', - 'type' => 'string', - 'example' => 'ROW_STORE', + 'DistributedKeys' => [ + 'description' => 'Collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'Distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'Partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'Table lifecycle.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], - 'TenantStatus' => [ - 'title' => '租户状态。 - PENDING_CREATE: 创建中 - RESTORE: 恢复中 - ONLINE: 运行中 - SPEC_MODIFYING: 规格修改中 - ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 - PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 - PRIMARY_ZONE_MODIFYING: 切主可用区中 - PARAMETER_MODIFYING: 参数修改中 - WHITE_LIST_MODIFING: 白名单修改中', - 'description' => 'The status of the tenant. Valid values: '."\n" - .'* PENDING_CREATE: The tenant is being created. '."\n" - .'* RESTORE: The tenant is being restored. '."\n" - .'* ONLINE: The tenant is running. '."\n" - .'* SPEC_MODIFYING: The specification of the tenant is being modified. '."\n" - .'* ALLOCATING_INTERNET_ADDRESS: A public IP address is being allocated to the tenant. '."\n" - .'* PENDING_OFFLINE_INTERNET_ADDRESS: The public IP address is being disabled. '."\n" - .'* PRIMARY_ZONE_MODIFYING: The tenant is being switched to a new primary zone. '."\n" - .'* PARAMETER_MODIFYING: Parameters are being modified. '."\n" - .'* WHITE_LIST_MODIFYING: The allowlist is being modified.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'TenantDeployType' => [ - 'title' => '租户的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房。', - 'description' => 'The deployment type of the tenant. Valid values: '."\n" - .'* multiple: multi-IDC deployment. '."\n" - .'* single: single-IDC deployment. '."\n" - .'* dual: dual-IDC deployment.', - 'type' => 'string', - 'example' => 'multiple', - ], - 'TenantUnitNum' => [ - 'title' => '租户的unit个数。', - 'description' => 'The number of resource units in the tenant.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PrimaryZoneDeployType' => [ - 'title' => '主可用区部署模式', - 'description' => 'The deployment mode of the primary zone. Valid values: '."\n" - .'* RANDOM. '."\n" - .'* STATIC.', - 'type' => 'string', - 'enumValueTitles' => [ - 'RANDOM' => 'RANDOM', - 'STATIC' => 'STATIC', - ], - 'example' => 'RANDOM', - ], - 'TenantDiskSize' => [ - 'title' => '租户数据量', - 'description' => 'The disk space of the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'TenantUnitCpu' => [ - 'title' => '租户单节点CPU', - 'description' => 'The number of CPU cores of a single node in the tenant.', - 'type' => 'number', - 'format' => 'float', - 'example' => '4', - ], - 'TenantUnitMemory' => [ - 'title' => '租户单节点内存', - 'description' => 'The memory size of a single node in the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '16', - ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - ], - 'Zones' => [ - 'title' => '集群的可用区信息。', - 'description' => 'The information about the zones in which the cluster is deployed.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the zones in which the cluster is deployed.', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'title' => '可用区ID。', - 'description' => 'The ID of the zone.', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'Region' => [ - 'title' => '地域ID。', - 'description' => 'The ID of the region.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneDisk' => [ - 'title' => '可用区的存储容量。', - 'description' => 'The storage capacity of the zone.', - 'type' => 'string', - 'example' => '200 GB', - ], - 'Nodes' => [ - 'title' => '节点信息。', - 'description' => 'The information about the nodes.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the nodes.', + 'Views' => [ + 'title' => '', + 'description' => 'The configuration list for transferring view objects in the current database.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration list of view objects to be transferred in the current database.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the view.', 'type' => 'string', 'required' => false, 'example' => 'view_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the view.', 'type' => 'string', 'required' => false, 'example' => 'mapped_view'], + 'Id' => ['title' => '', 'description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'e_4azdil4lu7mo'], + 'WhereClause' => ['title' => '', 'description' => 'Configures row filtering by using the `WHERE` clause from standard SQL statements.', 'type' => 'string', 'required' => false, 'example' => 'id<5'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The collection of sharding columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information of the ADB data source.', 'type' => 'object', 'properties' => [ - 'NodeId' => [ - 'title' => '节点ID。', - 'description' => 'The ID of the node.', - 'type' => 'string', - 'example' => 'i-bp16niirq4zdmgvm****', - ], - 'NodeCopyId' => [ - 'title' => '节点归属的副本ID。', - 'description' => 'The ID of the replica node.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NodeStatus' => [ - 'title' => '节点运行状态。', - 'description' => 'The status of the node.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'NodeResource' => [ - 'title' => '节点资源列表信息', - 'description' => 'The information about node resources.', - 'type' => 'object', - 'properties' => [ - 'Cpu' => [ - 'title' => '节点CPU资源信息。', - 'description' => 'The information about the CPU resources of the node.', - 'type' => 'object', - 'properties' => [ - 'UsedCpu' => [ - 'title' => '节点已使用的CPU，单位：核。', - 'description' => 'The number of CPU cores used by the node.', - 'type' => 'number', - 'format' => 'float', - 'example' => '4', - ], - 'TotalCpu' => [ - 'title' => '节点总的CPU，单位：核。', - 'description' => 'The total number of CPU cores of the node.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - ], - ], - ], - 'Memory' => [ - 'title' => '节点内存资源信息。', - 'description' => 'The information about the memory resources of the node.', - 'type' => 'object', - 'properties' => [ - 'UsedMemory' => [ - 'title' => '节点已使用的内存，单位：GB。', - 'description' => 'The size of memory used by the node, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'TotalMemory' => [ - 'title' => '节点的总内存，单位：GB。', - 'description' => 'The total memory size of the node, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - ], - ], - 'DiskSize' => [ - 'title' => '节点存储资源信息。', - 'description' => 'The information about the storage resources of the node.', - 'type' => 'object', - 'properties' => [ - 'TotalDiskSize' => [ - 'title' => '节点总存储空间，单位：GB。', - 'description' => 'The total storage space of the node, in GB.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'UsedDiskSize' => [ - 'title' => '节点已使用的存储空间，单位：GB。', - 'description' => 'The size of storage space used by the node, in GB.', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - ], - ], - ], - ], - ], - 'ReplicaType' => [ - 'description' => 'The type of the replica. Valid values: '."\n" - .'* FULL. '."\n" - .'* READONLY.', - 'type' => 'string', - 'example' => 'FULL', - ], - 'FullCopyId' => [ - 'description' => 'The ID of the full-featured replica.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ReadOnlyCopyId' => [ - 'description' => 'The ID of the read-only replica.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LogicalZone' => [ - 'title' => '副本ID', - 'description' => 'The ID of the replica.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h-z0', + 'PrimaryKeys' => [ + 'description' => 'The collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk_col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'ReadOnlyReplicaType' => [ - 'description' => 'The type of the read-only replica.', - 'type' => 'string', - 'example' => 'ROW_STORE', + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], - 'ZoneResource' => [ - 'title' => 'zone资源信息', - 'description' => 'The information about zones.', - 'type' => 'object', - 'properties' => [ - 'DiskSize' => [ - 'title' => '存储资源信息', - 'description' => 'The information about the storage resources of the node.', - 'type' => 'object', - 'properties' => [ - 'MaxDiskUsedPercent' => [ - 'title' => '最大磁盘使用量百分比', - 'description' => 'The maximum disk usage, in percentage.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.14', - ], - 'MaxDiskUsedObServer' => [ - 'description' => 'The IDs of OBServer nodes that use the maximum disk space.', - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of OBServer nodes that use the maximum disk space.', - 'type' => 'string', - 'example' => 'i-bp1fhj23fs32dfbg4****', - ], - ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificTables' => [ + 'title' => '', + 'description' => 'A collection of configurations for specific table objects. When `mode` is set to `WILDCARD`, this parameter specifies renaming and row filtering configurations for specific table objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'table_name'], + 'Id' => ['title' => '', 'description' => 'The ID of the table.', 'type' => 'string', 'required' => false, 'example' => 'e_4himpq4zf***'], + 'MappedName' => ['title' => '', 'description' => 'The mapped name of the table.', 'type' => 'string', 'required' => false, 'example' => 'mapped_table'], + 'WhereClause' => ['title' => '', 'description' => 'The WHERE clause from a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - ], - 'Replicas' => [ - 'description' => 'The information about replicas.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogicalZone' => [ - 'title' => '副本ID', - 'description' => 'The ID of the replica.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h-z0', - ], - 'NodeNum' => [ - 'title' => '副本节点数', - 'description' => 'The number of nodes of the replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ZoneLogicalName' => [ - 'title' => '副本地域', - 'description' => 'The region of the replica.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ZoneRegionName' => [ - 'title' => '副本可用区', - 'description' => 'The zone of the replica.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ReplicaResource' => [ - 'description' => 'The information about the replica resources.', - 'type' => 'object', - 'properties' => [ - 'Memory' => [ - 'description' => 'The information about the memory resources of the replica.', - 'type' => 'object', - 'properties' => [ - 'UsedMemory' => [ - 'title' => '副本已使用内存', - 'description' => 'The size of memory used by the replica, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'TotalMemory' => [ - 'title' => '副本总内存', - 'description' => 'The total memory size of the replica, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - ], - ], - 'DiskSize' => [ - 'description' => 'The information about the data disk of the replica.', - 'type' => 'object', - 'properties' => [ - 'UsedDiskSize' => [ - 'title' => '副本已使用数据量', - 'description' => 'The disk space used by the replica, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'TotalDiskSize' => [ - 'title' => '副本总数据量', - 'description' => 'The total disk space of the replica, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'SpecificViews' => [ + 'title' => '', + 'description' => 'A configuration set for specific view objects. When `mode` is `WILDCARD`, this parameter specifies the renaming configuration for specific view objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['title' => '', 'description' => 'The mapping name of the table.', 'type' => 'string', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['title' => '', 'description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'e_474hmh5iqo***'], + 'WhereClause' => ['title' => '', 'description' => 'The `WHERE` clause from a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'Cpu' => [ - 'description' => 'The information about the CPU resources of the replica.', - 'type' => 'object', - 'properties' => [ - 'TotalCpu' => [ - 'title' => '副本总CPU', - 'description' => 'The total number of CPU cores of the replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'UsedCpu' => [ - 'title' => '副本已使用CPU', - 'description' => 'The number of CPU cores used by the replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], + 'DistributedKeys' => [ + 'description' => 'The collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], - 'ZoneLogicalId' => [ - 'title' => '副本编号', - 'description' => 'The serial number of the replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1'."\n", - ], - 'ReplicaType' => [ - 'title' => '副本类型', - 'description' => 'The type of the replica.', - 'type' => 'string', - 'example' => 'FULL', - ], - 'Status' => [ - 'title' => '副本状态，返回枚举类型（ACTIVE/INACTIVE/UNKNOWN）', - 'description' => 'The status of the replica. Valid values: ACTIVE, INACTIVE, and UNKNOWN.', - 'type' => 'string', - 'example' => 'ACTIVE', - 'enum' => [ - 'ACTIVE', - 'INACTIVE', - 'UNKNOWN', - ], - ], - 'ReadOnlyReplicaType' => [ - 'description' => 'The type of the read-only replica.', - 'type' => 'string', - 'example' => 'ROW_STORE', - 'enum' => [ - 'ROW_STORE', - 'COLUMN_STORE', - 'NOT_READONLY_REPLICA', - ], - ], - 'OnlineNodeNum' => [ - 'title' => '在线节点数', - 'type' => 'integer', - 'format' => 'int64', - ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => 'The information about replicas.', + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', + ], + 'TableAndViewWhiteList' => [ + 'title' => '', + 'description' => 'Pattern matching mode: a wildcard whitelist of tables and views.', + 'type' => 'array', + 'items' => ['description' => 'Pattern matching mode: a wildcard whitelist of tables and views.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'TableAndViewBlackList' => [ + 'title' => '', + 'description' => 'Pattern matching rule: wildcard blacklist List for Tables and views.', + 'type' => 'array', + 'items' => ['description' => 'Pattern matching rule: wildcard blacklist for Tables and views.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + 'required' => false, + 'example' => '', ], ], + 'required' => true, + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceTopology\\": {\\n \\"Tenants\\": [\\n {\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"TenantCpu\\": 2,\\n \\"TenantMemory\\": 10,\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"IsPrimaryTenantZone\\": true,\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Units\\": [\\n {\\n \\"UnitId\\": \\"1002\\",\\n \\"UnitStatus\\": \\"ONLINE\\",\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"UnitCpu\\": 2,\\n \\"UnitMemory\\": 10,\\n \\"EnableMigrateUnit\\": true,\\n \\"ManualMigrate\\": true,\\n \\"EnableCancelMigrateUnit\\": true,\\n \\"UnitDataSize\\": 10,\\n \\"ReplicaType\\": \\"FULL\\"\\n }\\n ],\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"TenantDeployType\\": \\"multiple\\",\\n \\"TenantUnitNum\\": 1,\\n \\"PrimaryZoneDeployType\\": \\"RANDOM\\",\\n \\"TenantDiskSize\\": 2,\\n \\"TenantUnitCpu\\": 4,\\n \\"TenantUnitMemory\\": 16\\n }\\n ],\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ZoneDisk\\": \\"200 GB\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"NodeCopyId\\": 1,\\n \\"NodeStatus\\": \\"ONLINE\\",\\n \\"NodeResource\\": {\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 4,\\n \\"TotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 10,\\n \\"TotalMemory\\": 70\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 100,\\n \\"UsedDiskSize\\": 50\\n }\\n },\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"FullCopyId\\": 1,\\n \\"ReadOnlyCopyId\\": 1,\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"ZoneResource\\": {\\n \\"DiskSize\\": {\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ]\\n }\\n }\\n }\\n ],\\n \\"Replicas\\": [\\n {\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"NodeNum\\": 1,\\n \\"ZoneLogicalName\\": \\"cn-hangzhou-h\\",\\n \\"ZoneRegionName\\": \\"cn-hangzhou-h\\",\\n \\"ReplicaResource\\": {\\n \\"Memory\\": {\\n \\"UsedMemory\\": 16,\\n \\"TotalMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 50,\\n \\"TotalDiskSize\\": 100\\n },\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 16,\\n \\"UsedCpu\\": 8\\n }\\n },\\n \\"ZoneLogicalId\\": 1,\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\",\\n \\"OnlineNodeNum\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n \\n t33h8y08k****\\n pay_online\\n 2\\n 10\\n Oracle\\n \\n ReadWrite\\n true\\n cn-hangzhou-h\\n \\n 1002\\n ONLINE\\n i-bp16niirq4zdmgvm****\\n 2\\n 10\\n true\\n true\\n true\\n \\n \\n ONLINE\\n multiple\\n 1\\n \\n \\n cn-hangzhou-i\\n cn-hangzhou\\n 200 GB\\n \\n i-bp16niirq4zdmgvm****\\n 1\\n ONLINE\\n \\n \\n 4\\n 14\\n \\n \\n 10\\n 70\\n \\n \\n 400\\n 200\\n \\n \\n \\n \\n \\n 0.14\\n i-bp1fhj23fs32dfbg4****\\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeInstanceTopology', - ], - 'DescribeAvailableSpec' => [ - 'summary' => 'You can call this operation to query the specifications available for an OceanBase cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CommonTransferConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '集群ID', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', + 'title' => '', + 'description' => 'Common transfer configuration.', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => [ + 'title' => '', + 'description' => 'Supported table types include ALL (all tables), WITH_UNIQUE_ROW_ID (tables with a unique row identity), and WITHOUT_UNIQUE_ROW_ID (tables without a unique row identity). The default value is ALL. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + 'default' => 'ALL', + 'enum' => ['ALL', 'WITHOUT_UNIQUE_ROW_ID', 'WITH_UNIQUE_ROW_ID'], + ], + 'ActiveActive' => ['title' => '', 'description' => 'Indicates whether this is an active-active disaster recovery scenario.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'MqSerializerType' => ['title' => '', 'description' => 'The JSON serialization type for data delivered to the message queue. Valid values include DEFAULT, CANAL, DATAWORKS_V2, SHAREPLEX, DEFAULT_WITH_SCHEMA, DEBEZIUM, DEBEZIUMFlatten, and DEBEZIUMSMT.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], + 'MqPartitionMode' => ['title' => '', 'description' => 'The partition routing method when delivering messages to the message queue. Valid values include ONE (delivery to a specified partition), HASH (delivery based on hash of the primary key or shard column value), and TABLE (delivery based on hash of the database and table name).', 'type' => 'string', 'required' => false, 'example' => 'ONE'], + 'MqPartition' => ['title' => '', 'description' => 'When `MqPartitionMode` is `ONE`, this parameter specifies the position of the delivery partition under the current topic.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'DatahubTopicType' => [ + 'title' => '', + 'description' => 'When delivering messages to the DataHub message queue, specify the topic type. Valid enumeration values are `BLOB` and `TUPLE`.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['BLOB' => 'BLOB', 'TUPLE' => 'TUPLE'], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => ['title' => '', 'description' => 'Specifies the producer group name (effective only when the target is ROCKETMQ). The default value is OMS. ', 'type' => 'string', 'required' => false, 'example' => 'OMS'], + 'RocketMqMsgTags' => ['title' => '', 'description' => 'Set the message tag (takes effect only when the target is ROCKETMQ). The default value is default->default_tag.', 'type' => 'string', 'required' => false, 'example' => 'default_tag'], + 'RocketMqEnableMsgTrace' => ['title' => '', 'description' => 'Whether to enable message tracing (effective only when the target is ROCKETMQ). ', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'RocketMqSendMsgTimeout' => ['title' => '', 'description' => 'Set the message delivery timeout (takes effect only when the target is ROCKETMQ).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'null'], + 'DataWorksBusinessName' => ['title' => '', 'description' => 'Operational System identity. This parameter identifies the source operational system of the data, enabling subsequent custom processing. You can set this parameter only when the serialization method is DataWorks. The length must be 1 to 20 characters.', 'type' => 'string', 'required' => false, 'example' => 'null'], + 'SyncSchema' => ['description' => 'Specifies whether to synchronize the schema of the source data to the target. If enabled, an additional column is expected to be created on the target table to receive the schema name. The name of this column is specified by the `syncSchemaColumnName` parameter.', 'title' => 'Whether to Synchronize the Schema of the Source Data to the Target (an Additional Column Is Expected on the Target Table to Receive the Schema Name; See the syncSchemaColumnName Parameter)', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'SyncSchemaColumnName' => ['description' => 'If the feature to synchronize the schema to the target is enabled, you can specify the column name to be synchronized to the target (the column must be pre-created on the target).', 'title' => 'If the feature to synchronize the schema to the target is enabled, you can specify the field name to be synchronized to the target.', 'type' => 'string', 'required' => false, 'example' => 'source_schema_name'], + 'CustomColumns' => [ + 'description' => 'An array of custom columns. The corresponding columns must be pre-created on the target side.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'title' => 'Column Name', 'type' => 'string', 'required' => false, 'example' => 'test_column'], + 'Expression' => ['description' => 'The expression for the column value.', 'title' => 'Column Value Expression', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SinkStoreFormat' => [ + 'enumValueTitles' => [], + 'description' => 'The storage class of the target table object. This parameter takes effect only when the target OceanBase database is version V4.3.0 or later, and either **Schema Migration** or **Incremental Synchronization** > **DDL Synchronization** is selected on the **Select Migration Type** page.'."\n" + ."\n" + .'The available storage classes for the target table object include **default** (DEFAULT), **row store** (ROW), **column store** (COLUMN), and **hybrid row-column store** (COMPOUND). This parameter determines the storage class of the target table object during schema migration or incremental synchronization. For more information, see [default_table_store_format](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002015561).'."\n" + ."\n" + .'> The **default** option automatically adapts to other options based on the target-side configuration. Specifically, table objects created during schema migration or new table objects from incremental DDL operations are written with the structure corresponding to the configured storage class.', + 'title' => 'If the feature of synchronizing schema to the target is enabled, you can specify the field name for synchronization to the target', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + 'SourceStoreFormat' => [ + 'enumValueTitles' => [], + 'description' => 'The storage class of the source table object. This parameter takes effect when the source OceanBase database is version V4.3.0 or later, and **Reverse Incremental** > **DDL Synchronization** is selected on the **Select Migration Type** page.'."\n" + ."\n" + .'The storage classes for the source table object include **default** (DEFAULT), **row store** (ROW), **column store** (COLUMN), and **compound store** (COMPOUND). This parameter determines the storage class of the source table object during reverse incremental synchronization. For more information, see [default_table_store_format](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002015561).'."\n" + ."\n" + .'> The **default** option automatically adapts to other options based on the target-side parameter configuration. When reverse incremental synchronization is enabled, newly created table objects from incremental DDL are written to the corresponding structure according to the configured storage class.', + 'title' => 'If the feature to synchronize the schema to the target is enabled, you can specify the field name to be synchronized to the target.', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'UpgradeType', + 'name' => 'EnableStructTransfer', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to allow structure transfer.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'StructTransferConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '变配类型', - 'description' => 'The type of the specification change.'."\n" - .'Valid values:'."\n" - .'- upgradenodenum: Increases the number of nodes.'."\n" - .'- downgradespec: Downgrades the specification plan.'."\n" - .'- upgradespec: Upgrades the specification plan.'."\n" - .'- upgradedisk: Increases the disk size.'."\n" - .'- downgradenodenum: Reduces the number of nodes.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'downgradedisk' => 'downgradedisk', - 'upgradenodenum' => 'upgradenodenum', - 'downgradespec' => 'downgradespec', - 'upgradespec' => 'upgradespec', - 'upgradedisk' => 'upgradedisk', - 'downgradenodenum' => 'downgradenodenum', + 'title' => '', + 'description' => 'Configuration for structure transfer. ', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => '', + 'description' => 'The byte/char conversion strategy. Enumeration values include `IGNORE_BYTE_IF_BYTE_USED`, `FORCE_CHAR_IF_BYTE_USED`, `EXPAND_LEN_IF_BYTE_USED`, and `DO_NOTHING_IF_BYTE_USED` (default value).', + 'type' => 'string', + 'required' => false, + 'example' => 'DO_NOTHING_IF_BYTE_USED', + 'default' => 'DO_NOTHING_IF_BYTE_USED', + 'enum' => ['IGNORE_BYTE_IF_BYTE_USED', 'FORCE_CHAR_IF_BYTE_USED', 'EXPAND_LEN_IF_BYTE_USED', 'DO_NOTHING_IF_BYTE_USED'], + ], + 'DeferIndexCreation' => ['title' => '', 'description' => 'Whether to allow deferred index creation. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], - 'example' => 'upgradespec', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Spec', + 'name' => 'EnableFullTransfer', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable full data transfer.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'EnableFullVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable full verification.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'FullTransferConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '节点规格', - 'description' => 'The specifications of the node.', - 'type' => 'string', + 'title' => '', + 'description' => 'Configuration for full data transfer.', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => ['title' => '', 'description' => 'Specifies whether to delete data from the target table when performing full migration for tables without a unique index on the source. '."\n" + .'Scenario: Multiple links from a PolarDB-X 1.0 database with tables lacking primary keys converge into the same target table. This avoids a situation where partial data from earlier links is erased by another link that truncates the target table immediately upon starting.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AllowDestTableNotEmpty' => ['title' => '', 'description' => 'The policy for handling cases where the target table object contains records. Options include **Ignore** and **Stop Migration**. '."\n" + .'- When set to true, it selects "Ignore": If the target table object contains data and there is a conflict between the existing data and the incoming data, Data Transmission Service logs the conflicting data and retains the original data unchanged during data ingestion. '."\n" + .'>If "Ignore" is selected, full validation uses the IN pattern to pull data, which cannot validate scenarios where extra data exists on the target side, and validation performance is degraded to some extent.> '."\n" + .'- When set to false, it selects "Stop Migration": If the target table object contains data, full migration reports an error and does not allow migration. You must clean up the data on the target side before proceeding with migration. '."\n" + .'>If you click recover after an error occurs, Data Transmission Service ignores this configuration option and continues migrating table data. Proceed with caution.> '."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'FullTransferSpeedMode' => [ + 'title' => '', + 'description' => 'The concurrent speed for full migration, including STEADY, NORMAL, and FAST. '."\n" + .'>If a full migration step exists, FullTransferSpeedMode must be specified; you can specify NORMAL.', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => ['STEADY', 'NORMAL', 'FAST'], + ], + 'FullVerifySpeedMode' => [ + 'title' => '', + 'description' => 'The concurrent speed for full validation, including STEADY, NORMAL, and FAST. '."\n" + .'>If a full validation step exists, FullVerifySpeedMode must be specified; you can specify NORMAL.', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => ['STEADY', 'NORMAL', 'FAST'], + ], + 'WriteWorkerNum' => ['description' => 'Write concurrency. '."\n", 'title' => 'Write concurrency; null means not configured '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'ReadWorkerNum' => ['description' => 'Read concurrency. '."\n", 'title' => 'Read concurrency; null means not configured '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'ThrottleRps' => ['description' => 'Limits the maximum transmission rate achievable during the full migration phase, in records per second. Entering null indicates no RPS throttling. '."\n", 'title' => 'Limit RPS; null means no throttling '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'Limits the maximum traffic achievable during the full migration phase, in bytes per second. Entering null indicates no IOPS throttling. '."\n", 'title' => 'Limit traffic (bytes per second); null means no throttling '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'HbaseObjCheckMode' => [ + 'description' => 'The validation mode for HBase objects, including NEWEST and ALL.', + 'title' => 'HBase object validation mode: NEWEST, ALL', + 'type' => 'string', + 'enum' => ['ALL', 'NEWEST'], + 'required' => false, + 'example' => 'NEWEST', + ], + 'HbaseObjMigMode' => [ + 'description' => 'The migration pattern for HBase objects, which includes NEWEST and ALL.', + 'title' => 'HBase object migration mode: NEWEST, ALL', + 'type' => 'string', + 'enum' => ['ALL', 'NEWEST'], + 'required' => false, + 'example' => 'NEWEST', + ], + 'IndexDDLConcurrencyLimit' => ['description' => 'Concurrency configuration for a single index DDL operation. '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'MaxConcurrentIndexDDLs' => ['description' => 'Configuration for the maximum number of concurrent index DDL operations.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'title' => ''], + ], 'required' => false, - 'example' => 'oceanbase.cluster.cd8.xlarge', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'EnableIncrTransfer', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable incremental synchronization.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'EnableReverseIncrTransfer', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Whether reverse incremental synchronization is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IncrTransferConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', + 'title' => '', + 'description' => 'Configuration for incremental synchronization.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'AvailableSpecifications' => [ - 'title' => '返回数据', - 'description' => 'The specifications available for the cluster.', - 'type' => 'array', - 'items' => [ - 'description' => 'The specifications available for the cluster.', - 'type' => 'object', - 'properties' => [ - 'Spec' => [ - 'description' => 'The specifications of the migration instance.', - 'type' => 'string', - 'example' => 'oceanbase.cluster.cd8.xlarge', - ], - 'InstanceClass' => [ - 'description' => 'The specifications of the cluster.', - 'type' => 'string', - 'example' => '4C16GB', - ], - 'NodeNum' => [ - 'title' => '节点个数', - 'description' => 'The number of nodes.', - 'type' => 'array', - 'items' => [ - 'title' => '节点个数', - 'description' => 'The number of nodes.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - 'DiskSizeRange' => [ - 'description' => 'The storage size.', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'title' => '最小调整粒度', - 'description' => 'The minimum adjustment step.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Max' => [ - 'title' => '最大值', - 'description' => 'The maximum value of the parameter.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000', - ], - 'Min' => [ - 'title' => '最小值', - 'description' => 'The minimum value of the parameter.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - 'title' => '', - ], - 'LogDiskSizeRange' => [ - 'description' => 'The size of the log disk.', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'title' => '最小调整粒度', - 'description' => 'The minimum adjustment step.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Max' => [ - 'title' => '最大值', - 'description' => 'The maximum value of the parameter.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4000', - ], - 'Min' => [ - 'title' => '最小值', - 'description' => 'The minimum value of the parameter.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - 'title' => '', - ], - 'DiskTypes' => [ - 'title' => '', - 'description' => '存储类型列表信息。', - 'type' => 'array', - 'items' => [ - 'title' => '存储类型', - 'description' => '存储类型。', - 'type' => 'string', - 'example' => 'cloud_essd_pl1', - ], - ], - ], - ], - ], + 'StartTimestamp' => ['title' => '', 'description' => 'The starting offset for incremental synchronization. This parameter can be set only when incremental synchronization is enabled but full data transfer is not enabled. ', 'type' => 'string', 'required' => false, 'example' => '1689201369'], + 'RecordTypeWhiteList' => [ + 'title' => '', + 'description' => 'The types of incremental data to synchronize when an incremental synchronization phase is present.', + 'type' => 'array', + 'items' => [ + 'description' => 'The types of incremental data to synchronize when an incremental synchronization phase is present.', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + 'enum' => ['HEARTBEAT', 'INSERT', 'UPDATE', 'DELETE', 'BEGIN', 'COMMIT', 'ROLLBACK', 'DDL', 'ROW', 'PUT'], + 'title' => '', ], + 'required' => false, + 'example' => '', + ], + 'StoreLogKeptHour' => ['title' => '', 'description' => 'Log retention period in hours when the incremental synchronization phase is enabled and the incremental log pull widget is Store. The default value is 7 days, with a maximum of 365 days. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], + 'EnableSequencingWithinTxn' => ['title' => '', 'description' => 'Whether to enable sequencing within transactions when the incremental synchronization phase is enabled and the incremental log pull widget is Store. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IncrSyncConcurrency' => ['title' => '', 'description' => 'The number of threads used for incremental synchronization. The default value is 64.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1024', 'minimum' => '1', 'example' => '64', 'default' => '64'], + 'EnableIncrSyncStatistics' => ['title' => '', 'description' => 'Whether to enable statistics collection for incremental records (DML and DDL). ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ThrottleRps' => ['description' => 'The maximum transfer rate allowed during the incremental transfer phase, measured in records per second (RPS). If null is specified, RPS throttling is disabled.', 'title' => 'RPS throttling; null means no throttling', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'Maximum transfer traffic allowed during the incremental transfer phase, measured in bytes per second. If set to null, input/output operations per second (IOPS) are not throttled. ', 'title' => 'Traffic Throttling Limit in Bytes per Second (Null for No Throttling)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'SupportDDLTypes' => [ + 'description' => 'Supported DDL types. ', + 'title' => 'Supported DDL Types ', + 'type' => 'array', + 'items' => [ + 'description' => 'Supported DDL types. ', + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => ['CREATE_TABLE', 'ALTER_TABLE', 'DROP_TABLE', 'RENAME_TABLE', 'TRUNCATE_TABLE', 'CREATE_INDEX', 'DROP_INDEX'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"NodeNum\\": [\\n 3\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"LogDiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 4000,\\n \\"Min\\": 100\\n },\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeAvailableSpec', - ], - 'DescribeAvailableZone' => [ - 'summary' => 'You can call this operation to query the configurations available for creating an OceanBase cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceType', - 'in' => 'formData', - 'schema' => [ - 'title' => '实例类型', - 'description' => 'The type of the instance.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'cluster' => 'cluster', - ], - 'example' => 'cluster', - ], - ], - [ - 'name' => 'Series', - 'in' => 'formData', - 'schema' => [ - 'title' => '系列', - 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" - .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" - .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" - .'- history: History Database Cluster Edition.', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], - ], - [ - 'name' => 'DeployType', - 'in' => 'formData', - 'schema' => [ - 'title' => '部署方案', - 'description' => 'The deployment type of the cluster. Valid values: '."\n" - .'- multiple: multi-IDC deployment '."\n" - .'- single: single-IDC deployment '."\n" - .'- dual: dual-IDC deployment ', - 'type' => 'string', - 'required' => false, - 'example' => 'multiple', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点规划', - 'description' => 'The specification of the node.', - 'type' => 'string', - 'required' => false, - 'example' => 'oceanbase.cluster.cd8.xlarge', - ], - ], - [ - 'name' => 'ObVersion', - 'in' => 'formData', - 'schema' => [ - 'title' => '版本', - 'description' => 'The version of OceanBase Database.', - 'type' => 'string', 'required' => false, - 'example' => '3.2.4.4', + 'example' => '', ], ], [ - 'name' => 'CpuArch', + 'name' => 'ReverseIncrTransferConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'cpu架构', - 'description' => 'cpu架构', - 'type' => 'string', + 'description' => 'Reverse incremental transfer configuration. ', + 'title' => 'Reverse Incremental Transfer Configuration ', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => ['description' => 'Start offset for reverse incremental synchronization. ', 'title' => 'Reverse Incremental Synchronization Offset ', 'type' => 'string', 'required' => false, 'example' => '1684771200'], + 'RecordTypeWhiteList' => [ + 'description' => 'The types of incremental data to synchronize during the reverse incremental synchronization phase.', + 'title' => 'Incremental data types to synchronize during the reverse incremental synchronization phase', + 'type' => 'array', + 'items' => [ + 'description' => 'The types of incremental data to synchronize during the reverse incremental synchronization phase.', + 'type' => 'string', + 'example' => 'INSERT', + 'enum' => ['HEARTBEAT', 'INSERT', 'UPDATE', 'DELETE', 'BEGIN', 'COMMIT', 'ROLLBACK', 'DDL', 'ROW', 'PUT'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + 'StoreLogKeptHour' => ['description' => 'Log retention period in hours when reverse incremental synchronization is enabled and the incremental log pull widget is Store. The default is 7 days, with a maximum of 365 days. ', 'title' => 'Log Retention Period in Hours When Reverse Incremental Synchronization Is Enabled and the Incremental Log Pull Widget Is Store (Default: 7 Days, Maximum: 365 Days) ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], + 'EnableSequencingWithinTxn' => ['description' => 'Whether to enable sequencing within transactions when reverse incremental synchronization is enabled and the incremental log pull widget is Store. ', 'title' => 'Enable Sequencing Within Transactions When Reverse Incremental Synchronization Is Enabled and the Incremental Log Pull Widget Is Store ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IncrSyncConcurrency' => [ + 'enumValueTitles' => [], + 'description' => 'The number of threads used for reverse incremental synchronization. The default value is 64.', + 'title' => 'Number of threads for reverse incremental synchronization; default is 64', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + 'default' => '64', + 'required' => false, + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => ['description' => 'Whether to enable statistics collection for reverse incremental records (DML, DDL). ', 'title' => 'Enable Statistics Collection for Reverse Incremental Records (DML, DDL) ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ThrottleRps' => ['description' => 'The maximum transfer rate allowed during the reverse incremental synchronization phase, measured in records per second (RPS). When set to null, RPS is not throttled.', 'title' => 'Throttle RPS; null means no throttling', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'The maximum transfer traffic allowed during the reverse incremental synchronization phase, measured in bytes per second. When set to null, IOPS is not throttled.', 'title' => 'Throttle traffic in bytes per second; null means no throttling', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'], + 'SupportDDLTypes' => [ + 'description' => 'Supported DDL types. ', + 'title' => 'Supported DDL Types ', + 'type' => 'array', + 'items' => [ + 'description' => 'Supported DDL types. ', + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => ['CREATE_TABLE', 'ALTER_TABLE', 'DROP_TABLE', 'RENAME_TABLE', 'TRUNCATE_TABLE', 'CREATE_INDEX', 'DROP_INDEX'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'x86', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => 'OmsApiReturnResult', + 'description' => 'Return Result. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The returned data.', + 'Success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Error Details. ', 'type' => 'object', 'properties' => [ - 'AvailableZones' => [ - 'title' => '返回数据', - 'description' => 'The configurations available for cluster creation.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about configurations available for cluster creation.', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '地域', - 'description' => 'The region.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Zones' => [ - 'title' => '可用区列表', - 'description' => 'The list of zones.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', - ], - 'Channel' => [ - 'description' => 'The source of the order. '."\n" - .'* PUBLIC '."\n" - .'* FINANCE', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'DeployType' => [ - 'title' => '部署方案', - 'description' => 'The deployment type of the cluster. Valid values: '."\n" - .'- multiple: multi-IDC deployment '."\n" - .'- single: single-IDC deployment '."\n" - .'- dual: dual-IDC deployment ', - 'type' => 'string', - 'example' => 'multiple', - ], - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => 'The type of the instance.', - 'type' => 'string', - 'example' => 'cluster', - ], - 'Series' => [ - 'title' => '系列', - 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" - .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" - .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" - .'- history: History Database Cluster Edition.', - 'type' => 'string', - 'example' => 'normal', - ], - 'SupportSpecifications' => [ - 'title' => '节点规格', - 'description' => 'The specifications of the node.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about specifications of the node.', - 'type' => 'object', - 'properties' => [ - 'Spec' => [ - 'description' => 'The specification of the node.', - 'type' => 'string', - 'example' => 'oceanbase.cluster.cd8.xlarge', - ], - 'InstanceClass' => [ - 'description' => 'The specification of the cluster.', - 'type' => 'string', - 'example' => '4C16GB', - ], - 'DiskTypes' => [ - 'title' => '存储类型', - 'description' => 'The storage types.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about storage types.', - 'type' => 'string', - 'example' => 'cloud_essd_pl1', - ], - ], - 'DiskSizeRange' => [ - 'title' => '存储大小', - 'description' => 'The storage size.', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'title' => '最小调整粒度', - 'description' => 'The minimum adjustment step.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Max' => [ - 'title' => '最大值', - 'description' => 'The maximum value.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000', - ], - 'Min' => [ - 'title' => '最小值', - 'description' => 'The minimum value.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - 'SupportEngineVersions' => [ - 'title' => '版本', - 'description' => 'The versions.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about versions.', - 'type' => 'object', - 'properties' => [ - 'ObVersion' => [ - 'description' => 'The version of OceanBase Database.', - 'type' => 'string', - 'example' => '3.2.4.4', - ], - 'SupportIsolationOptimization' => [ - 'title' => '是否支持隔离', - 'description' => 'Indicates whether isolation is supported.', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'false', - ], - 'SupportReplicaModes' => [ - 'title' => '全功能型副本数', - 'description' => 'The number of full-featured replicas.', - 'type' => 'array', - 'items' => [ - 'title' => '全功能型副本数', - 'description' => 'The number of full-featured replicas.', - 'type' => 'string', - 'example' => '3F', - ], - ], - ], - ], - ], - ], - ], - ], - 'CpuArch' => [ - 'title' => 'cpu架构', - 'description' => 'The CPU architecture.', - 'type' => 'string', - 'example' => 'x86', - ], - ], - ], + 'Code' => ['description' => 'Error code (new). ', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'Includes FATAL, ERROR, WARNING, and CRITICAL. ', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'Error description (new). ', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used for padding placeholders in the Message. ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => 'null', 'description' => 'Used for padding placeholders in the Message. ', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message. ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in MessageMcmsKey. ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'Used to fill placeholders in MessageMcmsKey. ', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'Error reason. ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason. ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Context of the error reason. ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'null', 'description' => 'Context of the error reason. ', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'Suggestion (new). ', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'Key of the suggestion content. ', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion content. ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The context of the suggestion content. ', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details, used for handling HTTP requests. ', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'Error code (deprecated).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['title' => '', 'description' => 'Error description (old) ', 'type' => 'string', 'example' => 'A system error occurred.'], + 'Advice' => ['title' => '', 'description' => 'Advice (deprecated)', 'type' => 'string', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'XCVSADG****DSGDS'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'Page number. This parameter takes effect during paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'Page size. This parameter takes effect during paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'Total count, effective during paged query. ', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['title' => '', 'description' => 'Request latency, in seconds.', 'type' => 'string', 'example' => '27'], + 'Data' => ['title' => '', 'description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'example' => 'np_****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableZones\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Zones\\": \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\",\\n \\"Channel\\": \\"PUBLIC\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"InstanceType\\": \\"cluster\\",\\n \\"Series\\": \\"normal\\",\\n \\"SupportSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"SupportEngineVersions\\": [\\n {\\n \\"ObVersion\\": \\"3.2.4.4\\",\\n \\"SupportIsolationOptimization\\": true,\\n \\"SupportReplicaModes\\": [\\n \\"3F\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"CpuArch\\": \\"x86\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeAvailableZone', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27\\",\\n \\"Data\\": \\"np_****\\"\\n}","type":"json"}]', + 'title' => 'Creation Job', + 'changeSet' => [ + ['createdAt' => '2024-10-17T02:36:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-26T06:28:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-08T12:02:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-20T02:08:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-10T06:42:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-09T03:09:46.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [], ], - 'DescribeInstanceCreatableZone' => [ - 'summary' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateProjectModifyRecords' => [ + 'summary' => 'This operation modifies the objects of a data migration or data synchronization task that is running, failed, or paused.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the zone. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Databases', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The list of zones. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'Indicates whether the cluster is deployed in the zone. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'ZoneList' => [ - 'title' => '可用区列表信息。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeInstanceCreatableZone**. ', - 'type' => 'array', - 'items' => [ - 'description' => 'Example 1', - 'type' => 'object', - 'properties' => [ - 'IsInCluster' => [ - 'title' => '是否是集群部署的可用区。', - 'description' => ' ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Zone' => [ - 'title' => '可用区ID。', - 'description' => 'DescribeInstanceCreatableZone', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', + 'title' => '', + 'description' => 'A list of database objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the database.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'db_id'], + 'Name' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'db_name'], + 'MappedName' => ['description' => 'The mapped name of the database.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mapped_db'], + 'Tables' => [ + 'title' => '', + 'description' => 'The configuration for transferring table objects in the current database. When Mode is set to WILDCARD, this parameter specifies the blacklist or whitelist configuration, which is shared by tables and views.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['description' => 'The mapped name of the table.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'table_id'], + 'WhereClause' => ['description' => 'The `WHERE` clause of a standard SQL statement used to configure row filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filtered columns.', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information for the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'A collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col2', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObkvPartitionConfig' => [ + 'description' => 'The partition configuration for Hbase mode. This is used only when migrating data to OBKV.', + 'title' => 'HBase mode partition configuration, used only in migration to OBKV scenarios.', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => ['KEY', 'RANGE', 'NONE'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'VirtualColumn' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionSize' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '1024', 'minimum' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], ], - 'FullCopyId' => [ - 'title' => '副本序号', - 'type' => 'string', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Views' => [ + 'title' => '', + 'description' => 'A list of configurations for transferring view objects in the current database.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the view.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'view_name'], + 'MappedName' => ['description' => 'The mapped name of the view.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mapped_view'], + 'Id' => ['description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'view_id', 'title' => ''], + 'WhereClause' => ['description' => 'The `WHERE` clause of a standard SQL statement used to configure row filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filtered columns.', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information for the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'A collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col2', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], ], - 'LogicalZoneName' => [ - 'title' => '逻辑副本', - 'type' => 'string', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificTables' => [ + 'title' => '', + 'description' => 'A collection of configurations for specific table objects. When `mode` is `WILDCARD`, this parameter specifies the renaming and row filtering configurations for specific table objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'table_name'], + 'MappedName' => ['description' => 'The mapped name of the table.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mapped_table'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'required' => false, 'example' => 'table_id', 'title' => ''], + 'WhereClause' => ['description' => 'The `WHERE` clause of a standard SQL statement used to configure row filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filtered columns.', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information for the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'A collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col2', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], ], - 'ReplicateZoneIndex' => [ - 'title' => '副本可用区序号', - 'type' => 'integer', - 'format' => 'int64', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificViews' => [ + 'title' => '', + 'description' => 'A list of configurations for specific view objects. When `mode` is `WILDCARD`, this parameter specifies the renaming configuration for specific view objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the view.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'view_name'], + 'MappedName' => ['description' => 'The mapped name of the view.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mapped_view'], + 'Id' => ['description' => 'The ID of the view.', 'type' => 'string', 'required' => false, 'example' => 'view_id', 'title' => ''], + 'WhereClause' => ['description' => 'The `WHERE` clause of a standard SQL statement used to configure row filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'id <1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'A collection of filtered columns.', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'A collection of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'required' => false, 'example' => 'col1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => '', + 'description' => 'The mapping information for the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'A collection of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'required' => false, 'example' => 'pk', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'A collection of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'required' => false, 'example' => 'col2', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => false, 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'example' => '', ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"ZoneList\\": [\\n {\\n \\"IsInCluster\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"FullCopyId\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\",\\n \\"ReplicateZoneIndex\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n true\\n cn-hangzhou-i\\n \\n","errorExample":""}]', - 'title' => 'DescribeInstanceCreatableZone', - ], - 'ModifyInstanceName' => [ - 'summary' => 'You can call this operation to change the name of an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'InstanceName', + 'name' => 'TransferMapping', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob4prod', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The name of the OceanBase cluster. '."\n" - .'It must be 1 to 20 characters in length. ', + 'description' => 'The list of transfer objects. This is required when you modify matching rules.', + 'title' => 'List of transfer objects (Required when modifying matching rules)', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyInstanceName**. ', + 'Mode' => [ + 'title' => 'Transfer object mapping mode (SPECIFIC for specific objects, WILDCARD for pattern matching rules, COMPLEX for mixed rules) ', + 'description' => 'The mapping mode for transfer objects. Valid values: SPECIFIC (specify objects), WILDCARD (use matching rules), and COMPLEX (use a mix of rules).', 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 9005 => [ - [ - 'errorCode' => 'MissingInstanceId', - 'errorMessage' => 'InstanceId is mandatory for this action.', - ], - ], - [ - [ - 'errorCode' => 'MissingInstanceName', - 'errorMessage' => 'InstanceName is mandatory for this action.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ob4test\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyInstanceName', - ], - 'ModifyInstanceSpec' => [ - 'summary' => 'You can call this operation to modify the cluster specifications and storage space.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群的ID。', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob3h8ytroxxxxx', - ], - ], - [ - 'name' => 'InstanceClass', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群规格信息。
当前支持以下套餐：
- 4C16GB：4核 16GB
- 8C32GB：8核 32GB
- 14C70GB：14核 70GB
- 24C120GB：24核 120GB
- 30C180GB：30核 180GB
- 62C400GB：62核 400GB
- 104C600GB：104核 600GB
- 16C70GB：16核 70GB
- 32C160GB：32核 160GB
- 64C380GB：64核 380GB
- 20C32GB：20核 32GB
- 40C64GB：40核 64GB
- 16C32GB：16核 32GB
- 32C70GB：32核 70GB
- 64C180GB：64核 180GB
- 32C180GB：32核 180GB
- 64C400GB：64核 400GB。', - 'description' => 'The specifications of the cluster. You can specify one of the following four plans:'."\n" - .'- 8C32GB: indicates 8 CPU cores and 32 GB of memory.'."\n" - .'- 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" - .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory.'."\n" - .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', - 'type' => 'string', - 'required' => false, - 'example' => '14C70GB', - ], - ], - [ - 'name' => 'DiskSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '存储空间大小，单位GB。 存储空间的限制根据集群规格不同而不同，具体如下： - 8C32G：100GB~10TB - 14C70G：200GB~10TB - 30C180G：400GB~10TB - 62C400G：800GB-10TB。 各套餐的存储空间默认值为其最小值。', - 'description' => 'The size of the storage space, in GB. The required storage space varies based on the cluster specifications:'."\n" - .'- 8C32G: 100 GB to 10 TB.'."\n" - .'- 14C70G: 200 GB to 10 TB.'."\n" - .'- 30C180G: 400 GB to 10 TB.'."\n" - .'- 62C400G: 800 GB to 10 TB. The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - ], - [ - 'name' => 'DryRun', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" - .'true：发送检查请求，不会更改实例配置。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" - .'false（默认）：发送正常请求，通过检查后直接更改实例配置。', - 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" - .'- true: Only a dry-run request is sent and the instance settings are not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" - .'- false: If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'DiskType', - 'in' => 'formData', - 'schema' => [ - 'title' => '存储类型', - 'description' => 'Disk type.', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_essd_pl1', - ], - ], - [ - 'name' => 'UpgradeSpecNative', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否原地变配', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'title' => '请求返回的数据。', - 'description' => 'The return data of the request.', - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'title' => '订单ID。', - 'description' => 'The ID of the order that you have placed.', - 'type' => 'string', - 'example' => '213290*********', - ], - 'DryRunResult' => [ - 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', - 'description' => 'The result of the dry-run request.'."\n" - .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" - .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - 'example' => '1234567890', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - [ - 'errorCode' => 'InstanceDataSize.Invalid', - 'errorMessage' => 'InstanceDataSize.Invalid', - ], - [ - 'errorCode' => 'InstanceClassSpecification.Invalid', - 'errorMessage' => 'InstanceClassSpecification.Invalid', - ], - [ - 'errorCode' => 'InstanceOrder.NotAvailable', - 'errorMessage' => 'InstanceOrder.NotAvailable', - ], - [ - 'errorCode' => 'InstanceNodeNum.Invalid', - 'errorMessage' => 'InstanceNodeNum.Invalid', - ], - [ - 'errorCode' => 'InstanceLogSize.Invalid', - 'errorMessage' => 'InstanceLogSize.Invalid', - ], - [ - 'errorCode' => 'Instance.ExpandLogDisk.Unsupport', - 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', - ], - [ - 'errorCode' => 'InstanceStatus.Invalid', - 'errorMessage' => 'InstanceStatus.Invalid', - ], - [ - 'errorCode' => 'InstanceName.ModifyFailed', - 'errorMessage' => 'InstanceName.ModifyFailed', - ], - [ - 'errorCode' => 'InstanceClass.InvalidValue', - 'errorMessage' => 'InstanceClass.InvalidValue', - ], - [ - 'errorCode' => 'InstanceType.Unsupport', - 'errorMessage' => 'InstanceType.Unsupport', - ], - [ - 'errorCode' => 'ZoneList.Unsupport', - 'errorMessage' => 'ZoneList.Unsupport', - ], - [ - 'errorCode' => 'InstanceId.Invalid', - 'errorMessage' => 'InstanceId.Invalid', - ], - [ - 'errorCode' => 'InstanceId.Missing', - 'errorMessage' => 'InstanceId.Missing', - ], - [ - 'errorCode' => 'Instance.Name.Missing', - 'errorMessage' => 'Instance.Name.Missing', - ], - [ - 'errorCode' => 'ListCluster.Fail', - 'errorMessage' => 'ListCluster.Fail', - ], - [ - 'errorCode' => 'GetCluster.Fail', - 'errorMessage' => 'GetCluster.Fail', - ], - [ - 'errorCode' => 'ListClusterGroup.Fail', - 'errorMessage' => 'ListClusterGroup.Fail', - ], - [ - 'errorCode' => 'GetClusterGroup.Fail', - 'errorMessage' => 'GetClusterGroup.Fail', - ], - [ - 'errorCode' => 'ListInstance.Fail', - 'errorMessage' => 'ListInstance.Fail', - ], - [ - 'errorCode' => 'GetInstance.Fail', - 'errorMessage' => 'GetInstance.Fail', - ], - [ - 'errorCode' => 'ListTenant.Fail', - 'errorMessage' => 'ListTenant.Fail', - ], - [ - 'errorCode' => 'GetTenant.Fail', - 'errorMessage' => 'GetTenant.Fail', - ], - [ - 'errorCode' => 'Instance.ListAliyunInstance.Fail', - 'errorMessage' => 'Instance.ListAliyunInstance.Fail', - ], - [ - 'errorCode' => 'Instance.GetAliyunInstance.Fail', - 'errorMessage' => 'Instance.GetAliyunInstance.Fail', - ], - [ - 'errorCode' => 'ListZone.Fail', - 'errorMessage' => 'ListZone.Fail', - ], - [ - 'errorCode' => 'GetObServer.Fail', - 'errorMessage' => 'GetObServer.Fail', - ], - [ - 'errorCode' => 'CreateInstanceParameters.Error', - 'errorMessage' => 'CreateInstanceParameters.Error', - ], - [ - 'errorCode' => 'CreateInstance.Fail', - 'errorMessage' => 'CreateInstance.Fail', - ], - [ - 'errorCode' => 'StandbyInstance.StillOnline', - 'errorMessage' => 'StandbyInstance.StillOnline', - ], - [ - 'errorCode' => 'InstanceServiceName.Missing', - 'errorMessage' => 'InstanceServiceName.Missing', - ], - [ - 'errorCode' => 'PrimaryInstanceStatus.Invalid', - 'errorMessage' => 'PrimaryInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstanceStatus.Invalid', - 'errorMessage' => 'StandbyInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstance.NotSupport', - 'errorMessage' => 'StandbyInstance.NotSupport', - ], - [ - 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', - 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', - ], - [ - 'errorCode' => 'InstanceDiskSize.Invalid', - 'errorMessage' => 'InstanceDiskSize.Invalid', - ], - [ - 'errorCode' => 'CreateInstance.Spec.NotSupport', - 'errorMessage' => 'CreateInstance.Spec.NotSupport', - ], - [ - 'errorCode' => 'MissingParameterDiskSize', - 'errorMessage' => 'MissingParameterDiskSize', - ], - [ - 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', - 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', - ], - [ - 'errorCode' => 'CreateInstance.DeployType.InvalidValue', - 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', - ], - [ - 'errorCode' => 'AliyunInstance.NotExists', - 'errorMessage' => 'AliyunInstance.NotExists', - ], - ], - 500 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', - 'title' => 'ModifyInstanceSpec', - ], - 'ModifyInstanceNodeNum' => [ - 'summary' => 'You can call this operation to modify the number of nodes in a cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群的ID', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'NodeNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群节点个数信息。 如果部署模式为n-n-n，则节点个数为n * 3', - 'description' => 'The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.', - 'type' => 'string', - 'required' => true, - 'example' => '6', - ], - ], - [ - 'name' => 'DryRun', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" - .'true：发送检查请求，不会更改实例节点数。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" - .'false（默认）：发送正常请求，通过检查后直接更改实例节点数。', - 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" - .'- true: Only a dry-run request is sent and the number of nodes in the instance is not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" - .'- false: The actual request is sent and no dry run is performed. The number of nodes is changed if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'title' => '请求返回的信息。', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'title' => '订单号。', - 'description' => 'The ID of the order.', - 'type' => 'string', - 'example' => '2132903*********', - ], - 'DryRunResult' => [ - 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', - 'description' => 'The result of the dry-run request.'."\n" - .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" - .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => ['SPECIFIC', 'WILDCARD', 'COMPLEX'], ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - [ - 'errorCode' => 'InstanceDataSize.Invalid', - 'errorMessage' => 'InstanceDataSize.Invalid', - ], - [ - 'errorCode' => 'InstanceClassSpecification.Invalid', - 'errorMessage' => 'InstanceClassSpecification.Invalid', - ], - [ - 'errorCode' => 'InstanceLogSize.Invalid', - 'errorMessage' => 'InstanceLogSize.Invalid', - ], - [ - 'errorCode' => 'Instance.ExpandLogDisk.Unsupport', - 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', - ], - [ - 'errorCode' => 'InstanceOrder.NotAvailable', - 'errorMessage' => 'InstanceOrder.NotAvailable', - ], - [ - 'errorCode' => 'InstanceNodeNum.Invalid', - 'errorMessage' => 'InstanceNodeNum.Invalid', - ], - [ - 'errorCode' => 'InstanceStatus.Invalid', - 'errorMessage' => 'InstanceStatus.Invalid', - ], - [ - 'errorCode' => 'InstanceName.ModifyFailed', - 'errorMessage' => 'InstanceName.ModifyFailed', - ], - [ - 'errorCode' => 'InstanceClass.InvalidValue', - 'errorMessage' => 'InstanceClass.InvalidValue', - ], - [ - 'errorCode' => 'InstanceType.Unsupport', - 'errorMessage' => 'InstanceType.Unsupport', - ], - [ - 'errorCode' => 'InstanceId.Invalid', - 'errorMessage' => 'InstanceId.Invalid', - ], - [ - 'errorCode' => 'InstanceId.Missing', - 'errorMessage' => 'InstanceId.Missing', - ], - [ - 'errorCode' => 'Instance.Name.Missing', - 'errorMessage' => 'Instance.Name.Missing', - ], - [ - 'errorCode' => 'ListCluster.Fail', - 'errorMessage' => 'ListCluster.Fail', - ], - [ - 'errorCode' => 'GetCluster.Fail', - 'errorMessage' => 'GetCluster.Fail', - ], - [ - 'errorCode' => 'ListClusterGroup.Fail', - 'errorMessage' => 'ListClusterGroup.Fail', - ], - [ - 'errorCode' => 'GetClusterGroup.Fail', - 'errorMessage' => 'GetClusterGroup.Fail', - ], - [ - 'errorCode' => 'ListInstance.Fail', - 'errorMessage' => 'ListInstance.Fail', - ], - [ - 'errorCode' => 'GetInstance.Fail', - 'errorMessage' => 'GetInstance.Fail', - ], - [ - 'errorCode' => 'ListTenant.Fail', - 'errorMessage' => 'ListTenant.Fail', - ], - [ - 'errorCode' => 'GetTenant.Fail', - 'errorMessage' => 'GetTenant.Fail', - ], - [ - 'errorCode' => 'Instance.ListAliyunInstance.Fail', - 'errorMessage' => 'Instance.ListAliyunInstance.Fail', - ], - [ - 'errorCode' => 'Instance.GetAliyunInstance.Fail', - 'errorMessage' => 'Instance.GetAliyunInstance.Fail', - ], - [ - 'errorCode' => 'ListZone.Fail', - 'errorMessage' => 'ListZone.Fail', - ], - [ - 'errorCode' => 'GetObServer.Fail', - 'errorMessage' => 'GetObServer.Fail', - ], - [ - 'errorCode' => 'CreateInstanceParameters.Error', - 'errorMessage' => 'CreateInstanceParameters.Error', - ], - [ - 'errorCode' => 'CreateInstance.Fail', - 'errorMessage' => 'CreateInstance.Fail', - ], - [ - 'errorCode' => 'StandbyInstance.StillOnline', - 'errorMessage' => 'StandbyInstance.StillOnline', - ], - [ - 'errorCode' => 'InstanceServiceName.Missing', - 'errorMessage' => 'InstanceServiceName.Missing', - ], - [ - 'errorCode' => 'PrimaryInstanceStatus.Invalid', - 'errorMessage' => 'PrimaryInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstanceStatus.Invalid', - 'errorMessage' => 'StandbyInstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstance.NotSupport', - 'errorMessage' => 'StandbyInstance.NotSupport', - ], - [ - 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', - 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', - ], - [ - 'errorCode' => 'InstanceDiskSize.Invalid', - 'errorMessage' => 'InstanceDiskSize.Invalid', - ], - [ - 'errorCode' => 'CreateInstance.Spec.NotSupport', - 'errorMessage' => 'CreateInstance.Spec.NotSupport', - ], - [ - 'errorCode' => 'MissingParameterDiskSize', - 'errorMessage' => 'MissingParameterDiskSize', - ], - [ - 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', - 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', - ], - [ - 'errorCode' => 'CreateInstance.DeployType.InvalidValue', - 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', - ], - [ - 'errorCode' => 'AliyunInstance.NotExists', - 'errorMessage' => 'AliyunInstance.NotExists', - ], - ], - 500 => [ - [ - 'errorCode' => 'Instance.Order.CreateFailed', - 'errorMessage' => 'Instance.Order.CreateFailed', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', - 'title' => 'ModifyInstanceNodeNum', - ], - 'ModifyInstanceTemporaryCapacity' => [ - 'summary' => 'You can call this operation to modify the temporary capacity of the OceanBase cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'title' => '规格', - 'description' => 'Specification.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'oceanbase.cluster.i2.small', - ], - ], - [ - 'name' => 'DiskSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '磁盘大小，单位G', - 'description' => 'The disk size. Unit: GB.', - 'type' => 'string', - 'required' => false, - 'example' => '400', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'example' => 'zh-CN', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'Databases' => [ + 'description' => 'Database information.', + 'title' => 'Database Information', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Database ID', 'description' => 'The database ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Name' => ['title' => 'Database name', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Database mapping name', 'description' => 'The mapped database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'ClusterName' => ['title' => 'Mapping Object Cluster (deprecated)', 'description' => 'The mapped object cluster. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'TenantName' => ['title' => 'Mapping Object Tenant (deprecated)', 'description' => 'The mapped object tenant. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'Tables' => [ + 'description' => 'The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.', + 'title' => 'Transfer table object configuration under the current database. When mode is WILDCARD, this field specifies the exact blacklist or whitelist configuration, which is shared by tables and views.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'Table ID ', 'description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filter, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses extract, transform, and load (ETL) syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter Columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObkvPartitionConfig' => [ + 'description' => 'The partition configuration for Hbase mode. This is used only when migrating data to OBKV.', + 'title' => 'HBase pattern partition configuration, used only in migration to OBKV scenarios', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => ['KEY', 'RANGE', 'NONE'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'VirtualColumn' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionSize' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '1024', 'minimum' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Views' => [ + 'description' => 'The configuration for view objects to transfer in the current database.', + 'title' => 'Configuration of transfer view objects under the current database', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'View name', 'description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'View mapping name', 'description' => 'The mapped view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filter, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificTables' => [ + 'description' => 'The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.', + 'title' => 'Configuration for specific table objects (When mode is WILDCARD, this field specifies renaming and row filtering configurations for specific table objects)', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filter, extract, transform, and load (ETL) syntax ', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificViews' => [ + 'description' => 'The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.', + 'title' => 'Configuration of specific view objects (when mode is WILDCARD, this field specifies the renaming configuration for specific view objects)', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'View name', 'description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'View mapping name', 'description' => 'The mapped view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filter, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', - 'title' => 'ModifyInstanceTemporaryCapacity', - ], - 'SwitchoverInstance' => [ - 'summary' => 'You can call this operation to switch between the primary and standby instances of OceanBase.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '主备实例统一服务名', - 'description' => 'The instance ID of the primary/standby instance. You can set the default value to the instance ID of the instance to be switched to the primary instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TargetInstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '需要切换为主集群实例的实例ID', - 'description' => 'The instance ID of the instance to be switched to the primary instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob4bv8o7sp****', - ], - ], - [ - 'name' => 'Forced', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether to force the switchover.'."\n" - .'- true: Force the switchover.'."\n" - .'- false: Do not force the switchover.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '473469**-AA6F-4D**-B3DB-A***********', - ], - 'Data' => [ - 'description' => 'The list of data for the switchover.', - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => 'The message of the switchover.', - 'type' => 'string', - 'example' => 'delete tag-value success', + 'DatabasesBlack' => [ + 'description' => 'Matching rule mode: Database object blacklist.', + 'title' => 'Pattern matching mode: blacklist of database objects ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Name' => ['title' => 'Database Name ', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapped Database Name ', 'description' => 'The mapped database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'ClusterName' => ['title' => 'Cluster of the mapping object (deprecated)', 'description' => 'The mapped object cluster. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'TenantName' => ['title' => 'Tenant of the mapping object (deprecated)', 'description' => 'The mapped object tenant. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'Tables' => [ + 'description' => 'The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.', + 'title' => 'Transfer table object configuration under the current database (when mode is WILDCARD, this field specifies the exact blacklist or whitelist configuration; tables and views share the same setting)', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table Name ', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'Table ID', 'description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filter, using extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Views' => [ + 'description' => 'The configuration for view objects to transfer in the current database.', + 'title' => 'Configuration of transfer view objects under the current database ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'View name ', 'description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'View mapping name ', 'description' => 'The mapped view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'View ID ', 'description' => 'The view ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, using extract, transform, and load (ETL) syntax ', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificTables' => [ + 'description' => 'The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.', + 'title' => 'Specific table object configuration (when mode is WILDCARD, this field specifies renaming and row filtering configurations for specific table objects) ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'Table ID', 'description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information for the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificViews' => [ + 'description' => 'The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.', + 'title' => 'Configuration for specific view objects (when mode is WILDCARD, this field specifies the renaming configuration for specific view objects) ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'View ID ', 'description' => 'The view ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, extract, transform, and load (ETL) syntax ', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter Columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], ], - 'Success' => [ - 'description' => 'Whether the switchover is successful.'."\n" - .'- true: the switchover succeeded.'."\n" - .'- false: the switchover failed.', - 'type' => 'boolean', - 'example' => 'true', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'TableAndViewWhiteList' => [ + 'description' => 'Matching rule mode: Wildcard whitelist for tables and views.', + 'title' => 'Pattern matching mode: wildcard whitelist for tables and views ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'TableAndViewBlackList' => [ + 'description' => 'Matching rule mode: Wildcard blacklist for tables and views.', + 'title' => 'Pattern matching rule: wildcard blacklist for tables and views ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'WhiteTableRules' => [ + 'description' => 'Table whitelist rules.', + 'title' => 'Table whitelist rules', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'description' => 'Schema mapping.', + 'title' => 'schema mapping', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObjectMapping' => [ + 'description' => 'The object mapping under the schema.', + 'title' => 'Object mapping under the schema', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object name', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping object name', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"Data\\": {\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', - 'title' => 'SwitchoverInstance', - ], - 'RemoveStandbyInstance' => [ - 'summary' => 'You can call this operation to decouple a standby instance from its primary instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the primary instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob608fgj1q****', - ], - ], - [ - 'name' => 'TargetInstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the standby instance to be decoupled.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob4bv8o7sp****', - ], - ], - [ - 'name' => 'Forced', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to forcibly decouple the standby instance.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - ], - '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' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', - 'title' => 'RemoveStandbyInstance', - ], - 'DeleteInstances' => [ - 'summary' => 'You can call this operation to release an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'InstanceIds', - 'in' => 'formData', - 'schema' => [ - 'title' => '要删除的集群ID。格式为son数组的字符串。', - 'description' => 'The ID of the cluster to be deleted. '."\n" - .'The value is a string in the JSON format. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[”ob ob3f6yhv9uxxxx“]', - ], - ], - [ - 'name' => 'BackupRetainMode', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群删除后的备份保留策略。取值如下： - receive_all：保留全部备份集; - delete_all：删除全部备份集； - receive_last：保留最后一个备份集。 默认值为delete_all。', - 'description' => 'The backup retention strategy for cluster deletion. Valid values: '."\n" - .'- receive_all: retains all backup sets. '."\n" - .'- delete_all: deletes all backup sets. '."\n" - .'- receive_last: retains the last backup set. '."\n" - ."\n" - .'>
Default value: delete_all. ', - 'type' => 'string', - 'required' => false, - 'example' => 'delete_all', - ], - ], - [ - 'name' => 'DryRun', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" - .'true：发送检查请求，不会删除实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" - .'false（默认）：发送正常请求，通过检查后直接删除实例。', - 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" - .'- true: Only a dry-run request is sent and the instance is not deleted. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" - .'- false: The actual request is sent and no dry run is performed. The instance is deleted if the requirements are met. By default, false is returned for the parameter DryRunResult if you set DryRun to false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '473469C7-****-****-B3DB-A3DC0DE3C83E', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'DryRunResult' => [ - 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', - 'description' => 'The result of the dry-run request.'."\n" - .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" - .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', - 'type' => 'boolean', - 'example' => 'false', + 'WhiteViewRules' => [ + 'description' => 'View whitelist rules.', + 'title' => 'View whitelist rules', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'description' => 'Schema mapping.', + 'title' => 'Schema mapping ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObjectMapping' => [ + 'description' => 'The object mapping under the schema.', + 'title' => 'Object mapping under schema', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'BadRequest', - ], - ], - 404 => [ - [ - 'errorCode' => 'InstanceStatus.Invalid', - 'errorMessage' => 'InstanceStatus.Invalid', - ], - [ - 'errorCode' => 'StandbyInstance.StillOnline', - 'errorMessage' => 'StandbyInstance.StillOnline', - ], - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'UnknownError', - ], - [ - 'errorCode' => 'Tenant.StillOnline', - 'errorMessage' => 'Tenant.StillOnline', - ], - [ - 'errorCode' => 'ServiceTemporarilyUnavailable', - 'errorMessage' => 'ServiceTemporarilyUnavailable', - ], - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'NotFound', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'InternalServerError', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DryRunResult\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"65BDA532-28AF-4122-AA39-B382721EEE64","errorExample":""}]', - 'title' => 'DeleteInstances', - 'description' => 'Before you call this operation, ensure that the following requirements are met:'."\n" - .'- The cluster is in the Running state.'."\n" - .'- The cluster is a primary cluster and the billing method is pay-as-you-go. ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeInstanceSummary' => [ - 'summary' => 'Obtains the overview information about OceanBase instances.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows to return on each page.'."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'InstanceSummary' => [ - 'description' => 'The overview information about OceanBase instances.', - 'type' => 'object', - 'properties' => [ - 'TotalInstancesCount' => [ - 'description' => 'The total number of instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'OverLoadInstancesCount' => [ - 'description' => 'The number of overloaded instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ImmediatelyExpiredInstancesCount' => [ - 'description' => 'The total number of expired instances to be released.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RunningInstancesCount' => [ - 'description' => 'The number of running instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InsufficientDiskInstancesCount' => [ - 'description' => 'The total number of clusters with capacity risks.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ExpiredInstancesCount' => [ - 'description' => 'The number of expired instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlarmSummaryCount' => [ - 'description' => 'The total number of alerts during the query period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AnomalySQLCount' => [ - 'description' => 'The total number of abnormal SQL statements.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ClusterInstancesCount' => [ - 'title' => '集群实例数量', - 'description' => 'The number of cluster instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TenantInstancesCount' => [ - 'title' => '租户实例数量', - 'description' => 'The number of tenant instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalOmsInstancesCount' => [ - 'description' => 'The number of data transmission instances.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RegionalInstanceSummaryList' => [ - 'description' => 'A list of regional instances.', - 'type' => 'array', - 'items' => [ + 'BlackTableRules' => [ + 'description' => 'Table blacklist rules.', + 'title' => 'Table Blacklist Rules ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'description' => 'Schema mapping.', + 'title' => 'Schema mapping ', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'TotalInstancesCount' => [ - 'description' => 'The total number of instances.', - 'type' => 'integer', - 'example' => '3', - 'format' => 'int64', - ], - 'ImmediatelyExpiredInstancesCount' => [ - 'description' => 'The number of instances about to expire.', - 'type' => 'integer', - 'example' => '1', - 'format' => 'int64', - ], - 'RunningInstancesCount' => [ - 'description' => 'The total number of running instances.', - 'type' => 'integer', - 'example' => '1', - 'format' => 'int64', - ], - 'ExpiredInstancesCount' => [ - 'description' => 'The number of expired instances.', - 'type' => 'integer', - 'example' => '1', - 'format' => 'int64', - ], - 'RecentCreatedInstancesCount' => [ - 'description' => 'The number of recently created instances.', - 'type' => 'integer', - 'example' => '1', - 'format' => 'int64', - ], + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObjectMapping' => [ + 'description' => 'The object mapping under the schema.', + 'title' => 'Object Mapping Under Schema ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapped Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - ], - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"InstanceSummary\\": {\\n \\"TotalInstancesCount\\": 3,\\n \\"OverLoadInstancesCount\\": 1,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"InsufficientDiskInstancesCount\\": 2,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"AlarmSummaryCount\\": 1,\\n \\"AnomalySQLCount\\": 1,\\n \\"ClusterInstancesCount\\": 1,\\n \\"TenantInstancesCount\\": 1,\\n \\"TotalOmsInstancesCount\\": 1,\\n \\"RegionalInstanceSummaryList\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"TotalInstancesCount\\": 3,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"RecentCreatedInstancesCount\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeInstanceSummary', - ], - 'DescribeStandbyCreateMode' => [ - 'summary' => 'DescribeStandbyCreateMode', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群ID', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob4wib********', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 'txxxxxxx', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'BlackViewRules' => [ + 'description' => 'View blacklist rules.', + 'title' => 'View blacklist rules ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'description' => 'Schema mapping.', + 'title' => 'Schema mapping ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObjectMapping' => [ + 'description' => 'The object mapping under the schema.', + 'title' => 'Object mapping under the schema ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Object Name ', 'description' => 'The object name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Mapping Object Name ', 'description' => 'The mapped object name.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'CreateMode' => [ - 'title' => '创建模式', - 'description' => 'The creation mode. Enumerated values: * DIRECT_CREATE: indicates that the standby cluster was created empty. * BACKUP_RESTORE: indicates that the standby cluster was created by using the backup and restore feature.', - 'type' => 'string', - 'enumValueTitles' => [ - 'DIRECT_CREATE' => '', - 'BACKUP_RESTORE' => '', + 'Schemas' => [ + 'description' => 'Precise database and table object settings.', + 'title' => 'Exact schema and table object settings ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Database ID', 'description' => 'The database ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Name' => ['title' => 'Database name', 'description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Database mapping name', 'description' => 'The mapped database name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'ClusterName' => ['title' => 'Mapping Object cluster (deprecated) ', 'description' => 'The mapped object cluster. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'TenantName' => ['title' => 'Mapping Object tenant (deprecated) ', 'description' => 'The mapped object tenant. (Deprecated)', 'type' => 'string', 'required' => false, 'example' => ''], + 'Tables' => [ + 'description' => 'The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.', + 'title' => 'Configuration of transfer table objects under the current database (when mode is WILDCARD, this field specifies the exact blacklist or whitelist configuration, shared by tables and views) ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['title' => 'Table ID ', 'description' => 'The table ID.', 'type' => 'string', 'required' => false, 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, ETL syntax ', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information for the ADB data source ', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'ObkvPartitionConfig' => [ + 'description' => 'The partition configuration for Hbase mode. This is used only when migrating data to OBKV.', + 'title' => 'HBase pattern partition configuration, used only in OBKV migration scenarios', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => ['KEY', 'RANGE', 'NONE'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'VirtualColumn' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionSize' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '1024', 'minimum' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], - 'example' => 'BACKUP_RESTORE', - 'enum' => [ - 'BACKUP_RE', - 'STORE/DIRE', - 'CT_CREATE', + 'Views' => [ + 'description' => 'The configuration for view objects to transfer in the current database.', + 'title' => 'Configuration of transfer view objects under the current database ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'View name', 'description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'View mapping name', 'description' => 'The mapped view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, extract, transform, and load (ETL) syntax ', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificTables' => [ + 'description' => 'The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.', + 'title' => 'Specific table object configuration (when mode is WILDCARD, this field specifies renaming and row filtering configuration for specific table objects)', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Table name ', 'description' => 'The table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'Table mapping name', 'description' => 'The mapped table name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. Uses ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SpecificViews' => [ + 'description' => 'The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.', + 'title' => 'Configuration of specific view objects (when mode is WILDCARD, this field specifies the renaming configuration for specific view objects)', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'View name ', 'description' => 'The view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'MappedName' => ['title' => 'View mapping name', 'description' => 'The mapped view name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'WhereClause' => ['title' => 'Row filtering, extract, transform, and load (ETL) syntax', 'description' => 'Row filtering. ETL syntax.', 'type' => 'string', 'required' => false, 'example' => ''], + 'FilterColumns' => [ + 'description' => 'The columns to filter.', + 'title' => 'Filter columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding columns.', + 'title' => 'Shard columns', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information for the ADB data source.', + 'title' => 'Mapping information of the ADB data source', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'PartitionLifeCycle' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"CreateMode\\": \\"BACKUP_RESTORE\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeStandbyCreateMode', - ], - 'DescribeTenantReadableScn' => [ - 'summary' => 'You can call this operation to query the maximum readable timestamp of a tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户id', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => true, - 'example' => 't33h8y08k****', + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '8442BB1E-3171-1192-B9DC-F6F4E53B2673', - ], - 'Data' => [ - 'description' => 'The data in the return result of the request.', + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', 'type' => 'object', 'properties' => [ - 'ReadableScn' => [ - 'description' => 'The maximum readable timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1715329164977', + 'Code' => ['description' => 'The error code (old).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error description (old).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in MessageMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in MessageMcmsKey.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the cause of the error.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested solution (new).', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the suggested solution.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details, used for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggested solution.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This is effective for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. This is effective for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count. This is effective for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '28'], + 'Data' => ['description' => 'The ID of the modification record returned by the request.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '4'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": 4\\n}","type":"json"}]', + 'title' => 'Modify transfer object', + 'changeSet' => [ + ['createdAt' => '2025-04-01T06:46:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-17T02:36:05.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8442BB1E-3171-1192-B9DC-F6F4E53B2673\\",\\n \\"Data\\": {\\n \\"ReadableScn\\": 1715329164977\\n }\\n}","type":"json"}]', - 'title' => 'DescribeTenantReadableScn', + 'ramActions' => [], ], - 'CreateTenant' => [ - 'summary' => 'You can call this operation to create a tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateRdsPostgreSQLDataSource' => [ + 'summary' => 'Use this API to create an RDS PostgreSQL data source.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TenantName', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', - 'description' => 'The name of the tenant. '."\n" - .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_online', - ], - ], - [ - 'name' => 'Cpu', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户的CPU大小，单位：核数（Cores）', - 'description' => 'The number of CPU cores of the tenant. '."\n" - ."\n" - .'>
The CPU specification of a single tenant cannot exceed that of the corresponding cluster.
For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the CPU specification of the tenant cannot exceed 14 cores. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'Memory', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户内存大小，单位GB。', - 'description' => 'The memory size of the tenant, in GB. '."\n" - ."\n" - .'>
The memory size of a single tenant cannot exceed that of the corresponding cluster.
For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the memory size of the tenant cannot exceed 70 GB. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'TimeZone', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', - 'description' => 'The time zone of the tenant. For more information, see [DescribeTimeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describetimezones).', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Asia/Shanghai', - ], - ], - [ - 'name' => 'TenantMode', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户模式。 当前支持Oracle模式（Oracle）、MySQL模式（MySQL） 详细参见：DescribeInstanceTenantModes。', - 'description' => 'The tenant mode. '."\n" - .'Valid values: Oracle and MySQL. '."\n" - .'For more information, see [DescribeInstanceTenantModes](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describeinstancetenantmodes).', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Oracle', - ], - ], - [ - 'name' => 'Charset', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '字符集。 详细参见：DescribeCharset。', - 'description' => 'The character set. '."\n" - .'For more information, see [DescribeCharset](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describecharset).', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'utf8mb4', - ], + 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'example' => 'data_name'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'g_abcdefj***'."\n"], ], [ - 'name' => 'UserVpcId', + 'name' => 'DatabaseName', 'in' => 'formData', - 'schema' => [ - 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', - 'description' => 'The ID of the VPC. '."\n" - .' If no suitable VPC is available, create a VPC as prompted. '."\n" - .'For more information, see "What is a VPC". ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], + 'schema' => ['title' => 'Database Name', 'description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'db_name'], ], [ - 'name' => 'UserVSwitchId', + 'name' => 'UserName', 'in' => 'formData', - 'schema' => [ - 'title' => '虚拟交换机（VSwitch） ID。 如果没有合适的 VSwitch，请根据页面提示创建一个，详情参见 使用交换机。', - 'description' => 'The ID of the vSwitch. '."\n" - .'If no suitable vSwitch is available, create a vSwitch as prompted. '."\n" - .'For more information, see Use a vSwitch. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vsw-bp11k1aypnzu1l3whi****', - ], + 'schema' => ['description' => 'The name of the database user.', 'type' => 'string', 'required' => true, 'example' => 'user_name', 'title' => ''], ], [ - 'name' => 'PrimaryZone', + 'name' => 'Password', 'in' => 'formData', - 'schema' => [ - 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', - 'description' => 'The primary zone of the tenant. '."\n" - .'It is one of the zones in which the cluster is deployed. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => 'The Base64-encoded password for the database user.', 'type' => 'string', 'required' => true, 'example' => 'cGFzc193b3JK', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', + 'schema' => ['description' => 'The description for the data source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a test database'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户描述信息。', - 'description' => 'The description of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test database', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The details of the error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Populates placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Populates placeholders in the `Message` parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The error message key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Populates placeholders in the `MessageMcmsKey` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Populates placeholders in the `MessageMcmsKey` parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The error reason key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The error reason context.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The error reason context.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'A suggestion for resolving the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The suggestion key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The suggestion context.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The suggestion context.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'A suggestion for resolving the error.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. Returned only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. Returned only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. Returned only for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The duration of the request in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => ['description' => 'The ID of the data source.', 'type' => 'string', 'title' => '', 'example' => 'e_5anwndq'], + ], + 'example' => '', ], ], - [ - 'name' => 'UnitNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', - 'description' => 'The number of resource distribution nodes in the tenant. '."\n" - .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'default' => '1', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"e_5anwndq\\"\\n}","type":"json"}]', + 'title' => 'Create an RDS PostgreSQL Data Source', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateRdsPostgreSQLDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateSecurityIpGroup' => [ + 'summary' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ReadOnlyZoneList', - 'in' => 'formData', - 'schema' => [ - 'title' => 'ReadOnlyZoneList 即将下线，请勿使用，引导用户使用 ModifyTenantReadonlyReplica', - 'description' => 'Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).'."\n" - .'>
At present, this parameter is unavailable.>', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'LogDisk', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '日志盘大小', - 'description' => 'The size of the log disk allocated to the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '128', - ], + 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'CreateParams', + 'name' => 'SecurityIps', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '创建租户时，初始化参数', - 'description' => 'The initialization parameters.', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'title' => '', - 'description' => 'The initialization parameters.', - 'type' => 'string', - 'example' => '{\\"LOWER_CASE_TABLE_NAMES\\":\\"1\\"}', - ], - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The return result of the request. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["192.168.1.1","192.168.0.0.1/8"]'], ], [ - 'name' => 'UserVpcOwnerId', + 'name' => 'SecurityIpGroupName', 'in' => 'formData', - 'schema' => [ - 'title' => '用户vpc的ownerId', - 'description' => 'The ID of the VPC owner.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-********', - ], + 'schema' => ['title' => 'The IP addresses or CIDR blocks in the IP address whitelist group. '."\n" + .'It is a JSON array. Each object in the array is an IP address or CIDR block. The following two formats are supported: '."\n" + .'- IP address: for example, 10.23.12.24. '."\n" + .'- CIDR block: for example, 10.23.12.24/24, where 24 indicates the length of the prefix in the IP address, and the prefix is 1 to 30 characters in length. Limit: You can set no more than 40 IP addresses or CIDR blocks for a whitelist group. A total of 200 IP addresses or CIDR blocks are supported for all whitelist groups. ', 'description' => 'The name of the whitelist group. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_online'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', + 'title' => 'The information of the whitelist group. ', + 'description' => 'The ID of the region. ', 'type' => 'object', 'properties' => [ - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'RequestId' => ['title' => 'The name of the whitelist group. ', 'description' => 'The IP addresses or CIDR blocks in the IP address whitelist group. '."\n" + .'The return values of SecurityIps are strings that are separated with commas (,). ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => 'The request ID. ', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **CreateSecurityIpGroup**. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => 'Example 1', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=CreateSecurityIpGroup'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&SecurityIps=192.168.1.1,192.168.0.0.1/8'."\n" + .'&SecurityIpGroupName=pay_online'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'SecurityIpGroupName' => ['title' => ' ', 'description' => 'You can call this operation to create an IP address whitelist group. ', 'type' => 'string', 'example' => 'pay_online'], + 'SecurityIps' => ['title' => ' ', 'description' => 'IP addresses or segments in the IP address whitelist group. '."\n" + .'The return value SecurityIps is a comma-separated string.', 'type' => 'string', 'example' => '["192.***.1.1"]'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"pay_online\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a whitelist group', + 'changeSet' => [ + ['createdAt' => '2022-01-17T13:06:05.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', - 'title' => 'CreateTenant', ], - 'CreateTenantReadOnlyConnection' => [ - 'summary' => 'You can call this operation to create a read-only address for a specified tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTag' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6275,583 +4220,438 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'formData', + 'schema' => ['description' => 'The identifier of the client.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The tag group creation result.', 'type' => 'string', 'example' => 'Create tag success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Create tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'CreateTag', + 'summary' => 'You can call this operation to create a tag group.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateTagValue' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ZoneId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'Value', 'in' => 'formData', - 'schema' => [ - 'title' => '可用区的ZoneId。 详细参见DescribeInstance中的AvailableZones。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou-i', - ], + 'schema' => ['description' => 'The name of the tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签 1', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'title' => '专有网络（VPC） ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'title' => '虚拟交换机（VSwitch）ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vsw-bp11k1aypnzu1l3whi****', - ], + 'schema' => ['description' => 'The identifier of the client.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], + 'Message' => ['description' => 'The tag creation result.', 'type' => 'string', 'example' => 'create tag value success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"create tag value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'CreateTagValue', + 'summary' => 'You can call this operation to create a tag.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTagValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'CreateTenantReadOnlyConnection', ], - 'CreateTenantSecurityIpGroup' => [ - 'summary' => 'You can call this operation to create the security whitelist for the tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTenant' => [ + 'summary' => 'You can call this operation to create a tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the tenant. It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', 'description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_online'], + ], + [ + 'name' => 'Cpu', + 'in' => 'formData', + 'schema' => ['title' => 'The number of CPU cores of the tenant.', 'description' => 'The number of CPU cores of the tenant. '."\n" + ."\n" + .'>
The CPU specification of a single tenant cannot exceed that of the corresponding cluster.
For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the CPU specification of the tenant cannot exceed 14 cores. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => ['title' => 'The memory size of the tenant, in GB. ', 'description' => 'The memory size of the tenant, in GB. '."\n" + ."\n" + .'>
The memory size of a single tenant cannot exceed that of the corresponding cluster.
For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the memory size of the tenant cannot exceed 70 GB. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'TimeZone', + 'in' => 'formData', + 'schema' => ['title' => 'The time zone of the tenant. For more information, see DescribeTimeZones. ', 'description' => 'The time zone of the tenant. For more information, see [DescribeTimeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describetimezones).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Asia/Shanghai'], + ], + [ + 'name' => 'TenantMode', + 'in' => 'formData', + 'schema' => ['title' => 'The tenant mode. Valid values: Oracle and MySQL. For more information, see DescribeInstanceTenantModes. ', 'description' => 'The tenant mode. '."\n" + .'Valid values: Oracle and MySQL. '."\n" + .'For more information, see [DescribeInstanceTenantModes](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describeinstancetenantmodes).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Oracle'], + ], + [ + 'name' => 'Charset', + 'in' => 'formData', + 'schema' => ['title' => 'The character set. For more information, see DescribeCharset. ', 'description' => 'The character set. '."\n" + .'For more information, see [DescribeCharset](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describecharset).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'utf8mb4'], + ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'TenantId', + 'name' => 'UserVpcId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['title' => 'The ID of the VPC. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC".', 'description' => 'The ID of the VPC. '."\n" + .' If no suitable VPC is available, create a VPC as prompted. '."\n" + .'For more information, see "What is a VPC". ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], ], [ - 'name' => 'SecurityIpGroupName', + 'name' => 'UserVSwitchId', 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The group name of the whitelist group of IP addresses.'."\n" - ."\n" - .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'paytest', - ], + 'schema' => ['title' => 'The ID of the vSwitch. If no suitable vSwitch is available, create a vSwitch as prompted. For more information, see Use a vSwitch. ', 'description' => 'The ID of the vSwitch. '."\n" + .'If no suitable vSwitch is available, create a vSwitch as prompted. '."\n" + .'For more information, see Use a vSwitch. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp11k1aypnzu1l3whi****'], ], [ - 'name' => 'SecurityIps', + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => ['title' => 'The primary zone of the tenant. It is one of the zones in which the cluster is deployed. ', 'description' => 'The primary zone of the tenant. '."\n" + .'It is one of the zones in which the cluster is deployed. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => 'The description of the tenant. ', 'description' => 'The description of the database. ', 'type' => 'string', 'required' => false, 'example' => 'this is a test database'], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => ['title' => 'The number of resource distribution nodes in the tenant. The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', 'description' => 'The number of resource distribution nodes in the tenant. '."\n" + .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1'], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => ['title' => '创建只读副本的可用区，当传入多个可用区的时候，以逗号分隔', 'description' => 'Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).'."\n" + .'>
At present, this parameter is unavailable.>', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro'], + ], + [ + 'name' => 'LogDisk', + 'in' => 'formData', + 'schema' => ['title' => '日志盘大小', 'description' => 'The size of the log disk allocated to the tenant, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '128'], + ], + [ + 'name' => 'CreateParams', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', - 'description' => 'The list of IP addresses in the whitelist group.'."\n" - ."\n" - .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', - 'type' => 'string', - 'required' => true, - 'example' => '192.***.*.*"', + 'title' => '创建租户时，初始化参数', + 'description' => 'The initialization parameters.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '', 'description' => 'The initialization parameters.', 'type' => 'string', 'example' => '{\\"LOWER_CASE_TABLE_NAMES\\":\\"1\\"}'], + 'example' => '', ], ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => ['title' => '用户vpc的ownerId', 'description' => 'The ID of the VPC owner.', 'type' => 'string', 'required' => false, 'example' => 'vpc-********'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned result of the request.', + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => '白名单分组信息。', - 'description' => 'The information of the whitelist group. ', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - 'SecurityIpGroupName' => [ - 'title' => '安全白名单分组名称。', - 'description' => 'The name of the whitelist group. ', - 'type' => 'string', - 'example' => 'paytest', - ], - 'SecurityIps' => [ - 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', - 'description' => 'The list of IP addresses in the IP address whitelist group. '."\n" - ."\n" - .'It is a string separated by commas, and each object is an IP address or CIDR block.', - 'type' => 'string', - 'example' => '192.***.*.*', - ], - ], - ], + 'TenantId' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't33h8y08k****'], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateTenantSecurityIpGroup', - ], - 'DescribeTenants' => [ - 'summary' => 'You can call this operation to query the tenants in an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'CreateTenant', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenant', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateTenantReadOnlyConnection' => [ + 'summary' => 'You can call this operation to create a read-only address for a specified tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantName', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', - 'description' => 'The name of the tenant. '."\n" - .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', - 'type' => 'string', - 'required' => false, - 'example' => 'pay_online', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'PageNumber', + 'name' => 'ZoneId', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page to return. '."\n" - .'Start value: 1'."\n" - .'- Default value: 1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'Zone ID of the zone.'."\n" + .'For details, see AvailableZones in DescribeInstance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-i'], ], [ - 'name' => 'TenantId', + 'name' => 'VpcId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['description' => 'Virtual private cloud (VPC) ID.', 'title' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], ], [ - 'name' => 'SearchKey', + 'name' => 'VSwitchId', 'in' => 'formData', - 'schema' => [ - 'title' => '查询列表的删选关键字。', - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'pay', - ], + 'schema' => ['description' => 'Virtual switch (vSwitch) ID.', 'title' => 'Virtual switch (vSwitch) ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp11k1aypnzu1l3whi****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', + 'title' => '', + 'description' => 'Return Result of the request.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '查询到的指定Oceanbase集群的租户总数。', - 'description' => 'The total number of tenants in the specified OceanBase cluster. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Tenants' => [ - 'title' => '租户的列表信息。', - 'description' => 'The information of tenants. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The information of tenants. ', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', - 'description' => 'The ID of the VPC.
If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC". ', - 'type' => 'string', - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], - 'Status' => [ - 'title' => '租户的状态。 PENDING_CREATE: 创建中 RESTORE: 恢复中 ONLINE: 运行中 SPEC_MODIFYING: 规格修改中 ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 PRIMARY_ZONE_MODIFYING: 切主可用区中 PARAMETER_MODIFYING: 参数修改中 WHITE_LIST_MODIFING: 白名单修改中', - 'description' => 'The status of the tenant.
'."\n" - .'- PENDING_CREATE: The tenant is being created.'."\n" - .'- RESTORE: The tenant is being recovered.'."\n" - .'- ONLINE: The tenant is running.'."\n" - .'- SPEC_MODIFYING: The specification of the tenant is being modified.'."\n" - .'ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated.'."\n" - .'PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled.'."\n" - .'- PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone.'."\n" - .'- PARAMETER_MODIFYING: Parameters are being modified.'."\n" - .'- WHITE_LIST_MODIFYING: The whitelist is being modified.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'PrimaryZone' => [ - 'title' => '租户的主可用区。', - 'description' => 'The primary zone of the tenant. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'DeployType' => [ - 'title' => '租户的部署类型。 multiple：多机房 single：单机房 dual：双机房', - 'description' => 'The deployment type of the tenant.
'."\n" - .'- multiple: multi-IDC deployment'."\n" - .'- single: single-IDC deployment'."\n" - .'- dual: dual-IDC deployment', - 'type' => 'string', - 'example' => 'multiple', - ], - 'DeployMode' => [ - 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', - 'description' => 'The data replica distribution mode of the tenant. '."\n" - ."\n" - .'- For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode.'."\n" - .'- For the basic version, N indicates the single-zone mode. '."\n" - ."\n" - .'>
N represents the number of nodes in a single zone. ', - 'type' => 'string', - 'example' => '1-1-1', - ], - 'CreateTime' => [ - 'title' => '租户的创建时间。', - 'description' => 'The time when the tenant was created. ', - 'type' => 'string', - 'example' => '2021-09-17 15:52:17.0', - ], - 'TenantName' => [ - 'title' => '租户名称。', - 'description' => 'The name of the tenant. ', - 'type' => 'string', - 'example' => 'pay_online', - ], - 'Mem' => [ - 'title' => '租户总的内存大小，单位：GB。', - 'description' => 'The total memory size of the tenant, in GB. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Cpu' => [ - 'title' => '租户总的CPU核数，单位：Core。', - 'description' => 'The total number of CPU cores of the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Description' => [ - 'title' => '租户描述信息。', - 'description' => 'The description of the tenant. ', - 'type' => 'string', - 'example' => 'PayCore business database', - ], - 'TenantMode' => [ - 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', - 'description' => 'The tenant mode. '."\n" - .'Valid values: '."\n" - .'Oracle'."\n" - .'MySQL ', - 'type' => 'string', - 'example' => 'Oracle', - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'UnitCpu' => [ - 'title' => '租户每个Unit的CPU核数，单位：Core。', - 'description' => 'The number of CPU cores in each resource unit of the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'UnitMem' => [ - 'title' => '租户每个Unit的内存大小，单位：GB。', - 'description' => 'The memory size of each resource unit of the tenant, in GB. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'UnitNum' => [ - 'title' => '租户的unit个数。', - 'description' => 'The number of resource units in the tenant.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UsedDiskSize' => [ - 'title' => '租户已使用磁盘量', - 'description' => 'The number of used disks of the tenant. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Charset' => [ - 'title' => '字符集', - 'description' => 'The character set.', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'Collation' => [ - 'title' => '字符序', - 'description' => 'The collation.', - 'type' => 'string', - 'example' => 'utf8mb4_general_ci', - ], - 'EnableReadOnlyReplica' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether read-only replicas are supported.', - 'example' => 'true ', - ], - 'ParameterTemplate' => [ - 'title' => '参数模板', - 'description' => 'The parameter template.', - 'type' => 'string', - 'example' => 'express_oltp', - ], - 'Iops' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Tenants\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-i\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CreateTime\\": \\"2021-09-17 15:52:17.0\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"Mem\\": 20,\\n \\"Cpu\\": 10,\\n \\"Description\\": \\"paycore database\\",\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UnitCpu\\": 5,\\n \\"UnitMem\\": 10,\\n \\"UnitNum\\": 2,\\n \\"UsedDiskSize\\": 10,\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"Collation\\": \\"utf8mb4_general_ci\\",\\n \\"EnableReadOnlyReplica\\": true,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n vpc-bp1d2q3mhg9i23ofi****\\n ONLINE\\n cn-hangzhou-i\\n multiple\\n 1-1-1\\n 2021-09-17 15:52:17.0\\n pay_online\\n 20\\n 10\\n paycore业务数据库\\n Oracle\\n t33h8y08k****\\n 5\\n 10\\n 2\\n 10\\n \\n","errorExample":""}]', - 'title' => 'DescribeTenants', - ], - 'DescribeInstanceTenantModes' => [ - 'summary' => 'You can call this operation to query the modes of tenants. ', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Creation of a Read-Only Endpoint', + 'changeSet' => [ + ['createdAt' => '2023-07-04T02:52:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-05T07:31:15.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantReadOnlyConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateTenantSecurityIpGroup' => [ + 'summary' => 'You can call this operation to create the security whitelist for the tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeInstanceTenantModes**. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****'], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'paytest'], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The list of IP addresses in the whitelist group.'."\n" + ."\n" + .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', 'type' => 'string', 'required' => true, 'example' => '["192.***.*.*"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'Example 1', + 'title' => '', + 'description' => 'The returned result of the request.', 'type' => 'object', 'properties' => [ - 'InstanceModes' => [ - 'title' => '租户模式列表。Oracle，Mysql', - 'description' => ' ', - 'type' => 'array', - 'items' => [ - 'description' => 'You can call this operation to query the modes of tenants. ', - 'type' => 'string', - 'enumValueTitles' => [ - 'MySQL' => 'MySQL', - 'Oracle' => 'Oracle', - ], - 'example' => 'Oracle', + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => '', + 'description' => 'The information of the whitelist group. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4louaeei****'], + 'SecurityIpGroupName' => ['title' => '', 'description' => 'The name of the whitelist group. ', 'type' => 'string', 'example' => 'paytest'], + 'SecurityIps' => ['title' => '', 'description' => 'The list of IP addresses in the IP address whitelist group. '."\n" + ."\n" + .'It is a string separated by commas, and each object is an IP address or CIDR block.', 'type' => 'string', 'example' => '["192.***.*.*"]'], ], - 'enumValueTitles' => [], - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceModes\\": [\\n \\"Oracle\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Oracle\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeInstanceTenantModes', - ], - 'DescribeTenant' => [ - 'summary' => 'You can call this operation to query the information of a specific tenant in a specific cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateTenantSecurityIpGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateTenantUser' => [ + 'summary' => 'Creates a database account under a specified tenant.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6859,1655 +4659,864 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'TenantId', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the database account. '."\n" + .'Certain reserved keywords such as SYS and root cannot be used.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The type of the user. Valid values: '."\n" + ."\n" + .'- Normal: standard account.'."\n" + .'- Admin: superuser account.'."\n" + .'- ReadonlyAccount: read-only account. Only MySQL tenants support read-only accounts.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Normal'], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The password of the database account.'."\n" + ."\n" + .'>
The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password must be 10 to 32 characters in length. Special characters include: !@#$%^\\*()_+-=.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '!Aliyun4Oceanbase'], + ], + [ + 'name' => 'Roles', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The role information of the user. '."\n" + .'For standard users, specify the account information as a JSON-formatted character string. The value is an array that contains Database (MySQL pattern) information and role information (Role). Roles include the following types: '."\n" + .' - Read and write permission (ReadWrite): ALL PRIVILEGES.'."\n" + .' - Read-only permission (ReadOnly): SELECT.'."\n" + .' - DDL permission (DDL): CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW.'."\n" + .'- DML permission: SELECT, INSERT, UPDATE, DELETE, SHOW VIEW.'."\n" + .'- DML permission (DML): SELECT, INSERT, UPDATE, DELETE, SHOW VIEW.'."\n" + ."\n" + .'>
  • Oracle pattern: leave this parameter empty.
  • MySQL pattern: the superuser account has ALL PRIVILEGES by default. Leave this parameter empty.
', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'example' => 'this is a test database'], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The encryption method.', 'type' => 'string', 'example' => 'RAS', 'required' => false], + ], + [ + 'name' => 'GlobalPermissions', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The global permission information.', 'type' => 'string', 'example' => 'Encrypt,Decrypt', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TenantUser' => [ + 'description' => 'The list of database accounts in the tenant.', + 'type' => 'object', + 'properties' => [ + 'UserType' => ['description' => 'The type of the user. Valid values:'."\n" + .'- Normal: standard account.'."\n" + .'- Admin: superuser account.'."\n" + .'- ReadonlyAccount: read-only account. Only MySQL tenants support read-only accounts.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Roles' => [ + 'title' => '', + 'description' => 'The role permission information of the account.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'example' => 'db_pay1'], + 'Role' => ['title' => '', 'description' => 'The role that is granted. '."\n" + .'- Oracle mode: roles are at the schema level and include the following types: '."\n" + .' - ReadWrite: read and write permissions, including CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, DROP PROFILE.'."\n" + .' - ReadOnly: read-only permissions, SELECT.'."\n" + .'- MySQL mode: roles are at the database level and include the following types:'."\n" + .' - ReadWrite: read and write permissions, including ALL PRIVILEGES.'."\n" + .' - ReadOnly: read-only permissions, including SELECT.'."\n" + .' - DDL: DDL permissions, including CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW.'."\n" + .' - DML: DML permissions, including SELECT, INSERT, UPDATE, DELETE, SHOW VIEW.'."\n" + .'> Oracle accounts have default read and write permissions on their own schemas. These permissions are not listed here.', 'type' => 'string', 'example' => 'ReadOnly'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'UserStatus' => ['title' => '', 'description' => 'The status of the database account. Valid values:'."\n" + .'- LOCKED: locked.'."\n" + .'- ONLINE: unlocked.'."\n" + .'> The default status of a newly created account is ONLINE.', 'type' => 'string', 'example' => 'ONLINE'], + 'UserName' => ['title' => '', 'description' => 'The name of the database account.', 'type' => 'string', 'example' => 'pay_test'], + 'GlobalPermissions' => ['title' => '', 'description' => 'The global permissions.', 'type' => 'string', 'example' => 'Encrypt,Decrypt'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantUser\\": {\\n \\"UserType\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a tenant user', + 'requestParamsDescription' => 'For a list of request endpoints, refer to API Reference > Calling Methods.', + 'changeSet' => [ + ['createdAt' => '2025-02-13T13:01:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-04T02:53:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-04-06T10:07:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-06-23T03:12:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-23T03:12:17.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'DeleteDataSource' => [ + 'summary' => 'Deletes a data source.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e_5anwndq'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => ' The details of the tenant. ', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response payload.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Tenant' => [ - 'title' => '租户信息。', - 'description' => 'The information about the tenant.', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Contains error details.', 'type' => 'object', 'properties' => [ - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - 'TenantName' => [ - 'title' => '租户名称。', - 'description' => 'The name of the tenant. ', - 'type' => 'string', - 'example' => 'forMySQLTenant', - ], - 'TenantMode' => [ - 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', - 'description' => 'The mode of the tenant.'."\n" - .'Valid values:'."\n" - .'- Oracle '."\n" - .'- MySQL', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'VpcId' => [ - 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', - 'description' => 'The Virtual Private Cloud (VPC) ID of the tenant. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC".', - 'type' => 'string', - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], - 'Status' => [ - 'title' => '租户的状态。 PENDING_CREATE: 创建中 RESTORE: 恢复中 ONLINE: 运行中 SPEC_MODIFYING: 规格修改中 ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 PRIMARY_ZONE_MODIFYING: 切主可用区中 PARAMETER_MODIFYING: 参数修改中 WHITE_LIST_MODIFING: 白名单修改中', - 'description' => 'The status of the tenant.'."\n" - ."\n" - .'- ONLINE: The tenant is running.'."\n" - ."\n" - .'- PENDING_CREATE: The tenant is being created.'."\n" - ."\n" - .'- WAITING_ALLOCATE_MASTER_ADDRESS: The standby cluster is waiting for the primary address to be created.'."\n" - ."\n" - .'- ALLOCATING_MASTER_ADDRESS: The primary address is being created.'."\n" - ."\n" - .'- DELETING_MASTER_ADDRESS: The primary address is being deleted.'."\n" - ."\n" - .'- ALLOCATING_INTERNET_ADDRESS: The Internet address is being created.'."\n" - ."\n" - .'- PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being deleted.'."\n" - ."\n" - .'- ALLOCATING_READONLY_ADDRESS: The read-only address is being created.'."\n" - ."\n" - .'- DELETING_READONLY_ADDRESS: The read-only address is being deleted.'."\n" - ."\n" - .'- ALLOCATING_READWRITE_ADDRESS: The read/write splitting address is being created.'."\n" - ."\n" - .'- DELETING_READWRITE_ADDRESS: The read/write splitting address is being deleted.'."\n" - ."\n" - .'- ALLOCATING_CLOGSERVICE_ADDRESS: The clog address is being created.'."\n" - ."\n" - .'- DELETING_CLOGSERVICE_ADDRESS: The clog address is being deleted.'."\n" - ."\n" - .'- MODIFYING_ADDRESS: The domain name of the address is being modified.'."\n" - ."\n" - .'- MODIFYING_PRIMARY_ZONE: The primary zone is being switched.'."\n" - ."\n" - .'- MODIFYING_READONLY_ADDRESS: The read-only address is being modified.'."\n" - ."\n" - .'- MODIFYING_READWRITE_ADDRESS: The read/write splitting address is being modified.'."\n" - ."\n" - .'- SPEC_MODIFYING: The specifications of the tenant are being modified.'."\n" - ."\n" - .'- WHITE_LIST_MODIFYING: The allowlist is being modified.'."\n" - ."\n" - .'- CREATING_BINLOG: Binlogs are being created.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'EnableInternetAddressService' => [ - 'title' => '是否可开启租户公网地址。', - 'description' => 'Indicates whether the Internet address can be enabled for the tenant. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrimaryZone' => [ - 'title' => '租户的主可用区。', - 'description' => 'The primary zone of the tenant. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'DeployType' => [ - 'title' => '集群的部署类型。 multiple：多机房 single：单机房 dual：双机房', - 'description' => 'The deployment type of the cluster. Valid values: '."\n" - .'- multiple: multi-IDC deployment '."\n" - .'- single: single-IDC deployment '."\n" - .'- dual: dual-IDC deployment ', - 'type' => 'string', - 'example' => 'multiple', - ], - 'DeployMode' => [ - 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', - 'description' => 'The data replica distribution mode of the tenant. '."\n" - ."\n" - .'- For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode.'."\n" - .'- For the basic version, N indicates the single-zone mode. '."\n" - ."\n" - .'>
N represents the number of nodes in a single zone. ', - 'type' => 'string', - 'example' => '1-1-1', + 'Code' => ['description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'A human-readable error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Provides values for the placeholders in `Message`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder variable.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'title' => '租户描述信息。', - 'description' => 'The description of the tenant. ', - 'type' => 'string', - 'example' => 'paycore database', + 'MessageMcmsKey' => ['description' => 'The template key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Provides values for placeholders in the template specified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder variable.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the tenant was created. ', - 'type' => 'string', - 'example' => '2023-04-21 11:15:47.0', + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The template key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Provides values for placeholders in the template specified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder variable.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'TenantResource' => [ - 'title' => '租户的资源信息。', - 'description' => 'The resource information of the tenant. ', + 'Proposal' => ['description' => 'The suggested solution to the error.', 'type' => 'string', 'example' => 'Contact the administrator.', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The template key for the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Provides values for placeholders in the template specified by `ProposalMcmsKey`.', 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'title' => '租户的unit个数。', - 'description' => 'The number of resource units for the tenant.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Cpu' => [ - 'title' => '租户的CPU资源信息。', - 'description' => 'The information about the CPU resources of the tenant.', - 'type' => 'object', - 'properties' => [ - 'UsedCpu' => [ - 'title' => '租户已使用的CPU核数，单位：Core。', - 'description' => 'The number of used CPU cores of the tenant. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'TotalCpu' => [ - 'title' => '租户总的CPU核数，单位：Core。', - 'description' => 'The total number of CPU cores of the tenant. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'UnitCpu' => [ - 'title' => '租户每个Unit的CPU核数，单位：Core。', - 'description' => 'The number of CPU cores in each resource unit of the tenant. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - ], - ], - 'Memory' => [ - 'title' => '租户内存资源信息。', - 'description' => 'The information about the memory resources of the tenant. ', - 'type' => 'object', - 'properties' => [ - 'UsedMemory' => [ - 'title' => '租户已使用的内存，单位：GB。', - 'description' => 'The size of used memory of the tenant, in GB. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '30', - ], - 'TotalMemory' => [ - 'title' => '租户总的内存大小，单位：GB。', - 'description' => 'The total memory size of the tenant, in GB. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '64', - ], - 'UnitMemory' => [ - 'title' => '租户每个Unit的内存大小，单位：GB。', - 'description' => 'The memory size of each resource unit of the tenant, in GB. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '32', - ], - ], - ], - 'DiskSize' => [ - 'title' => '租户磁盘资源信息。', - 'description' => 'The information about the disk resources of the tenant. ', - 'type' => 'object', - 'properties' => [ - 'UsedDiskSize' => [ - 'title' => '租户已使用的磁盘大小，单位：GB。', - 'description' => 'The size of used disk space of the tenant, in GB. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '86', - ], - ], - ], - 'CapacityUnit' => [ - 'title' => '容量单元', - 'description' => 'The information about capacity units.', - 'type' => 'object', - 'properties' => [ - 'MaxCapacityUnit' => [ - 'title' => '最大容量单元', - 'description' => 'The maximum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'MinCapacityUnit' => [ - 'title' => '最小容量单元', - 'description' => 'The minimum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsedCapacit' => [ - 'title' => '已使用容量单元', - 'description' => 'The number of used capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'LogDiskSize' => [ - 'description' => 'The information about the log disk resources of the tenant.', - 'type' => 'object', - 'properties' => [ - 'TotalLogDisk' => [ - 'description' => 'The total size of log disk of the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8.0', - ], - 'UnitLogDisk' => [ - 'description' => 'The log disk size of each resource unit of the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8.0', - ], - ], - ], - ], - ], - 'TenantConnections' => [ - 'title' => '租户的连接访问信息。', - 'description' => 'The connection information of the tenant.', - 'type' => 'array', - 'items' => [ - 'description' => 'The connection information of the tenant. ', - 'type' => 'object', - 'properties' => [ - 'IntranetAddress' => [ - 'title' => '访问租户的私网连接地址。', - 'description' => 'The intranet address for accessing the tenant. ', - 'type' => 'string', - 'example' => 't4nunwxr0****.oceanbase.aliyuncs.com', - ], - 'IntranetPort' => [ - 'title' => '访问租户的私网连接端口。', - 'description' => 'The intranet port for accessing the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2983', - ], - 'InternetAddress' => [ - 'title' => '访问租户的公网连接地址。', - 'description' => 'The Internet address for accessing the tenant. ', - 'type' => 'string', - 'example' => 't32a7ru5u****mo.oceanbase.aliyuncs.com', - ], - 'InternetPort' => [ - 'title' => '访问租户的公网连接端口。', - 'description' => 'The Internet port for accessing the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3306', - ], - 'VpcId' => [ - 'title' => '专有网络（VPC） ID。', - 'description' => 'The ID of the VPC. ', - 'type' => 'string', - 'example' => 'vpc-bp1qiail1asmfe23t****', - ], - 'VSwitchId' => [ - 'title' => '虚拟交换机（VSwitch） ID。', - 'description' => 'The ID of the vSwitch. ', - 'type' => 'string', - 'example' => 'vsw-bp1i7b94u2et716yl****', - ], - 'IntranetAddressMasterZoneId' => [ - 'title' => '访问租户的连接地址对应的主可用区。', - 'description' => 'The primary zone corresponding to the address for accessing the tenant. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - 'IntranetAddressSlaveZoneId' => [ - 'title' => '访问租户的连接地址对应的备可用区。', - 'description' => 'The standby zone corresponding to the address for accessing the tenant. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-g', - ], - 'IntranetAddressStatus' => [ - 'title' => '访问租户的私网连接地址状态。 ONLINE: 服务中', - 'description' => 'The status of the intranet address for accessing the tenant. '."\n" - .'The value ONLINE indicates that the address is in service. ', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'ConnectionZones' => [ - 'title' => '租户连接对应的访问可用区列表。', - 'description' => 'The list of zones corresponding to the tenant connection. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The zone corresponding to the tenant connection. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - 'example' => '["cn-hangzhou-i", "cn-hangzhou-j"]', - ], - 'InternetAddressStatus' => [ - 'title' => '访问租户的公网连接开通状态。 CLOSED：关闭 ALLOCATING_INTERNET_ADDRESS：申请中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 ONLINE：服务中', - 'description' => 'The status of the Internet address for accessing the tenant. Valid values: '."\n" - .'- CLOSED: The address is disabled. '."\n" - .'- ALLOCATING_INTERNET_ADDRESS: An address is being applied for. '."\n" - .'- PENDING_OFFLINE_INTERNET_ADDRESS: The address is being disabled. '."\n" - .'- ONLINE: The address is in service.', - 'type' => 'string', - 'example' => 'CLOSED', - ], - 'TransactionSplit' => [ - 'title' => '是否开启事务拆分', - 'description' => 'Specifies whether to enable transaction splitting.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AddressType' => [ - 'title' => '地址类型', - 'description' => 'The type of the address.'."\n" - ."\n" - .'- MASTER: the primary address, which supports both data read and write.'."\n" - .'- READONLY: a read-only address.'."\n" - .'- READWRITE: a read/write splitting address.'."\n" - .'- CLOGSERVICE: a clog service address.', - 'type' => 'string', - 'enumValueTitles' => [ - 'MASTER' => 'MASTER', - 'READWRITE' => 'READWRITE', - 'CLOGSERVICE' => 'CLOGSERVICE', - 'READONLY' => 'READONLY', - ], - 'example' => 'READONLY', - ], - 'EnableTransactionSplit' => [ - 'title' => '是否开启事务拆分', - 'description' => 'Specifies whether to enable transaction splitting.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ParallelQueryDegree' => [ - 'title' => '并行度', - 'description' => 'The degree of parallelism (DOP).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'default' => '2', - ], - 'TenantEndpointId' => [ - 'title' => '租户地址id', - 'description' => 'The ID of the tenant endpoint.', - 'type' => 'string', - 'example' => 'obe-4tw51gp7****', - ], - 'MaxConnectionNum' => [ - 'title' => '最大连接数', - 'description' => 'The maximum number of connections.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - 'ConnectionReplicaType' => [ - 'title' => '链接对应的副本类型', - 'description' => 'The type of the replica corresponding to the tenant connection.', - 'type' => 'string', - 'example' => 'FULL', - ], - 'ProxyClusterId' => [ - 'description' => 'The ID of the OceanBase Database Proxy (ODP) cluster.', - 'type' => 'string', - 'example' => 'proxy-xxxxxxx', - ], - 'MaxConnectionLimit' => [ - 'title' => '私网最大连接数的当前值', - 'description' => 'The current value set for the maximum number of private connections.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'InternetMaxConnectionLimit' => [ - 'title' => '公网最大连接数的上限', - 'description' => 'The upper limit of the maximum number of public connections.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4000', - ], - 'IntranetRpcPort' => [ - 'description' => 'The port for direct loads of private connections.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3307'."\n", - ], - 'InternetMaxConnectionNum' => [ - 'title' => '公网最大连接数的当前值', - 'description' => 'The current value set for the maximum number of public connections.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2500', - ], - 'InternetRpcPort' => [ - 'description' => 'The port for direct loads of public connections.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3307', - ], - 'ConnectionLogicalZones' => [ - 'description' => 'The logical zones of the endpoints.', - 'type' => 'array', - 'items' => [ - 'description' => 'The logical zones of the endpoints.', - 'type' => 'string', - 'example' => 'cn-bejing-3-z0,cn-bejing-4-z0', - ], - ], - 'IntranetSqlPort' => [ - 'description' => 'The port of private SQL connections.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3306', - 'title' => "\n", - ], - 'OdpVersion' => [ - 'description' => 'The ODP version.', - 'type' => 'string', - 'example' => '4.3.1-xxxxxxxxx', - ], - 'InternetSqlPort' => [ - 'title' => '公网sql端口', - 'type' => 'integer', - 'format' => 'int32', - ], - 'InternetAddressServiceType' => [ - 'title' => '公网地址地址类型', - 'type' => 'string', - ], - 'IntranetAddressServiceType' => [ - 'title' => '私网地址地址类型', - 'type' => 'string', - ], - ], - ], - ], - 'TenantZones' => [ - 'title' => '租户可用区信息。', - 'description' => 'The information about zones in the tenant.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about zones in the tenant.', - 'type' => 'object', - 'properties' => [ - 'TenantZoneId' => [ - 'title' => '租户可用区ID。', - 'description' => 'The ID of the zone. ', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Region' => [ - 'title' => '租户可用区所属的地域。', - 'description' => 'The region where the zone of the tenant resides. ', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TenantZoneRole' => [ - 'title' => '租户可用区的请求类型。 ReadWrite：可读可写 ReadOnly：只读 对于多机房高可用集群，其主可用区为ReadWrite。备可用区为ReadOnly; 对于单机房高可用集群，其所有可用区均为ReadWrite。', - 'description' => 'The role of the zone of the tenant. ', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'TenantZoneReplicas' => [ - 'description' => 'The zone replicas of the tenant.', - 'type' => 'array', - 'items' => [ - 'description' => 'The zone replicas of the tenant.', - 'type' => 'object', - 'properties' => [ - 'ZoneReplicaType' => [ - 'description' => 'The type of the zone replica.', - 'type' => 'string', - 'example' => 'FULL', - ], - 'ZoneNodes' => [ - 'description' => 'The number of nodes in the zone.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LogicZoneName' => [ - 'description' => 'The name of the logical zone.', - 'type' => 'string', - 'example' => 'cn-shanghai-f-z0', - ], - 'ZoneCopyId' => [ - 'description' => 'The ID of the zone replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'FullCopyId' => [ - 'description' => 'The ID of the full-featured replica.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ReadOnlyCopyId' => [ - 'description' => 'The ID of the read-only replica.', - 'type' => 'string', - 'example' => '3', - ], - 'ReadOnlyReplicaType' => [ - 'description' => 'The type of the read-only replica.', - 'type' => 'string', - 'example' => 'ROW_STORE', - ], - ], - ], - ], - ], - ], - ], - 'ClogServiceStatus' => [ - 'title' => 'Clog服务开启状态。 CLOSED: 关闭 ONLINE：服务中', - 'description' => 'The enabling status of the clog service. '."\n" - .'- CLOSED: The clog service is disabled. '."\n" - .'- ONLINE: The clog service is running.', - 'type' => 'string', - 'example' => 'CLOSED', - ], - 'EnableClogService' => [ - 'title' => '是否可使用Clog服务，如需开启，请工单联系。', - 'description' => 'Indicates whether the clog service is available. To enable the clog service, submit a ticket.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Charset' => [ - 'title' => '字符集', - 'description' => 'The character set.', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'Collation' => [ - 'title' => '字符序', - 'description' => 'The collation.', - 'type' => 'string', - 'example' => 'utf8mb4_general_ci', - ], - 'PrimaryZoneDeployType' => [ - 'title' => '租户主可用区部署模式', - 'description' => 'The deployment type of the primary zone.', - 'type' => 'string', - 'enumValueTitles' => [ - 'RANDOM' => 'RANDOM', - 'STATIC' => 'STATIC', - ], - 'example' => 'RANDOM', - ], - 'MasterIntranetAddressZone' => [ - 'title' => '租户主地址可用区', - 'description' => 'The zone where the primary node is located.', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'PayType' => [ - 'title' => '付费类型', - 'description' => 'The type of the payment.', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => 'The type of the instance.', - 'type' => 'string', - 'example' => 'KAFKA_PUBLIC', - ], - 'Series' => [ - 'title' => '实例系列', - 'description' => 'The series of the instance.', - 'type' => 'string', - 'example' => 'normal', - ], - 'DiskType' => [ - 'title' => '磁盘类型', - 'description' => 'The type of the disk.', - 'type' => 'string', - 'example' => 'cloud_essd_pl1', - ], - 'AvailableZones' => [ - 'title' => '可用区', - 'description' => 'The list of zones.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of zones.', - 'type' => 'string', - 'example' => '["cn-hangzhou-i"]', - ], - ], - 'EnableReadWriteSplit' => [ - 'title' => '是否允许开启读写分离地址', - 'description' => 'Indicates whether to enable read/write splitting endpoint.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EnableParallelQuery' => [ - 'title' => '是否允许开通并行查询', - 'description' => 'Indicates whether parallel query can be enabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MaxParallelQueryDegree' => [ - 'title' => '并行度设置上限', - 'description' => 'The maximum value of DOP.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'EnableBinlogService' => [ - 'title' => '是否可以申请Binlog服务', - 'description' => 'Indicates whether the binlog service is available for application.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TimeZone' => [ - 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', - 'description' => 'The time zone.', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - 'DataMergeTime' => [ - 'title' => '租户合并时间，仅对4.0以上OB版本有效', - 'description' => 'The major compaction time of the tenant. This parameter is supported only in OceanBase Database V4.0.0 and later.', - 'type' => 'string', - 'example' => '02:36Z', - ], - 'ReadOnlyResource' => [ - 'description' => 'The information about read-only resources.', - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'title' => '租户的unit个数。', - 'description' => 'The number of resource units in the tenant.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Cpu' => [ - 'description' => 'The number of CPU cores of each replica node in the cluster.', - 'type' => 'object', - 'properties' => [ - 'UsedCpu' => [ - 'description' => 'The number of CPU cores used by the cluster.', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'TotalCpu' => [ - 'title' => '租户总的CPU核数，单位：Core。', - 'description' => 'The total number of CPU cores of the tenant.', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'UnitCpu' => [ - 'title' => '租户每个Unit的CPU核数，单位：Core。', - 'description' => 'The number of CPU cores in each resource unit of the tenant.', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - ], - ], - 'Memory' => [ - 'description' => 'The information about the memory resources of the cluster.', - 'type' => 'object', - 'properties' => [ - 'UsedMemory' => [ - 'title' => '租户已使用的内存，单位：GB。', - 'description' => 'The size of memory used by the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '30', - ], - 'TotalMemory' => [ - 'title' => '租户总的内存大小，单位：GB。', - 'description' => 'The total memory size of the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '64', - ], - 'UnitMemory' => [ - 'title' => '租户每个Unit的内存大小，单位：GB。', - 'description' => 'The memory size of each resource unit of the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '32', - ], - ], - ], - 'DiskSize' => [ - 'description' => 'The size of the data disk.', - 'type' => 'object', - 'properties' => [ - 'UsedDiskSize' => [ - 'title' => '租户已使用的磁盘大小，单位：GB。', - 'description' => 'The size of disk space used by the tenant, in GB.', - 'type' => 'number', - 'format' => 'float', - 'example' => '86', - ], - ], - ], - 'CapacityUnit' => [ - 'description' => 'The information about capacity units.', - 'type' => 'object', - 'properties' => [ - 'MaxCapacityUnit' => [ - 'title' => '最大容量单元', - 'description' => 'The maximum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'MinCapacityUnit' => [ - 'title' => '最小容量单元', - 'description' => 'The minimum number of capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsedCapacit' => [ - 'title' => '已使用容量单元', - 'description' => 'The number of used capacity units.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'LogDiskSize' => [ - 'description' => 'The information about the log disk resources of the tenant.', - 'type' => 'object', - 'properties' => [ - 'TotalLogDisk' => [ - 'description' => 'The total log disk size of the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8.0', - ], - 'UnitLogDisk' => [ - 'description' => 'The log disk size of each resource unit of the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8.0', - ], - ], - ], - ], - ], - 'EnableReadOnlyReplica' => [ - 'description' => 'Indicates whether read-only replicas are supported.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecycleBinStatus' => [ - 'title' => '表示租户回收站状态，ON表示开启，OFF表示关闭', - 'description' => 'The status of the recycle bin in the tenant. Valid values: '."\n" - .'* ON: The recycly bin is enabled. '."\n" - .'* OFF: The recycle bin is disabled.', - 'type' => 'string', - 'example' => 'ON', - ], - 'LowerCaseTableNames' => [ - 'description' => 'Indicates whether the table name is case-sensitive. Valid values: '."\n" - .'* **1**: The table name is case-insensitive. '."\n" - .'* **0**: The table name is case-sensitive.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Version' => [ - 'title' => '版本信息', - 'description' => 'The version information.', - 'type' => 'string', - 'example' => '4.2.1', - ], - 'OdpVersion' => [ - 'description' => 'The ODP version.', - 'type' => 'string', - 'example' => '4.3.1-xxxxxxxxx', - ], - 'TenantMaxConnections' => [ - 'title' => '租户允许的最大连接数', - 'description' => 'The maximum number of connections allowed in the tenant.', - 'type' => 'integer', - 'example' => '1600', - 'format' => 'int64', - ], - 'ParameterTemplate' => [ - 'title' => '参数模板', - 'description' => 'The parameter template.', - 'type' => 'string', - 'example' => 'express_oltp', - ], - 'Iops' => [ - 'title' => '租户IOPS', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', + 'additionalProperties' => ['description' => 'The value of a placeholder variable.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Details about errors from upstream services.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'A human-readable error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'Suggested actions.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E3D924FB-52****B253-0C1A7EFB778C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The time taken to process the request, in seconds.', 'type' => 'string', 'title' => '', 'example' => '28'], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Tenant\\": {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"EnableInternetAddressService\\": true,\\n \\"PrimaryZone\\": \\"cn-hangzhou-h\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j\\",\\n \\"Description\\": \\"paycore database\\",\\n \\"CreateTime\\": \\"2023-04-21 11:15:47.0\\",\\n \\"TenantResource\\": {\\n \\"UnitNum\\": 1,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"TenantConnections\\": [\\n {\\n \\"IntranetAddress\\": \\"t4nunwxr0****.oceanbase.aliyuncs.com\\",\\n \\"IntranetPort\\": 2983,\\n \\"InternetAddress\\": \\"t4nunwxr0****-mi.oceanbase.aliyuncs.com\\",\\n \\"InternetPort\\": 3306,\\n \\"VpcId\\": \\"vpc-bp1qiail1asmfe23t****\\",\\n \\"VSwitchId\\": \\"vsw-bp1i7b94u2et716yl****\\",\\n \\"IntranetAddressMasterZoneId\\": \\"cn-hangzhou-b\\",\\n \\"IntranetAddressSlaveZoneId\\": \\"cn-hangzhou-g\\",\\n \\"IntranetAddressStatus\\": \\"ONLINE\\",\\n \\"ConnectionZones\\": [\\n \\"cn-hangzhou-b\\"\\n ],\\n \\"InternetAddressStatus\\": \\"CLOSED\\",\\n \\"TransactionSplit\\": false,\\n \\"AddressType\\": \\"READONLY\\",\\n \\"EnableTransactionSplit\\": false,\\n \\"ParallelQueryDegree\\": 1,\\n \\"TenantEndpointId\\": \\"obe-4tw51gp7****\\",\\n \\"MaxConnectionNum\\": 5000,\\n \\"ConnectionReplicaType\\": \\"FULL\\",\\n \\"ProxyClusterId\\": \\"proxy-xxxxxxx\\",\\n \\"MaxConnectionLimit\\": 1000,\\n \\"InternetMaxConnectionLimit\\": 4000,\\n \\"IntranetRpcPort\\": 3307,\\n \\"InternetMaxConnectionNum\\": 2500,\\n \\"InternetRpcPort\\": 3307,\\n \\"ConnectionLogicalZones\\": [\\n \\"cn-bejing-3-z0,cn-bejing-4-z0\\"\\n ],\\n \\"IntranetSqlPort\\": 3306,\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"InternetSqlPort\\": 0,\\n \\"InternetAddressServiceType\\": \\"\\",\\n \\"IntranetAddressServiceType\\": \\"\\"\\n }\\n ],\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"TenantZoneReplicas\\": [\\n {\\n \\"ZoneReplicaType\\": \\"FULL\\",\\n \\"ZoneNodes\\": 1,\\n \\"LogicZoneName\\": \\"cn-shanghai-f-z0\\",\\n \\"ZoneCopyId\\": 2,\\n \\"FullCopyId\\": 3,\\n \\"ReadOnlyCopyId\\": \\"3\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ]\\n }\\n ],\\n \\"ClogServiceStatus\\": \\"ONLINE\\",\\n \\"EnableClogService\\": true,\\n \\"Charset\\": \\"gb18030\\",\\n \\"Collation\\": \\"gb18030_chinese_ci\\",\\n \\"PrimaryZoneDeployType\\": \\"STATIC\\",\\n \\"MasterIntranetAddressZone\\": \\"cn-hangzhou-h\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"InstanceType\\": \\"KAFKA_PUBLIC\\",\\n \\"Series\\": \\"normal\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"AvailableZones\\": [\\n \\"[\\\\\\"cn-hangzhou-i\\\\\\"]\\"\\n ],\\n \\"EnableReadWriteSplit\\": true,\\n \\"EnableParallelQuery\\": true,\\n \\"MaxParallelQueryDegree\\": 32,\\n \\"EnableBinlogService\\": true,\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"DataMergeTime\\": \\"02:36Z\\",\\n \\"ReadOnlyResource\\": {\\n \\"UnitNum\\": 2,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"EnableReadOnlyReplica\\": true,\\n \\"RecycleBinStatus\\": \\"ON\\",\\n \\"LowerCaseTableNames\\": 1,\\n \\"Version\\": \\"4.2.1\\",\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"TenantMaxConnections\\": 1600,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n t33h8y08k****\\n pay_online\\n Oracle\\n vpc-bp1d2q3mhg9i23ofi****\\n ONLINE\\n cn-hangzhou-i\\n multiple\\n 1-1-1\\n paycore 业务数据库\\n 2021-09-17 15:52:17\\n \\n 1\\n \\n 8\\n 10\\n 8\\n \\n \\n 30\\n 64\\n 32\\n \\n \\n 86\\n \\n \\n \\n ReadWrite\\n t32a7ru5u****.oceanbase.aliyuncs.com\\n 3306\\n t32a7ru5u****mo.oceanbase.aliyuncs.com\\n 3306\\n vpc-bp1qiail1asmfe23t****\\n vsw-bp11k1aypnzu1l3whi****\\n cn-hangzhou-i\\n cn-hangzhou-j\\n ONLINE\\n cn-hangzhou-i\\n CLOSED\\n \\n \\n cn-hangzhou-i\\n cn-hangzhou\\n ReadOnly\\n \\n CLOSED\\n \\n","errorExample":""}]', - 'title' => 'DescribeTenant', - ], - 'DescribeAvailableCpuResource' => [ - 'summary' => 'You can call this operation to query the CPU resources available for a tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Delete data source', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDatabases' => [ + 'summary' => 'Delete one or more created databases.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The CPU resources available. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => ' ', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ - 'name' => 'TenantId', + 'name' => 'DatabaseNames', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeAvailableCpuResource**. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => '', 'description' => 'List of database names. '."\n" + .'It is a JSON-formatted array, where each element is a string representing a database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[\\"sms_pre\\", \\"pay_pre\\"]'], ], [ - 'name' => 'ModifyType', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '用户权限修改类型。 可支持以下几种方式： update：全量更新权限，默认值； add：新增权限； delete：删除权限。 默认值：update。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeAvailableCpuResource'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&TenantId=ob2mr3oae0****'."\n" - .'&ModifyType=update'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'required' => false, - 'example' => 'update', - ], + 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'You can call this operation to query the CPU resources available for a tenant. ', + 'title' => '', + 'description' => 'Return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Data' => [ - 'title' => '可用的CPU资源信息。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'XXXX', - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'title' => 'unit数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'MinCpu' => [ - 'title' => '单个unit最小需要申请的CPU核数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'MaxCpu' => [ - 'title' => '单个unit最大可申请的CPU核数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ReviewCode' => [ - 'title' => 'unitnum变更检查结果', - 'type' => 'string', - 'example' => 'UnitNum.Change.Accept', - 'enum' => [ - 'UnitNum.Change.Accept', - 'UnitNum.Change.Reject', - 'UnitNum.Change.NotRecommend', - ], - ], - 'Comment' => [ - 'title' => '建议', - 'type' => 'string', - 'example' => 'UnitNum.RejectComment.Storage', - 'enum' => [ - 'UnitNum.RejectComment.Storage', - 'UnitNum.NotRecommendComment.Storage', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"UnitNum\\": 2,\\n \\"MinCpu\\": 2,\\n \\"MaxCpu\\": 10,\\n \\"ReviewCode\\": \\"UnitNum.Change.Accept\\",\\n \\"Comment\\": \\"UnitNum.RejectComment.Storage\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 2\\n 2\\n 10\\n \\n","errorExample":""}]', - 'title' => 'DescribeAvailableCpuResource', - ], - 'DescribeAvailableMemResource' => [ - 'summary' => 'You can call this operation to query the available memory resource of an OceanBase Database tenant. ', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Delete Database', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteInstances' => [ + 'summary' => 'You can call this operation to release an OceanBase cluster. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'InstanceIds', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the cluster to be deleted. The value is a string in the JSON format. ', 'description' => 'The ID of the cluster to be deleted. '."\n" + .'The value is a string in the JSON format. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["ob317v4uif****","ob627v4uif****"]'], ], [ - 'name' => 'TenantId', + 'name' => 'BackupRetainMode', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => 'The backup retention strategy for cluster deletion. Valid values: - receive_all: retains all backup sets. - delete_all: deletes all backup sets. - receive_last: retains the last backup set. Default value: delete_all. ', 'description' => 'The backup retention strategy for cluster deletion. Valid values: '."\n" + .'- receive_all: retains all backup sets. '."\n" + .'- delete_all: deletes all backup sets. '."\n" + .'- receive_last: retains the last backup set. '."\n" + ."\n" + .'>
Default value: delete_all. ', 'type' => 'string', 'required' => false, 'example' => 'delete_all'], ], [ - 'name' => 'UnitNum', + 'name' => 'DryRun', 'in' => 'formData', + 'schema' => ['title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会删除实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接删除实例。', 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the instance is not deleted. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: The actual request is sent and no dry run is performed. The instance is deleted if the requirements are met. By default, false is returned for the parameter DryRunResult if you set DryRun to false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', - 'description' => 'The number of resource distribution nodes in the tenant. '."\n" - .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DryRunResult' => ['title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', 'type' => 'boolean', 'example' => 'false'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'BadRequest', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'InstanceStatus.Invalid', 'errorMessage' => 'InstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstance.StillOnline', 'errorMessage' => 'StandbyInstance.StillOnline', 'description' => ''], + ['errorCode' => 'UnknownError', 'errorMessage' => 'UnknownError', 'description' => ''], + ['errorCode' => 'Tenant.StillOnline', 'errorMessage' => 'Tenant.StillOnline', 'description' => ''], + ['errorCode' => 'ServiceTemporarilyUnavailable', 'errorMessage' => 'ServiceTemporarilyUnavailable', 'description' => ''], + ['errorCode' => 'NotFound', 'errorMessage' => 'NotFound', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'InternalServerError', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DryRunResult\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"65BDA532-28AF-4122-AA39-B382721EEE64","errorExample":""}]', + 'title' => 'DeleteInstances', + 'description' => 'Before you call this operation, ensure that the following requirements are met:'."\n" + .'- The cluster is in the Running state.'."\n" + .'- The cluster is a primary cluster and the billing method is pay-as-you-go. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*'], + ], ], ], + ], + ], + 'DeleteProject' => [ + 'summary' => 'Deletes a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CpuNum', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of CPU cores. ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '14', - ], + 'schema' => ['description' => 'The ID of the data migration or synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'title' => '可用的内存资源信息。', - 'description' => 'The available memory size. ', + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', 'type' => 'object', 'properties' => [ - 'MinMem' => [ - 'title' => '单个unit最小需要申请的内存大小，单位：GB。', - 'description' => 'The minimum memory size required for each resource unit, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Contains key-value pairs for populating placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the `Message` field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'MaxMem' => [ - 'title' => '单个unit最大可申请的内存大小，单位：GB。', - 'description' => 'The maximum memory size for each resource unit, in GB. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'MessageMcmsKey' => ['description' => 'The localization key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Contains key-value pairs for placeholders in the message referenced by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the localized message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'UsedMem' => [ - 'title' => '租户的unit个数。', - 'description' => 'The number of resource units in the tenant. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The localization key for the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Contains key-value pairs for placeholders in the reason referenced by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the localized reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'SafeMem' => [ - 'title' => '内存安全水位', - 'description' => 'The maximum allowed memory usage, in GB.', - 'type' => 'string', - 'example' => '10.0', + 'Proposal' => ['description' => 'The new suggestion.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The localization key for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Contains key-value pairs for placeholders in the suggestion referenced by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the localized suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Details of upstream service errors.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The legacy advice.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The unique identifier for the request. Include this ID when you submit a support ticket.', 'type' => 'string', 'example' => '473469C7-XXXX-XXX-B3DB-A3DC0DE'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number of the returned results. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries returned per page. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Cost' => ['description' => 'The time elapsed to process the request, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The returned data. For this operation, the value is `null`.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"MinMem\\": 5,\\n \\"MaxMem\\": 10,\\n \\"UsedMem\\": 2,\\n \\"SafeMem\\": \\"10.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 5\\n 10\\n 2\\n \\n","errorExample":""}]', - 'title' => 'DescribeAvailableMemResource', - ], - 'DescribeCharset' => [ - 'summary' => 'You can call this operation to query the character set of an OceanBase Database tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXX-B3DB-A3DC0DE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Delete Job ', + 'description' => '>'."\n" + ."\n" + .'You cannot delete a subscription project via the API. To delete the project, you must submit a ticket to Alibaba Cloud to unsubscribe.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteSecurityIpGroup' => [ + 'summary' => 'The ID of the OceanBase cluster. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'TenantMode', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户模式。 当前支持Oracle模式（Oracle）、MySQL模式（MySQL） 详细参见：DescribeInstanceTenantModes。', - 'description' => 'The return result of the request.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Oracle', - 'enum' => [ - 'MySQL', - 'Oracle', - ], - ], - ], - [ - 'name' => 'Series', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版。', - 'description' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版。', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The name of the IP address whitelist group. '."\n" + .'It must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters, digits, and underscores (_). ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'InstanceId', + 'name' => 'SecurityIpGroupName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => 'The ID of the region. ', 'description' => 'The information of the deleted IP whitelist group. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'paytest'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The character set name.', + 'title' => 'The name of the deleted IP address whitelist group. ', + 'description' => 'The request ID. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeCharset**. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Charset' => [ - 'title' => '字符集列表。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeCharset'."\n" - .'&TenantMode=Oracle'."\n" + 'RequestId' => ['title' => 'The operation that you want to perform. '."\n" + .'Set the value to **DeleteSecurityIpGroup**. ', 'description' => 'Example 1', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DeleteSecurityIpGroup'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&SecurityIpGroupName=paytest'."\n" .'&Common request parameters'."\n" .'```', - 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'Charset' => [ - 'title' => '字符集名称。', - 'description' => 'DescribeCharset', - 'type' => 'string', - 'example' => 'utf8', - ], - 'Collations' => [ - 'title' => '字符序集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["utf8mb4_general_ci","utf8mb4_bin","binary"]', - ], - ], - ], + 'description' => 'Information about the deleted IP address whitelist group.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => 'You can call this operation to delete an IP address whitelist group of an OceanBase cluster. ', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'SecurityIpGroupName' => ['title' => '', 'description' => 'Name of the deleted IP address whitelist group.', 'type' => 'string', 'example' => 'paytest'], ], 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Charset\\": [\\n {\\n \\"Charset\\": \\"utf8\\",\\n \\"Collations\\": [\\n \\"[\\\\\\"utf8mb4_general_ci\\\\\\",\\\\\\"utf8mb4_bin\\\\\\",\\\\\\"binary\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n utf8\\n \\n","errorExample":""}]', - 'title' => 'DescribeCharset', - ], - 'DescribeInstanceAvailableZones' => [ - 'summary' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","type":"json"}]', + 'title' => 'Delete a whitelist group', + 'changeSet' => [ + ['createdAt' => '2021-06-17T12:55:49.000Z', 'description' => 'Request parameters changed'], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteTag' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', - ], - 'ZoneList' => [ - 'description' => 'The return result of the request.', - 'type' => 'array', - 'items' => [ - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'Zone' => [ - 'description' => 'The name of the physical zone.', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'IsInCluster' => [ - 'description' => 'Indicates whether the cluster is deployed in the zone.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ReplicateZoneIndex' => [ - 'description' => 'The index of the replicated zone.', - 'type' => 'string', - 'example' => '1', - ], - 'LogicalZoneName' => [ - 'description' => 'The name of the logical zone.', - 'type' => 'string', - 'example' => 'cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2', - ], - ], - ], - ], + 'Message' => ['description' => 'The tag group deletion result.', 'type' => 'string', 'example' => 'delete tag success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"ZoneList\\": [\\n {\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsInCluster\\": true,\\n \\"ReplicateZoneIndex\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeInstanceAvailableZones', - ], - 'DescribeTenantZonesRead' => [ - 'summary' => 'You can call this operation to query the information about read-only zones of a tenant. ', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DeleteTag', + 'summary' => 'You can call this operation to delete a tag group.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTagValue' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The zone information of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'Value', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['description' => 'The name of the tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签 2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'Indicates whether a read-only connection has been created. ', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'Indicates whether a read-only connection needs to be created for the zone. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantZones' => [ - 'title' => '租户可用区信息。', - 'description' => 'The request ID. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to DescribeTenantZonesRead. ', - 'type' => 'object', - 'properties' => [ - 'IsElectable' => [ - 'title' => '是否可选为主库。', - 'description' => 'Example 1', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsPrimary' => [ - 'title' => '是否为主可用区。', - 'description' => ' ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Zone' => [ - 'title' => '可用区ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'IsReadable' => [ - 'title' => '是否可以设置为只读。', - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - 'example' => '', - ], + 'Message' => ['description' => 'The tag deletion result.', 'type' => 'string', 'example' => 'delete tag-value success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantZones\\": [\\n {\\n \\"IsElectable\\": true,\\n \\"IsPrimary\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsReadable\\": \\"true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n true\\n true\\n cn-hangzhou-i\\n true\\n true\\n \\n","errorExample":""}]', - 'title' => 'DescribeTenantZonesRead', - ], - 'DescribeTimeZones' => [ - 'summary' => 'You can call this API to query the time zones supported by an OceanBase Database tenant. ', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DeleteTagValue', + 'summary' => 'You can call this operation to delete a tag from a tag group.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTagValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTenantSecurityIpGroup' => [ + 'summary' => 'You can call this operation to delete the information on the whitelist group of the tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****'], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'paytest'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The default time zone. ', + 'title' => '', + 'description' => 'The returned result of the request.', 'type' => 'object', 'properties' => [ - 'TimeZones' => [ - 'title' => '租户允许的时区信息。', - 'description' => 'The description of the time zone. ', + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => '', + 'description' => 'The information of the whitelist group. ', 'type' => 'object', 'properties' => [ - 'List' => [ - 'title' => '时区列表信息。', - 'description' => 'The list of time zones. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the time zone. ', - 'type' => 'object', - 'properties' => [ - 'TimeZone' => [ - 'title' => '时区名称。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeTimeZones**. ', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - 'Description' => [ - 'title' => '时区描述。', - 'description' => 'Example 1', - 'type' => 'string', - 'example' => '(GMT+8:00) Asia/Shanghai', - ], - ], - ], - 'example' => '', - ], - 'Default' => [ - 'title' => '默认时区。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], + 'InstanceId' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4louaeei****'], + 'SecurityIpGroupName' => ['title' => '', 'description' => 'The name of the whitelist group. ', 'type' => 'string', 'example' => 'paytest'], ], 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'DescribeTimeZones', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteTenantSecurityIpGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TimeZones\\": {\\n \\"List\\": [\\n {\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"Description\\": \\"(GMT+8:00) Asia/Shanghai\\"\\n }\\n ],\\n \\"Default\\": \\"Asia/Shanghai\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n Asia/Shanghai\\n (GMT+8:00) Asia/Shanghai\\n \\n Asia/Shanghai\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeTimeZones', ], - 'DescribeTenantSecurityIpGroups' => [ - 'summary' => 'You can call this operation to view the list of whitelist groups of the tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteTenantUsers' => [ + 'summary' => 'You can call this operation to delete one or more database accounts. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], ], [ - 'name' => 'TenantId', + 'name' => 'Users', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['title' => 'A list of usernames and their respective roles. ', 'description' => 'A list of usernames.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["testUser"]'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned result of the request.', + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469**-AA6F-4D**-B3DB-A***********', - ], - 'TotalCount' => [ - 'title' => '白名单分组个数。', - 'description' => 'The total number of the whitelist groups.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'SecurityIpGroups' => [ - 'title' => '白名单分组列表。', - 'description' => 'The list of the whitelist groups.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SecurityIpGroupName' => [ - 'title' => '分组名称', - 'description' => 'The group name.', - 'type' => 'string', - 'example' => 'test1', - ], - 'SecurityIps' => [ - 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。\'', - 'description' => 'The whitelist of IP addresses. It is a string separated by commas, and each object is an IP string or a CIDR block.', - 'type' => 'string', - 'example' => '192.***.*.*"', - ], - 'SecurityIpGroupType' => [ - 'title' => '白名单分组类型。- instance: 集成自集群的白名单分组；- tenant：本租户的白名单分组', - 'description' => 'The whitelist group type.'."\n" - .'- instance: the whitelist group from the cluster.'."\n" - .'- tenant: the whitelist group of the current tenant.', - 'type' => 'string', - 'example' => 'tenant', - ], - 'TenantId' => [ - 'title' => '租户id', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - ], - ], - ], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'DeleteTenantUsers', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenantUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIpGroupName\\": \\"test1\\",\\n \\"SecurityIps\\": \\"192.***.*.*\\",\\n \\"SecurityIpGroupType\\": \\"tenant\\",\\n \\"TenantId\\": \\"t4louaeei****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeTenantSecurityIpGroups', ], - 'DescribeZones' => [ - 'summary' => 'You can call this operation to learn of zones where a cluster can be created in an Alibaba Cloud region. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteTenants' => [ + 'summary' => 'The request ID. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8515,527 +5524,355 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Series', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群的系列 - normal（默认）：高可用版本 - basic：基础版本', - 'description' => 'The deployment mode. ', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NORMAL' => 'NORMAL', - ], - 'example' => 'NORMAL', - 'enum' => [ - 'normal', - 'basic', - ], - ], - ], - [ - 'name' => 'DeployType', + 'name' => 'TenantIds', 'in' => 'formData', - 'schema' => [ - 'title' => '集群的部署类型。- multiple：多机房 - single：单机房 - dual：双机房', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeZones**. ', - 'type' => 'string', - 'required' => false, - 'example' => 'single', - 'enum' => [ - 'multiple', - 'single', - 'dual', - ], - ], + 'schema' => ['title' => 'Example 1', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DeleteTenants'."\n" + .'&TenantIds=["ob2mr3oae0****", "ob2mr3oae1****"]'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["ob2mr3oae0****", "ob2mr3oae1****"]'], ], [ - 'name' => 'CpuArch', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'cpu架构', - 'type' => 'string', - 'example' => 'x86', - ], + 'schema' => ['title' => ' ', 'description' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Example 1', + 'title' => '{"name":"DeleteTenants","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":5000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DeleteTenants\\"},{\\"name\\":\\"TenantIds\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"[\\\\\\"ob2mr3oae0****\\\\\\", \\\\\\"ob2mr3oae1****\\\\\\"]\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"ob317v4uif****\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"TenantIds\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Array\\",\\"subType\\":\\"String\\",\\"example\\":\\"[tjd3da45kc****，tdsjc42cm****]\\",\\"title\\":\\"\\",\\"description\\":\\"\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{\\"500\\":[{\\"code\\":\\"500\\",\\"defaultError\\":false,\\"errorCode\\":\\"InternalError\\",\\"errorMessage\\":\\"The request processing has failed due to some unknown error.\\",\\"errorMessageCn\\":\\"\\",\\"type\\":\\"user\\"}]}"}', + 'description' => 'Return Result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeZones'."\n" - .'&Series=normal'."\n" - .'&DeployType=single'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Zones' => [ - 'title' => '可用区列表信息', - 'description' => 'You can call this operation to learn of zones where a cluster can be created in an Alibaba Cloud region. ', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TenantIds' => [ + 'title' => '', + 'description' => 'List of tenant IDs.', 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'title' => '可用区ID列表。对于多可用区集群，其可用区名称以逗号连接', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h', - ], - 'ZoneName' => [ - 'title' => '可用区名称', - 'description' => '', - 'type' => 'string', - 'example' => 'H/I/J', - ], - 'Series' => [ - 'title' => 'Oceanbase集群的系列 - NORMAL（默认）：高可用版本 - BASIC：基础版本', - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'DeployType' => [ - 'title' => '部署模式', - 'description' => '', - 'type' => 'string', - 'example' => '1-1-1', - ], - ], - ], + 'items' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 'tjd3da45kc****', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h\\",\\n \\"ZoneName\\": \\"H/I/J\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"DeployType\\": \\"1-1-1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h\\n H/I/J\\n Normal\\n 1-1-1\\n \\n","errorExample":""}]', - 'title' => 'DescribeZones', - ], - 'ModifyTenantPrimaryZone' => [ - 'summary' => 'You can call this operation to switch the primary zone of the tenant. ', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantIds\\": [\\n \\"tjd3da45kc****\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Delete Tenant', + 'changeSet' => [ + ['createdAt' => '2021-11-04T11:55:04.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeAnomalySQLList' => [ + 'summary' => 'Queries the list of SQL statements that the diagnostic system identifies as potentially having performance issues.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The primary zone of the tenant. '."\n" - .'It is one of the zones in which the cluster is deployed. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'obsd23j4f****'], ], [ - 'name' => 'PrimaryZone', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', - 'description' => 'The ID of the vSwitch. ', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****'], ], [ - 'name' => 'UserVSwitchId', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'title' => '用户交换机ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-xxx', - ], + 'schema' => ['title' => '', 'description' => 'The start time for querying suspicious SQL parameters. '."\n" + .'The time supports only UTC time in the format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], ], [ - 'name' => 'MasterIntranetAddressZone', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'title' => '主内网地址可用区', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=ModifyTenantPrimaryZone'."\n" - .'&TenantId=ob2mr3oae0****'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&PrimaryZone=cn-hangzhou-h'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['title' => '', 'description' => 'The end time for querying suspicious SQL parameters. '."\n" + .'The time supports only UTC time in the format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], ], [ - 'name' => 'TenantEndpointId', + 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'title' => '租户地址id', - 'type' => 'string', - 'example' => 'obe-4tw51gp7****', - ], + 'schema' => ['title' => '', 'description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], [ - 'name' => 'TenantEndpointDirectId', + 'name' => 'SearchKeyWord', 'in' => 'formData', - 'schema' => [ - 'title' => '租户直连地址endpoint id', - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'Keyword query.', 'type' => 'string', 'required' => false, 'example' => 'update'], ], [ - 'name' => 'UserDirectVSwitchId', + 'name' => 'SearchParameter', 'in' => 'formData', - 'schema' => [ - 'title' => '租户直连地址vswitch id', - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'Parameter query.', 'type' => 'string', 'required' => false, 'example' => 'cputime'], ], [ - 'name' => 'VpcId', + 'name' => 'SearchRule', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'Query rule. '."\n" + .'Valid values of this parameter: “=”, “>”, “>=”, “<”, “<=”.', 'type' => 'string', 'required' => false, 'example' => '>'], ], [ - 'name' => 'UserVpcOwnerId', + 'name' => 'SearchValue', 'in' => 'formData', - 'schema' => [ - 'title' => '用户vpc的ownerId', - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'You can call this operation to switch the primary zone of the tenant. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], + 'schema' => ['title' => '', 'description' => 'Query value.', 'type' => 'string', 'required' => false, 'example' => '0.01'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantPrimaryZone', - ], - 'ModifyTenantResource' => [ - 'summary' => 'You can call this operation to modify the specifications of a tenant in an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'NodeIp', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => '', 'description' => 'Node IP.', 'type' => 'string', 'required' => false, 'example' => 'i-bp19y05****pacyqnlrc'], ], [ - 'name' => 'Cpu', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The information about the CPU resources of the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The number of rows per page for paginated queries.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Memory', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '租户内存大小，单位GB。', - 'description' => 'The memory size of the tenant, in GB. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The page number for paginated queries.'."\n" + .'- Starting value: 1.'."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'InstanceId', + 'name' => 'FilterCondition', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'title' => '', + 'description' => 'Filter condition. '."\n" + .'>
- All fields of OceanBase support filtering.
- Write the key-value pairs of the parameter in JSON format within a JSON string to filter by the parameter.', + 'enumValueTitles' => ['UserName' => 'UserName', 'Event' => 'Event', 'SQLType' => 'SQLType', 'ClientIp' => 'ClientIp'], + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "UserName":testUser'."\n" + .'}', ], ], [ - 'name' => 'LogDisk', + 'name' => 'SortColumn', 'in' => 'formData', - 'schema' => [ - 'description' => 'The size of the log disk allocated to the tenant, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '128', - ], + 'schema' => ['title' => '', 'description' => 'Sort column.', 'type' => 'string', 'example' => 'cputime', 'required' => false], ], [ - 'name' => 'ReadOnlyZoneList', + 'name' => 'SortOrder', 'in' => 'formData', 'schema' => [ - 'title' => '非必要不使用该参数，推荐使用接口 ModifyTenantReadonlyReplica管理只读副本', - 'description' => 'Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).', + 'title' => '', + 'description' => 'Sort order.', + 'enumValueTitles' => ['{ "dbname":test, "SQLType":null }' => '{ "dbname":test, "SQLType":null }'], 'type' => 'string', + 'example' => 'desc', 'required' => false, - 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro', - 'deprecated' => true, ], ], [ - 'name' => 'Iops', + 'name' => 'AcceptLanguage', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'example' => '10000', - ], + 'schema' => ['description' => 'Supported language. Valid values:'."\n" + .'- Chinese: zh-CN'."\n" + .'- English: en-US', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'TotalCount' => ['title' => '', 'description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'AnomalySQLList' => [ + 'title' => '', + 'description' => 'The list of anomaly SQL statements.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The data sequence number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DiagnosisRule' => ['title' => '', 'description' => 'The diagnosis rule.', 'type' => 'string', 'example' => '全表扫描有索引未用'], + 'SQLText' => ['title' => '', 'description' => 'The SQL text.', 'type' => 'string', 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC'], + 'Suggestion' => ['title' => '', 'description' => 'The suggestion.', 'type' => 'string', 'example' => '请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况'], + 'DbName' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'example' => 'database1'], + 'RequestTimeUTCString' => ['title' => '', 'description' => 'The request time (UTC).', 'type' => 'string', 'example' => '2022-01-11T07:08:00Z'], + 'CpuTime' => ['title' => '', 'description' => 'The average CPU time. Unit: milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '50.13'], + 'SQLId' => ['title' => '', 'description' => 'The SQL ID.', 'type' => 'string', 'example' => '99E9D3BF****B486239E6C7BC79B****'], + 'Diagnosis' => ['title' => '', 'description' => 'The diagnosis information.', 'type' => 'string', 'example' => '全表扫描有索引未用'], + 'RequestTime' => ['title' => '', 'description' => 'The request time. Unit: milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '50.00'], + 'Executions' => ['title' => '', 'description' => 'The number of executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '89043'], + 'UserName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'tester'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AnomalySQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"DiagnosisRule\\": \\"全表扫描有索引未用\\",\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"Suggestion\\": \\"请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况\\",\\n \\"DbName\\": \\"database1\\",\\n \\"RequestTimeUTCString\\": \\"2022-01-11T07:08:00Z\\",\\n \\"CpuTime\\": 50.13,\\n \\"SQLId\\": \\"99E9D3BF****B486239E6C7BC79B****\\",\\n \\"Diagnosis\\": \\"全表扫描有索引未用\\",\\n \\"RequestTime\\": 50,\\n \\"Executions\\": 89043,\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Anomaly SQL List', + 'description' => 'To optimize user experience, the SQL diagnostic feature of the cloud database has been upgraded. This API has been deprecated and replaced by a new API. For more information, see [Notice: Cloud Database Diagnostic Management API Deprecation](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[Notice: Cloud Database Diagnostic Management API Deprecation](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline).', + 'changeSet' => [ + ['createdAt' => '2023-08-21T11:37:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-04T02:52:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-05T07:31:15.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAnomalySQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n t33h8y08k****\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantResource', + 'translator' => 'machine', ], - 'ModifyTenantSecurityIpGroup' => [ - 'summary' => 'You can call this operation to modify the information on the whitelist group of the tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAvailableCpuResource' => [ + 'summary' => 'The ID of the tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The minimum number of CPU cores per resource unit. ', 'description' => 'The CPU resources available. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'SecurityIpGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The group name of the whitelist group of IP addresses.'."\n" - ."\n" - .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'paytest', - ], + 'schema' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeAvailableCpuResource**. ', 'type' => 'string', 'required' => false, 'example' => 't4pnum**** '], ], [ - 'name' => 'SecurityIps', + 'name' => 'ModifyType', 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', - 'description' => 'The list of IP addresses in the whitelist group.'."\n" - ."\n" - .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', - 'type' => 'string', - 'required' => true, - 'example' => '192.***.*.*"', - ], + 'schema' => ['title' => 'Example 1', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeAvailableCpuResource'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&ModifyType=update'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'resource'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned result of the request.', + 'title' => ' ', + 'description' => 'You can call this operation to query the CPU resources available for a tenant. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => '白名单分组信息。', - 'description' => 'The information of the IP address whitelist group. ', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - 'SecurityIpGroupName' => [ - 'title' => '安全白名单分组名称。', - 'description' => 'The name of the whitelist group. ', - 'type' => 'string', - 'example' => 'paytest', - ], - 'SecurityIps' => [ - 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', - 'description' => 'The list of IP addresses in the IP address whitelist group.'."\n" - ."\n" - .'It is a string separated by commas, and each object is an IP address or a CIDR block.', - 'type' => 'string', - 'example' => '192.***.*.*', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'title' => '', + 'description' => 'List of active CPU resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'XXXX', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['title' => '', 'description' => 'Number of units for the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'MinCpu' => ['title' => '', 'description' => 'Minimum number of CPU cores that must be requested per unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'MaxCpu' => ['title' => '', 'description' => 'Maximum number of CPU cores that can be requested per unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ReviewCode' => [ + 'description' => 'Result of the unitnum change check.', + 'title' => 'Result of the unitnum change check.', + 'type' => 'string', + 'example' => 'UnitNum.Change.Accept', + 'enum' => ['UnitNum.Change.Accept', 'UnitNum.Change.Reject', 'UnitNum.Change.NotRecommend'], + ], + 'Comment' => [ + 'description' => 'Recommendation.', + 'title' => 'Recommendation.', + 'type' => 'string', + 'example' => 'UnitNum.RejectComment.Storage', + 'enum' => ['UnitNum.RejectComment.Storage', 'UnitNum.NotRecommendComment.Storage'], + ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', - 'title' => 'ModifyTenantSecurityIpGroup', - ], - 'DeleteTenants' => [ - 'summary' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"UnitNum\\": 2,\\n \\"MinCpu\\": 2,\\n \\"MaxCpu\\": 10,\\n \\"ReviewCode\\": \\"UnitNum.Change.Accept\\",\\n \\"Comment\\": \\"UnitNum.RejectComment.Storage\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query active CPU resource information.', + 'changeSet' => [ + ['createdAt' => '2024-02-02T12:38:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-04T02:52:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'OpenAPI offline'], ], + 'ramActions' => [], + ], + 'DescribeAvailableMemResource' => [ + 'summary' => 'You can call this operation to query the available memory resource of an OceanBase Database tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9043,189 +5880,206 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantIds', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户的ID列表。 其为Json格式的数组，数组中每个对象都为租户名称的字符串。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DeleteTenants'."\n" - .'&TenantIds=["ob2mr3oae0****", "ob2mr3oae1****"]'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["ob2mr3oae0****", "ob2mr3oae1****"]', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'InstanceId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => false, 'example' => 'ob2mr3oae0****'], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => ['title' => 'The number of resource distribution nodes in the tenant. The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', 'description' => 'The number of resource distribution nodes in the tenant. '."\n" + .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2'], + ], + [ + 'name' => 'CpuNum', + 'in' => 'formData', + 'schema' => ['description' => 'The number of CPU cores. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '14', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '', + 'title' => 'The return result of the request. ', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantIds' => [ - 'title' => '租户的ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[tjd3da45kc****，tdsjc42cm****]', + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Data' => [ + 'title' => 'The available memory size. ', + 'description' => 'The available memory size. ', + 'type' => 'object', + 'properties' => [ + 'MinMem' => ['title' => 'The minimum memory size required for each resource unit, in GB. ', 'description' => 'The minimum memory size required for each resource unit, in GB. ', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'MaxMem' => ['title' => 'The maximum memory size for each resource unit, in GB. ', 'description' => 'The maximum memory size for each resource unit, in GB. ', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UsedMem' => ['title' => 'The number of resource units in the tenant. ', 'description' => 'The number of resource units in the tenant. ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'SafeMem' => ['title' => '内存安全水位', 'description' => 'The maximum allowed memory usage, in GB.', 'type' => 'string', 'example' => '10.0'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"MinMem\\": 5,\\n \\"MaxMem\\": 10,\\n \\"UsedMem\\": 2,\\n \\"SafeMem\\": \\"10.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 5\\n 10\\n 2\\n \\n","errorExample":""}]', + 'title' => 'DescribeAvailableMemResource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAvailableMemResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantIds\\": [\\n \\"tjd3da45kc****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n [tjd3da45kc****，tdsjc42cm****]\\n","errorExample":""}]', - 'title' => 'DeleteTenants', ], - 'DeleteTenantSecurityIpGroup' => [ - 'summary' => 'You can call this operation to delete the information on the whitelist group of the tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAvailableSpec' => [ + 'summary' => 'Queries the available configurations for specification changes of an OceanBase cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'TenantId', + 'name' => 'UpgradeType', 'in' => 'formData', 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', + 'title' => '', + 'description' => 'The type of specification change.', + 'enumValueTitles' => ['downgradedisk' => 'downgradedisk', 'upgradenodenum' => 'upgradenodenum', 'downgradespec' => 'downgradespec', 'upgradespec' => 'upgradespec', 'upgradedisk' => 'upgradedisk', 'downgradenodenum' => 'downgradenodenum'], 'type' => 'string', 'required' => true, - 'example' => 't4louaeei****', + 'example' => 'upgradespec', ], ], [ - 'name' => 'SecurityIpGroupName', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'title' => '安全白名单分组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The group name of the whitelist group of IP addresses.'."\n" - ."\n" - .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'paytest', - ], + 'schema' => ['title' => '', 'description' => 'The node specifications.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The returned result of the request.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => '白名单分组信息。', - 'description' => 'The information of the whitelist group. ', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - 'SecurityIpGroupName' => [ - 'title' => '安全白名单分组名称。', - 'description' => 'The name of the whitelist group. ', - 'type' => 'string', - 'example' => 'paytest', + 'AvailableSpecifications' => [ + 'title' => '', + 'description' => 'The available configuration information of the cluster.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of available configurations for the cluster.', + 'type' => 'object', + 'properties' => [ + 'Spec' => ['description' => 'The specification of the instance.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'title' => ''], + 'InstanceClass' => ['description' => 'The cluster specification information.', 'type' => 'string', 'example' => '4C16GB', 'title' => ''], + 'NodeNum' => [ + 'title' => '', + 'description' => 'The number of nodes.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'example' => '', + ], + 'DiskSizeRange' => [ + 'description' => 'The storage size range.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['title' => '', 'description' => 'The minimum adjustment granularity.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Max' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000'], + 'Min' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + ], + 'title' => '', + 'example' => '', + ], + 'LogDiskSizeRange' => [ + 'description' => 'The log disk size range.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['title' => '', 'description' => 'The minimum adjustment granularity.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Max' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '4000'], + 'Min' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + 'title' => '', + 'example' => '', + ], + 'DiskTypes' => [ + 'title' => '', + 'description' => 'The list of storage types.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The storage type.', 'type' => 'string', 'example' => 'cloud_essd_pl1'], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteTenantSecurityIpGroup', - ], - 'CreateTenantUser' => [ - 'summary' => 'You can call this operation to create an account in a tenant that has access to a database. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"NodeNum\\": [\\n 3\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"LogDiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 4000,\\n \\"Min\\": 100\\n },\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query available configurations for cluster specification changes', + 'changeSet' => [ + ['createdAt' => '2023-12-26T12:16:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-07T07:38:21.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAvailableSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeAvailableZone' => [ + 'summary' => 'Queries the available configurations on the purchase page for an OceanBase cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9233,331 +6087,161 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The name of the database account. You cannot use reserved keywords, such as SYS and root. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_test', - ], - ], - [ - 'name' => 'UserType', + 'name' => 'InstanceType', 'in' => 'formData', 'schema' => [ - 'title' => '数据库账户的类型 Admin：超级账户 Normal：普通账户', - 'description' => 'The type of the database account. Valid values: Admin: the super administrator account. Normal: a general account.', + 'title' => '', + 'description' => 'The instance type.', + 'enumValueTitles' => ['cluster' => 'cluster'], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'Normal', + 'example' => 'cluster', ], ], [ - 'name' => 'UserPassword', + 'name' => 'Series', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', - 'description' => 'The password of the database account. It must be 10 to 32 characters in length and contain three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. The special characters are ! @ # $ % \\ ^ \\ & \\ * ( ) _ + - =', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '!Aliyun4Oceanbase', - ], + 'schema' => ['title' => '', 'description' => 'The series.', 'type' => 'string', 'example' => 'normal', 'required' => false], ], [ - 'name' => 'Roles', + 'name' => 'DeployType', 'in' => 'formData', - 'schema' => [ - 'title' => '用户的角色信息。 对于Oracle模式：无需填写。 对于MySQL模式：超级账户默认为ALL PRIVILEGES，无需填写。 普通用户填写账户的信息，其为Json格式的字符串，默认为一个数组，数组内包含schema（Oracle模式）或Database（MySQL模式)信息和角色信息（Role）。 角色包含以下几类： 读写权限（ReadWrite）：ALL PRIVILEGES ； 只读权限（ReadOnly）：SELECT DDL权限（DDL）：CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW DML权限：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW； DML权限（DML）：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', - 'description' => 'The role of the user account. In Oracle mode, this parameter unspecified is left unspecified. In MySQL mode, the super administrator account has ALL PRIVILEGES, and you can leave this parameter unspecified. You need to specify the account information for a general user account. By default, the account information is a JSON array that contains the information of the role and the schema (Oracle mode) or database (MySQL mode). Valid values: ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. ReadOnly: a role that has only the read-only privilege SELECT. DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]', - ], + 'schema' => ['title' => '', 'description' => 'The deployment plan.', 'type' => 'string', 'example' => 'multiple', 'required' => false], ], [ - 'name' => 'Description', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库描述信息。', - 'description' => 'The description of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test database', - ], + 'schema' => ['title' => '', 'description' => 'The node plan.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'required' => false], ], [ - 'name' => 'EncryptionType', + 'name' => 'ObVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '加密方式。', - 'description' => '加密方式。', - 'type' => 'string', - 'required' => false, - 'example' => 'RAS', - ], + 'schema' => ['title' => '', 'description' => 'The OceanBase version number.', 'type' => 'string', 'example' => '3.2.4.4', 'required' => false], ], [ - 'name' => 'GlobalPermissions', + 'name' => 'CpuArch', 'in' => 'formData', - 'schema' => [ - 'title' => '全局权限信息', - 'type' => 'string', - 'example' => 'Encrypt,Decrypt', - ], + 'schema' => ['title' => '', 'description' => 'The CPU architecture.', 'type' => 'string', 'required' => false, 'example' => 'x86'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantUser' => [ - 'title' => 'The return result of the request. ', - 'description' => 'The list of database accounts in the tenant.', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The returned data.', 'type' => 'object', - 'items' => [ - 'description' => 'The list of database accounts in the tenant. ', - 'type' => 'object', - 'properties' => [ - 'UserType' => [ - 'name' => 'UserType', - 'title' => 'The TenantUser schema. ', - 'description' => 'The type of the database account. Valid values: - Admin: the super administrator account. - Normal: a general account.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - 'nullToEmpty' => false, - 'backendName' => 'UserType', - 'valueMapping' => [ - 'cases' => [ - [ - 'value' => 'Admin', - 'targetValue' => 'Admin', - ], - [ - 'value' => 'Normal', - 'targetValue' => 'Normal', - ], - ], - ], - ], - 'Roles' => [ - 'name' => 'Roles', - 'title' => 'The type of the database account. Valid values: '."\n" - .' - Admin: the super administrator account. '."\n" - .' - Normal: a general account. ', - 'description' => 'The roles of the accounts.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The roles of the accounts. ', - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'name' => 'Database', - 'title' => 'The Roles schema. ', - 'description' => 'The name of the database.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'db_pay1', - 'nullToEmpty' => false, - 'backendName' => 'Database', - ], - 'Role' => [ - 'name' => 'Role', - 'title' => 'The name of the database. ', - 'description' => 'The role of the account. In Oracle mode, a role is a schema-level role. Valid values: - ReadWrite: a role that has the read and write privileges, including CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. - ReadOnly: a role that has only the read-only privilege SELECT.'."\n" - .'In MySQL mode, a role is a database-level role. Valid values: - ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. - ReadOnly: a role that has only the read-only privilege SELECT. - DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. - DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" - .'* By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ReadOnly', - 'nullToEmpty' => false, - 'backendName' => 'Role', - 'valueMapping' => [ - 'cases' => [ - [ - 'value' => 'OnlyRead', - 'targetValue' => 'OnlyRead', + 'properties' => [ + 'AvailableZones' => [ + 'title' => '', + 'description' => 'The zone information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The zone list information.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Zones' => ['title' => '', 'description' => 'The zone list.', 'type' => 'string', 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j'], + 'Channel' => ['description' => 'The order source.'."\n" + ."\n" + .'- PUBLIC'."\n" + ."\n" + .'- FINANCE.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'DeployType' => ['title' => '', 'description' => 'The deployment plan.', 'type' => 'string', 'example' => 'multiple'], + 'InstanceType' => ['title' => '', 'description' => 'The instance type.', 'type' => 'string', 'example' => 'cluster'], + 'Series' => ['title' => '', 'description' => 'The series.', 'type' => 'string', 'example' => 'normal'], + 'SupportSpecifications' => [ + 'title' => '', + 'description' => 'The node specifications.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node specifications list information.', + 'type' => 'object', + 'properties' => [ + 'Spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'title' => ''], + 'InstanceClass' => ['description' => 'The cluster specification information.', 'type' => 'string', 'example' => '4C16GB', 'title' => ''], + 'DiskTypes' => [ + 'title' => '', + 'description' => 'The storage type.', + 'type' => 'array', + 'items' => ['description' => 'The storage type list information.', 'type' => 'string', 'example' => 'cloud_essd_pl1', 'title' => ''], + 'example' => '', + ], + 'DiskSizeRange' => [ + 'title' => '', + 'description' => 'The storage size.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['title' => '', 'description' => 'The minimum adjustment granularity.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Max' => ['title' => '', 'description' => 'The maximum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000'], + 'Min' => ['title' => '', 'description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], ], - [ - 'value' => 'ReadWrite', - 'targetValue' => 'ReadWrite', + 'example' => '', + ], + 'SupportEngineVersions' => [ + 'title' => '', + 'description' => 'The version.', + 'type' => 'array', + 'items' => [ + 'description' => 'The version list information.', + 'type' => 'object', + 'properties' => [ + 'ObVersion' => ['description' => 'The OceanBase Server version number.', 'type' => 'string', 'example' => '3.2.4.4', 'title' => ''], + 'SupportIsolationOptimization' => ['title' => '', 'description' => 'Indicates whether isolation is supported.', 'type' => 'boolean', 'default' => 'false', 'example' => 'true'], + 'SupportReplicaModes' => [ + 'title' => '', + 'description' => 'The number of full-featured replicas.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The number of full-featured replicas.', 'type' => 'string', 'example' => '3F'], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'extendType' => 'true', + 'CpuArch' => ['title' => '', 'description' => 'The CPU architecture.', 'type' => 'string', 'example' => 'x86'], ], + 'title' => '', 'example' => '', - 'nullToEmpty' => false, - 'backendName' => 'Roles', - 'itemName' => 'Roles', - ], - 'UserStatus' => [ - 'name' => 'UserStatus', - 'title' => 'The role of the account. '."\n" - .'In Oracle mode, a role is a schema-level role. Valid values: '."\n" - ."\n" - .'- ReadWrite: a role that has the read and write privileges, including CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. '."\n" - .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" - ."\n" - .'In MySQL mode, a role is a database-level role. Valid values: '."\n" - ."\n" - .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" - .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" - .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" - .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" - ."\n" - .'>
By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', - 'description' => 'The status of the database account. Valid values: - Locked: The account is locked. - ONLINE: The account is unlocked. The default status of a new account is ONLINE after it is created.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ONLINE', - 'nullToEmpty' => false, - 'backendName' => 'UserStatus', - 'valueMapping' => [ - 'cases' => [ - [ - 'value' => 'Normal', - 'targetValue' => 'Normal', - ], - [ - 'value' => 'Locked', - 'targetValue' => 'Locked', - ], - ], - ], - ], - 'UserName' => [ - 'name' => 'UserName', - 'title' => 'The status of the database account. Valid values: '."\n" - .'- Locked: The account is locked. '."\n" - .'- ONLINE: The account is unlocked. The default status of a new account is ONLINE after it is created. ', - 'description' => 'The name of the database account. ', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pay_test', - 'nullToEmpty' => false, - 'backendName' => 'UserName', - ], - ], - 'extendType' => 'true', - ], - 'example' => '', - 'properties' => [ - 'UserType' => [ - 'type' => 'string', - ], - 'Roles' => [ - 'title' => '账户对应的角色权限信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'title' => '数据库名称', - 'type' => 'string', - 'example' => 'db_pay1', - ], - 'Role' => [ - 'title' => '拥有的角色。 对于Oracle模式，角色为schema级别，其可分为 - ReadWrite：读写权限，包括CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE； - ReadOnly：只读权限，SELECT'."\n" - .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。'."\n" - .'* 另外Oracle账户对自己的schema有默认的读写权限，这里不会列出。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - ], ], 'example' => '', ], - 'UserStatus' => [ - 'title' => '数据库账号的状态。 - Locked：锁定 - ONLINE：解锁 创建完的账户默认为ONLINE状态', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'UserName' => [ - 'title' => '数据库账号名称。', - 'type' => 'string', - 'example' => 'pay_test', - ], - 'GlobalPermissions' => [ - 'title' => '全局权限', - 'type' => 'string', - 'example' => 'Encrypt,Decrypt', - ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableZones\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Zones\\": \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\",\\n \\"Channel\\": \\"PUBLIC\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"InstanceType\\": \\"cluster\\",\\n \\"Series\\": \\"normal\\",\\n \\"SupportSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"SupportEngineVersions\\": [\\n {\\n \\"ObVersion\\": \\"3.2.4.4\\",\\n \\"SupportIsolationOptimization\\": true,\\n \\"SupportReplicaModes\\": [\\n \\"3F\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"CpuArch\\": \\"x86\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query available configurations for cluster creation', + 'changeSet' => [ + ['createdAt' => '2024-04-15T11:26:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantUser\\": {\\n \\"UserType\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Normal\\n \\n db_pay1\\n ReadOnly\\n \\n ONLINE\\n pay_test\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'CreateTenantUser', - 'requestParamsDescription' => 'You can call this operation to create an account in a tenant that has access to a database. ', + 'ramActions' => [], ], - 'DescribeTenantUsers' => [ - 'summary' => 'You can call this operation to query all accounts in a tenant that have access to the database. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeBackupEncryptedString' => [ + 'summary' => 'DescribeBackupEncryptedString', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9565,411 +6249,418 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => ' The return result of the request. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob4wibn0abo9uo'], ], [ - 'name' => 'SearchKey', + 'name' => 'TenantId', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 'txxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询列表的删选关键字。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'required' => false, - 'example' => 'pay', + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The return data of the request.', + 'type' => 'object', + 'properties' => [ + 'BackupInfoJson' => ['description' => 'Information about the overall encrypted backup data.', 'type' => 'string', 'example' => 'xxxxxxxx（加密串）', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"BackupInfoJson\\": \\"xxxxxxxx（加密串）\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain backup information with overall encryption', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeBackupSetDownloadLink' => [ + 'summary' => 'You can call this operation to query the link for downloading a backup set of OceanBase Database.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The database privileges of the account. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => ' The return result of the request. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'DownloadTaskId', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeTenantUsers**. ', - 'type' => 'string', - 'required' => false, - 'example' => 'pay_test', - ], + 'schema' => ['description' => 'The ID of the download task corresponding to the target backup set.', 'type' => 'string', 'required' => true, 'example' => '1000002', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The name of the database account. '."\n" - .'You cannot use reserved keywords, such as SYS and root. ', + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '租户中的数据库账号总数。', - 'description' => 'The role of the account. '."\n" - .'In Oracle mode, a role is a schema-level role. Valid values: '."\n" - .'- ReadWrite: a role that has the read and write privileges, including: CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. '."\n" - .'- ReadOnly: a role that has only the read-only privilege SELECT.'."\n" - .'In MySQL mode, a role is a database-level role. Valid values: '."\n" - .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" - .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" - .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" - .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" - ."\n" - .'>
By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The name of the database account. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantUsers' => [ - 'title' => '租户中的数据库账号信息', - 'description' => 'The type of the database account. Valid values: '."\n" - .'- Admin: the super administrator account. '."\n" - .'- NORMAL: a general account. ', - 'type' => 'array', - 'items' => [ - 'description' => 'Example 1', - 'type' => 'object', - 'properties' => [ - 'UserType' => [ - 'title' => '数据库账号类型。 - Admin：超级账户 - Normal：普通账户', - 'description' => ' ', - 'type' => 'string', - 'example' => ' NORMAL', - ], - 'Description' => [ - 'title' => '数据库账号的描述信息。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'use for test', - ], - 'Databases' => [ - 'title' => '账号具备的数据库权限信息。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'title' => '数据库(schema)名称', - 'description' => '', - 'type' => 'string', - 'example' => 'db_pay1', - ], - 'Role' => [ - 'title' => '拥有的角色。 对于Oracle模式，角色为schema级别，其可分为 - ReadWrite：读写权限，包括CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE； - ReadOnly：只读权限，SELECT'."\n" - .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。'."\n" - .'* 另外Oracle账户对自己的schema有默认的读写权限，这里不会列出。', - 'description' => '', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'Table' => [ - 'title' => '表的名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'tbl_pay1', - ], - 'Privileges' => [ - 'type' => 'string', - ], - ], - ], - ], - 'UserStatus' => [ - 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'UserName' => [ - 'title' => '数据库账号名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'pay_test', - ], - 'TenantId' => [ - 'title' => '所属租户Id', - 'description' => '所属租户Id', - 'type' => 'string', - 'example' => 'tshfs3****', - ], - 'InstanceId' => [ - 'title' => '所属集群Id', - 'description' => '所属集群Id', - 'type' => 'string', - 'example' => 'obshc32****', - ], - 'GlobalPermissions' => [ - 'title' => '全局权限信息', - 'type' => 'string', - 'example' => 'Encrypt,Decrypt', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => ['description' => 'The ID of the download task corresponding to the target backup set.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000002', 'title' => ''], + 'DownloadTaskStatus' => ['description' => 'The status of the download task corresponding to the target backup set.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'DownloadTaskCreateTime' => ['description' => 'The time when the download task corresponding to the target backup set was created.', 'type' => 'string', 'example' => '2020-05-22T17:04:18', 'title' => ''], + 'BackupRestorableTime' => ['description' => 'The restorable time of the backup set.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss', 'title' => ''], + 'BackupSetId' => ['description' => 'The ID of the target backup set.', 'type' => 'string', 'example' => 'bak-4n****gacpa8', 'title' => ''], + 'InternalUrl' => ['description' => 'The internal URL.', 'type' => 'string', 'example' => 'http://bucket.oss-region-internal.aliyuncs.com/xxxxx', 'title' => ''], + 'UrlExpiredTime' => ['description' => 'The expiration time of the URL.', 'type' => 'string', 'example' => '2024-01-04 17:39:49', 'title' => ''], + 'UrlAliveTime' => ['description' => 'The validity period of the URL, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeBackupSetDownloadLink', + 'changeSet' => [ + ['createdAt' => '2026-02-11T03:27:37.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-01-16T07:29:39.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeBackupSetDownloadLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUsers\\": [\\n {\\n \\"UserType\\": \\"Normal\\",\\n \\"Description\\": \\"use for test\\",\\n \\"Databases\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"Privileges\\": \\"select,delete,update\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum**** \\",\\n \\"InstanceId\\": \\"obshc32****\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n Normal\\n use for test\\n \\n db_pay1\\n ReadOnly\\n tbl_pay1
\\n \\n Normal\\n pay_test\\n \\n","errorExample":""}]', - 'title' => 'DescribeTenantUsers', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 1000002,\\n \\"DownloadTaskStatus\\": \\"RUNNING\\",\\n \\"DownloadTaskCreateTime\\": \\"2020-05-22T17:04:18\\",\\n \\"BackupRestorableTime\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"BackupSetId\\": \\"bak-4n****gacpa8\\",\\n \\"InternalUrl\\": \\"http://bucket.oss-region-internal.aliyuncs.com/xxxxx\\",\\n \\"UrlExpiredTime\\": \\"2024-01-04 17:39:49\\",\\n \\"UrlAliveTime\\": 3600\\n }\\n}","type":"json"}]', ], - 'DescribeTenantUserRoles' => [ - 'summary' => 'You can call this operation to obtain the account authorization information of the tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCharset' => [ + 'summary' => 'Queries the character set information of an OceanBase tenant.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'TenantMode', 'in' => 'formData', 'schema' => [ - 'title' => 'TenantId: 租户id, 如果传入的是mysql模式租户Id, 则返回mysql模式下普通用户的权限配置信息; 如果传入的是oracle租户Id, 则返回的是oracle普通用户的权限配置信息', - 'description' => 'The ID of the tenant. If you specify the ID of a tenant in MySQL mode, the privilege configuration of the regular user in MySQL mode is returned. If you specify the ID of a tenant in Oracle mode, the privilege configuration of the regular user in Oracle mode is returned.', + 'title' => '', + 'description' => 'The tenant mode.'."\n" + .'Valid values: Oracle and MySQL. '."\n" + .'For more information, see DescribeInstanceTenantModes.', 'type' => 'string', - 'required' => false, - 'example' => 't4pnum****', + 'required' => true, + 'docRequired' => true, + 'example' => 'Oracle', + 'enum' => ['MySQL', 'Oracle'], ], ], + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The edition of the instance. Valid values: - normal (default): Cluster Edition (cloud disk) - normal_ssd: Cluster Edition (local disk) - history: Archive Database Cluster Edition.', 'type' => 'string', 'example' => 'normal', 'required' => false], + ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'title' => '对于 Oracle 模式，角色为 schema 级别，其可分为'."\n" - .'● ReadWrite：读写权限，包括 CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE；'."\n" - .'● ReadOnly：只读权限，SELECT'."\n" - .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类：'."\n" - .'● ReadWrite：读写权限，包括 ALL PRIVILEGES；'."\n" - .'● ReadOnly：只读权限，包括 SELECT；'."\n" - .'● DDL: DDL 权限，包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW；'."\n" - .'● DML: DML 权限，包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', - 'description' => 'The list of roles of the user. '."\n" - .'Valid values: '."\n" - ."\n" - .'ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES.'."\n" - .'ReadOnly: a role that has only the read-only privilege SELECT.'."\n" - .'DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW.'."\n" - .'DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Charset' => [ + 'title' => '', + 'description' => 'The list of character sets.', 'type' => 'array', 'items' => [ - 'description' => 'The return result of the request.', - 'type' => 'string', - 'example' => 'DDL', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Charset' => ['title' => '', 'description' => 'The character set name.', 'type' => 'string', 'example' => 'utf8'], + 'Collations' => [ + 'title' => '', + 'description' => 'The collection of collations.', + 'type' => 'array', + 'items' => ['description' => 'The collection of collations.', 'type' => 'string', 'example' => '["utf8mb4_general_ci","utf8mb4_bin","binary"]', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 1000 => [ - [ - 'errorCode' => 'E001R000', - 'errorMessage' => 'Error found, please try agent later.', - ], - ], - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Charset\\": [\\n {\\n \\"Charset\\": \\"utf8\\",\\n \\"Collations\\": [\\n \\"[\\\\\\"utf8mb4_general_ci\\\\\\",\\\\\\"utf8mb4_bin\\\\\\",\\\\\\"binary\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve character set', + 'changeSet' => [ + ['createdAt' => '2023-08-21T11:36:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-17T02:26:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-28T06:07:38.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": [\\n \\"DDL\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DDL\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeTenantUserRoles', + 'ramActions' => [], ], - 'ModifyTenantUserDescription' => [ - 'summary' => 'You can call this operation to modify the description of a specified account in a tenant. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDataBackupSet' => [ + 'summary' => 'You can call this operation to query the information about the backup sets of an OceanBase cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'TenantId', + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', + 'title' => '', + 'description' => 'The status of the backup sets to be queried.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', + 'required' => false, + 'example' => 'DONE', + 'enum' => ['BEGINNING', 'DOING', 'DONE', 'FAILED', 'OVERDUE', 'UNKNOWN'], ], ], [ - 'name' => 'UserName', + 'name' => 'BackupObjectType', 'in' => 'formData', 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The description of the database. ', + 'title' => '', + 'description' => 'The object type of the backup sets to be queried.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_test', + 'required' => false, + 'example' => 'tenant', + 'enum' => ['cluster', 'tenant', 'table', 'database'], ], ], [ - 'name' => 'Description', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库描述信息。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyTenantUserDescription**. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'this is a test database', - ], + 'schema' => ['description' => 'The backup start time, in the format of *yyyy-MM-dd* T *HH:mm:ss* Z (UTC time).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-12-27T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The backup end time.', 'type' => 'string', 'required' => false, 'example' => '2023-01-06T15:59:59Z', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number, which takes effect in a pagination query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'Example 1', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'You can call this operation to modify the description of a specified account in a tenant. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'TotalCount' => ['description' => 'The total count. ', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup sets.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The backup end time.', 'type' => 'string', 'example' => '2023-04-13T03:38:10Z', 'title' => ''], + 'Status' => ['description' => 'The status of the backup set.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'Type' => ['description' => 'The backup type.', 'type' => 'string', 'example' => 'manual', 'title' => ''], + 'StartTime' => ['description' => 'The backup start time.', 'type' => 'string', 'example' => '2020-05-22T17:04:18', 'title' => ''], + 'DataSize' => ['description' => 'The size of the backup set.', 'type' => 'integer', 'format' => 'int32', 'example' => '31457280', 'title' => ''], + 'Policy' => ['description' => 'The backup strategy.', 'type' => 'string', 'example' => 'automated', 'title' => ''], + 'SetId' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'example' => 'imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70', 'title' => ''], + 'Method' => ['description' => 'The backup method.', 'type' => 'string', 'example' => 'logical', 'title' => ''], + 'Checkpoint' => ['description' => 'The checkpoint.', 'type' => 'string', 'example' => '2023-05-15T07:11:08Z', 'title' => ''], + 'DataVersion' => ['description' => 'The data version.', 'type' => 'integer', 'format' => 'int32', 'example' => '1678847020352', 'title' => ''], + 'BackupObjectType' => ['title' => '', 'description' => 'The backup object type.', 'type' => 'string', 'example' => 'cluster'], + 'BackupObjects' => [ + 'title' => '', + 'description' => 'The backup objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup objects.', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'test-****way', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'ob2mr3oae0****', 'title' => ''], + 'DatabaseTablesList' => [ + 'description' => 'The databases and tables in the backup set.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of databases and tables in the backup set.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'sms_pre', 'title' => ''], + 'Tables' => [ + 'description' => 'The tables.', + 'type' => 'array', + 'items' => ['description' => 'The details of tables.', 'type' => 'string', 'example' => '{\'Tables\': []}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'BackupResults' => [ + 'title' => '', + 'description' => 'The backup results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup results.', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'container-opa-****-02', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'ob2mr3oae0****'."\n", 'title' => ''], + 'TableBackupResults' => [ + 'description' => 'The table backup results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of table backup results.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'order_ce****_online', 'title' => ''], + 'Table' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'tr_sale_order_****', 'title' => ''], + 'Status' => ['description' => 'The backup status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'Create tag success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DownloadTaskStatus' => ['title' => '', 'description' => 'The status of the download task corresponding to the target backup set.', 'type' => 'string', 'example' => 'not_exist'], + 'DownloadTaskId' => ['title' => '', 'description' => 'The ID of the download task corresponding to the target backup set.', 'type' => 'integer', 'format' => 'int64', 'example' => '100***012'], + 'Validity' => [ + 'title' => '', + 'description' => 'The validity, which can be left empty.', + 'type' => 'string', + 'example' => 'VALID', + 'enum' => ['VALID', 'INVALID'], + ], + 'Progress' => ['title' => '', 'description' => 'The backup progress.', 'type' => 'string', 'example' => '52'], + 'StorageClass' => ['title' => '', 'description' => 'The type of the backup set. Valid values: '."\n" + .'* standard: level-1 backup '."\n" + .'* archive: second backup', 'type' => 'string', 'example' => 'standard'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2023-04-13T03:38:10Z\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Type\\": \\"manual\\",\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"DataSize\\": 31457280,\\n \\"Policy\\": \\"automated\\",\\n \\"SetId\\": \\"imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70\\",\\n \\"Method\\": \\"logical\\",\\n \\"Checkpoint\\": \\"2023-05-15T07:11:08Z\\",\\n \\"DataVersion\\": 1678847020352,\\n \\"BackupObjectType\\": \\"cluster\\",\\n \\"BackupObjects\\": [\\n {\\n \\"ClusterName\\": \\"test-****way\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\",\\n \\"DatabaseTablesList\\": [\\n {\\n \\"Database\\": \\"sms_pre\\",\\n \\"Tables\\": [\\n \\"{\'Tables\': []}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"BackupResults\\": [\\n {\\n \\"ClusterName\\": \\"container-opa-****-02\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\\\n\\",\\n \\"TableBackupResults\\": [\\n {\\n \\"Database\\": \\"order_ce****_online\\",\\n \\"Table\\": \\"tr_sale_order_****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Message\\": \\"Create tag success\\"\\n }\\n ]\\n }\\n ],\\n \\"DownloadTaskStatus\\": \\"not_exist\\",\\n \\"DownloadTaskId\\": 0,\\n \\"Validity\\": \\"VALID\\",\\n \\"Progress\\": \\"52\\",\\n \\"StorageClass\\": \\"standard\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDataBackupSet', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeDataBackupSet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantUserDescription', ], - 'ModifyTenantUserPassword' => [ - 'summary' => 'You can call this operation to change the logon password of a specified account in a tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDatabases' => [ + 'summary' => 'You can call this operation to query databases in a tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9977,115 +6668,155 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'UserName', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_test', - ], + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 't4pnum****'], ], [ - 'name' => 'TenantId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=ModifyTenantUserPassword'."\n" - .'&UserName=pay_test'."\n" - .'&TenantId=ob2mr3oae0****'."\n" - .'&UserPassword=!Aliyun4Oceanbase'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => 'The number of the page to return. Start value: 1. Default value: 1.', 'description' => 'The number of the page returned. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'UserPassword', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', - 'description' => 'You can call this operation to change the logon password of a specified account in a tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '!Aliyun4Oceanbase', - ], + 'schema' => ['title' => 'The number of rows to return on each page. Maximum value: 100. Default value: 10.', 'description' => 'The number of rows returned on each page. '."\n" + .'- Maximum value: 100. '."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'InstanceId', + 'name' => 'DatabaseName', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The name of the database. You cannot use reserved keywords, such as test and mysql. ', 'description' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', 'type' => 'string', 'required' => false, 'example' => 'sms_pre'], ], [ - 'name' => 'EncryptionType', + 'name' => 'SearchKey', 'in' => 'formData', - 'schema' => [ - 'title' => '加密方式。', - 'description' => '加密方式。', - 'type' => 'string', - 'required' => false, - 'example' => 'RSA', - ], + 'schema' => ['title' => 'The search keyword. ', 'description' => 'The search keyword. ', 'type' => 'string', 'required' => false, 'example' => 'pay'], + ], + [ + 'name' => 'WithTables', + 'in' => 'formData', + 'schema' => ['title' => 'Specifies whether to return the information of tables in the database. Set the value to true for Oracle tenants, and to false for MySQL tenants. ', 'description' => 'Specifies whether to return the information about tables in the database.'."\n" + .'Default value: false. '."\n" + .'> The operation may time out if the database contains a large number of tables.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '集群id', 'description' => 'The ID of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob****n0abo9uo'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '', + 'title' => 'The return result of the request. ', + 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'TotalCount' => ['title' => 'The total number of databases in the tenant. ', 'description' => 'The total number of databases in the tenant. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Databases' => [ + 'title' => 'The list of databases in the tenant. ', + 'description' => 'The list of databases in the tenant. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of databases in the tenant. ', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => 'The status of the database. Valid values: - ONLINE: The database is running. - DELETING: The database is being deleted.', 'description' => 'The status of the database. Valid values: '."\n" + .'- ONLINE: The database is running. '."\n" + .'- DELETING: The database is being deleted.', 'type' => 'string', 'example' => 'ONLINE'], + 'Description' => ['title' => 'The description of the database. ', 'description' => 'The description of the database. ', 'type' => 'string', 'example' => 'test db'], + 'Encoding' => ['title' => 'The encoding standard of the database. Encoding standards such as utf8mb4 and GBK are supported. ', 'description' => 'The encoding standard of the database. Encoding standards such as utf8mb4 and GBK are supported. ', 'type' => 'string', 'example' => 'utf8mb4'], + 'DbType' => ['title' => 'The database type.', 'description' => 'The database type.', 'type' => 'string', 'example' => 'mysql'], + 'DatabaseName' => ['title' => 'The name of the database. ', 'description' => 'The name of the database. ', 'type' => 'string', 'example' => 'sms_pre'], + 'CreateTime' => ['title' => 'The time when the database was created.', 'description' => 'The time when the database was created.', 'type' => 'string', 'example' => '2022-02-21 15:41:06'], + 'Users' => [ + 'title' => 'The accounts that have privileges on the database. ', + 'description' => 'The list of accounts that are granted privileges on this database.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of accounts that are granted privileges on this database.', + 'type' => 'object', + 'properties' => [ + 'UserType' => ['title' => 'The type of the account. Valid values: - Admin: the super administrator account. - Normal: a general account.', 'description' => 'The type of the account. Valid values: '."\n" + .'- Admin: the super administrator account. '."\n" + .'- Normal: a general account.', 'type' => 'string', 'example' => 'Normal'], + 'Role' => ['title' => 'The role of the account. In MySQL mode, a role is a database-level role. Valid values: - ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. - ReadOnly: a role that has only the read-only privilege SELECT. - DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. - DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', 'description' => 'The role of the account. '."\n" + .'In MySQL mode, a role is a database-level role. Valid values: '."\n" + .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" + .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', 'type' => 'string', 'example' => 'ReadOnly'], + 'UserName' => ['title' => 'The name of the account. ', 'description' => 'The name of the account. ', 'type' => 'string', 'example' => 'user_pay_ro'], + 'Privileges' => ['description' => 'If you have granted custom privileges on the database, this parameter indicates the custom privileges, separated by commas (,). Otherwise, no data is returned for this parameter.', 'type' => 'string', 'example' => 'select,delete,update', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TenantId' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4pnum****'], + 'Tables' => [ + 'title' => 'The information about the database tables.', + 'description' => 'The list of database tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of database tables.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['title' => 'The name of the database table.', 'description' => 'The name of the database table. ', 'type' => 'string', 'example' => 'testTables'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RequiredSize' => ['title' => 'The storage space required, in GB.', 'description' => 'The storage space required, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '5.67 GB'], + 'DataSize' => ['title' => 'The actual data size, in GB.', 'description' => 'The actual data size, in GB. '."\n" + .'>This parameter is no longer used in later versions. RequiredSize is used instead.>', 'type' => 'number', 'format' => 'double', 'example' => '5.67 GB'], + 'Collation' => ['title' => '字符序', 'description' => 'The collation.', 'type' => 'string', 'example' => 'utf8mb4_general_ci'], + 'InstanceId' => ['title' => '所属集群Id', 'description' => 'The ID of the cluster to which the tenant belongs.', 'type' => 'string', 'example' => 'obsdh2f****'], + 'TenantName' => ['title' => '租户名', 'description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'tenantABC'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Databases\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"Description\\": \\"test db\\",\\n \\"Encoding\\": \\"utf8mb4\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DatabaseName\\": \\"sms_pre\\",\\n \\"CreateTime\\": \\"2022-02-21 15:41:06\\",\\n \\"Users\\": [\\n {\\n \\"UserType\\": \\"Normal\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"UserName\\": \\"user_pay_ro\\",\\n \\"Privileges\\": \\"select,delete,update\\"\\n }\\n ],\\n \\"TenantId\\": \\"t4pnum****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"testTables\\"\\n }\\n ],\\n \\"RequiredSize\\": 0,\\n \\"DataSize\\": 0,\\n \\"Collation\\": \\"utf8mb4_general_ci\\",\\n \\"InstanceId\\": \\"obsdh2f****\\",\\n \\"TenantName\\": \\"tenantABC\\"\\n }\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n ONLINE\\n test db\\n utf8mb4\\n mysql\\n sms_pre\\n 2022-02-21 15:41:06\\n \\n Normal\\n ReadOnly\\n user_pay_ro\\n \\n t33h8y08k****\\n \\n testTables\\n \\n 0\\n 5.67\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'DescribeDatabases', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantUserPassword', ], - 'ModifyTenantUserRoles' => [ - 'summary' => 'You can call this operation to modify the database privileges of a specified account in a tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstance' => [ + 'summary' => 'Queries the details of an OceanBase cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10093,431 +6824,787 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The role of the database account. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_test', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyTenantUserRoles**. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'UserRole', - 'in' => 'formData', - 'schema' => [ - 'title' => '如果是mysql模式, 则传入所有的数据库和对应的权限, 如果有没传入的数据库, 则视为撤销在该数据库上的权限, 如果取消所有的数据库权限, 则传入为空, 即UserRole:[];'."\n" - .'如果是oracle模式, 则只传入对应需要修改的数据库名, 表名, 以及相应的权限.', - 'description' => 'The type of the account. Valid values: '."\n" - .'- Admin: the super administrator account. '."\n" - .'- Normal: a general account. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"Database":"20210824160559","Role":"readwrite"}]', - ], - ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The type of the privilege modification operation. '."\n" - .'Valid values: '."\n" - .'update: updates all privileges. This is the default value. '."\n" - .'add: adds a privilege. '."\n" - .'delete: deletes a privilege. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'ModifyType', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '如果是mysql模式, 则不传该值;'."\n" - .'如果是oracle模式, 则传入对应的操作: * 添加:ADD'."\n" - .'* 删除: DELETE'."\n" - .'* 更新: UPDATE ', - 'description' => 'The name of the table. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', - ], + 'schema' => ['title' => 'The number of the page to return.
Start value: 1. Default value: 1.', 'description' => 'Page number for paged query.'."\n" + ."\n" + .'- Starting value: 1.'."\n" + ."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'UserType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '用户类型', - 'type' => 'string', - 'example' => 'Normal', - 'enum' => [], - ], - ], - [ - 'name' => 'GlobalPermissions', - 'in' => 'formData', - 'schema' => [ - 'title' => '全局权限', - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The list of database privileges of the account. ', + 'title' => 'The return result of the request. ', + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'TenantUser' => [ - 'title' => '租户中的数据库账号信息。', - 'description' => 'The ID of the tenant. ', + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Instance' => [ + 'title' => 'The information of the OceanBase cluster. ', + 'description' => 'The information of the OceanBase cluster.', 'type' => 'object', 'properties' => [ - 'UserRole' => [ - 'title' => '账号类型。 Admin：超级账户 Normal：普通账户', - 'description' => 'The name of the database (MySQL mode) or schema (Oracle mode). ', - 'type' => 'array', - 'items' => [ - 'description' => 'The request ID. ', - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'title' => '数据库(schema)名称', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=ModifyTenantUserRoles'."\n" - .'&UserName=pay_test'."\n" - .'&TenantId=ob2mr3oae0****'."\n" - .'&UserRole=[{"Database":"20210824160559","Role":"readwrite"}]'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&ModifyType=update'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'example' => 'db_pay1', + 'InstanceId' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'InstanceName' => ['title' => 'The name of the OceanBase cluster. ', 'description' => 'The name of the OceanBase cluster.', 'type' => 'string', 'example' => 'ob4test'], + 'InstanceClass' => ['title' => 'The specifications of the cluster.
You can specify one of the following four plans:
- 8C32G: indicates 8 CPU cores and 32 GB of memory.
- 14C70G: indicates 14 CPU cores and 70 GB of memory.
- 30C180G: indicates 30 CPU cores and 180 GB of memory.
- 62C400G: indicates 62 CPU cores and 400 GB of memory. ', 'description' => 'The specifications of the cluster.
The following plans are supported:
'."\n" + ."\n" + .'- 4C16GB: 4-core 16 GB.'."\n" + ."\n" + .'- 8C32GB: 8-core 32 GB.'."\n" + ."\n" + .'- 14C70GB: 14-core 70 GB.'."\n" + ."\n" + .'- 24C120GB: 24-core 120 GB.'."\n" + ."\n" + .'- 30C180GB: 30-core 180 GB.'."\n" + ."\n" + .'- 62C400GB: 62-core 400 GB.'."\n" + ."\n" + .'- 104C600GB: 104-core 600 GB.'."\n" + ."\n" + .'- 16C70GB: 16-core 70 GB.'."\n" + ."\n" + .'- 32C160GB: 32-core 160 GB.'."\n" + ."\n" + .'- 64C380GB: 64-core 380 GB.'."\n" + ."\n" + .'- 20C32GB: 20-core 32 GB.'."\n" + ."\n" + .'- 40C64GB: 40-core 64 GB.'."\n" + ."\n" + .'- 16C32GB: 16-core 32 GB.'."\n" + ."\n" + .'- 32C70GB: 32-core 70 GB.'."\n" + ."\n" + .'- 64C180GB: 64-core 180 GB.'."\n" + ."\n" + .'- 32C180GB: 32-core 180 GB.'."\n" + ."\n" + .'- 64C400GB: 64-core 400 GB.', 'type' => 'string', 'example' => '14C70G'], + 'Series' => ['title' => 'The series of the OceanBase cluster. Valid values:
- NORMAL: the high availability edition.
- BASIC: the basic edition.', 'description' => 'The series of the instance.'."\n" + ."\n" + .'- normal (default): Standard Cluster Edition (cloud disk).'."\n" + ."\n" + .'- normal\\_ssd: Standard Cluster Edition (local disk).'."\n" + ."\n" + .'- history: Archive Database Cluster Edition.'."\n" + ."\n" + .'- normal\\_kv: OBKV cluster.'."\n" + ."\n" + .'- normal\\_hg: Innovative application cluster.', 'type' => 'string', 'example' => 'Normal'], + 'PayType' => ['title' => 'The billing method of the OceanBase cluster. Valid values:
- PREPAY: the subscription billing method.
- POSTPAY: the pay-as-you-go billing method.', 'description' => 'The billing method of the OceanBase cluster.'."\n" + ."\n" + .'- PREPAY: subscription.'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY'], + 'CreateTime' => ['title' => 'The time in UTC when the cluster was created. ', 'description' => 'The time when the cluster was created. The time is in UTC.', 'type' => 'string', 'example' => '2021-10-19T07:13:41Z'], + 'ExpireTime' => ['title' => 'The time in UTC when the cluster expires. ', 'description' => 'The expiration time of the cluster. The time is in UTC.', 'type' => 'string', 'example' => '2021-10-17T16:00:00Z'], + 'Version' => ['title' => 'The OBServer version. ', 'description' => 'The version of the OBServer.', 'type' => 'string', 'example' => '2.2.77'], + 'DeployType' => ['title' => 'The deployment type of the cluster. Valid values:
- multiple: multi-IDC deployment
- single: single-IDC deployment
- dual: dual-IDC deployment', 'description' => 'The deployment type of the cluster.'."\n" + ."\n" + .'- multiple: multi-data center.'."\n" + ."\n" + .'- single: single-data center.'."\n" + ."\n" + .'- dual: dual-data center.', 'type' => 'string', 'example' => 'multiple'], + 'DeployMode' => ['title' => 'The data replica distribution mode of the cluster. Valid values: n: indicates the single-IDC mode. n-n: indicates the dual-IDC mode. n-n-n: indicates the multi-IDC mode. The integer n represents the number of OBServer nodes in each IDC. ', 'description' => 'The data replication mode of the cluster.'."\n" + ."\n" + .'- n for a single data center.'."\n" + ."\n" + .'- n-n for dual data centers.'."\n" + ."\n" + .'- n-n-n for multiple data centers.'."\n" + ."\n" + .'>
In this mode, n indicates the number of OBServer nodes in each data center.
', 'type' => 'string', 'example' => '1-1-1'], + 'DiskType' => ['title' => 'The type of the storage disk where the cluster is deployed. The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', 'description' => 'The storage class of the cluster.'."\n" + ."\n" + .'The default value is cloud\\_essd\\_pl1, which indicates an ESSD cloud disk.', 'type' => 'string', 'example' => 'cloud_essd_pl1'], + 'MaintainTime' => ['title' => 'The time period in UTC for the daily routine maintenance of the cluster. ', 'description' => 'The daily maintenance window of the cluster. The time is in UTC.', 'type' => 'string', 'example' => '19:00Z-20:00Z'], + 'DataMergeTime' => ['title' => 'The time when the major compaction of cluster data is performed. ', 'description' => 'The data merge time of the cluster.', 'type' => 'string', 'example' => '02:00'], + 'AutoRenewal' => ['title' => 'Indicates whether automatic renewal is enabled. This parameter is valid only for clusters whose billing methods are set to PREPAY. ', 'description' => 'Indicates whether auto-renewal is enabled.'."\n" + ."\n" + .'This parameter is valid only for subscription clusters.', 'type' => 'boolean', 'example' => 'true'], + 'IsTrustEcs' => ['title' => 'Indicates whether trusted ECS instances are used.', 'description' => 'Indicates whether a trusted ECS instance is used.', 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['title' => 'The status of the cluster. Valid values:
- PENDING_CREATE: The cluster is being created.
- ONLINE: The cluster is running.
- TENANT_CREATING: The tenant is being created.
- TENANT_SPEC_MODIFYING: The tenant specifications are being modified.
- EXPANDING: Nodes are being added to the cluster to increase its capacity.
- REDUCING: Nodes are being removed from the cluster to reduce its capacity.
- SPEC_UPGRADING: The service plan is being upgraded.
- DISK_UPGRADING: The storage space is being expanded.
- WHITE_LIST_MODIFYING: The whitelist is being modified.
- PARAMETER_MODIFYING: Parameters are being modified.
- SSL_MODIFYING: The SSL certificate is being changed.
- PREPAID_EXPIRE_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to PREPAY.
- ARREARS_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to POSTPAY.
- PENDING_DELETE: The cluster is being deleted. Generally, the cluster is in the ONLINE state. ', 'description' => 'The status of the cluster.'."\n" + ."\n" + .'- PENDING\\_CREATE: The instance is being created.'."\n" + ."\n" + .'- ONLINE: The instance is running.'."\n" + ."\n" + .'- TENANT\\_CREATING: A tenant is being created.'."\n" + ."\n" + .'- TENANT\\_SPEC\\_MODIFYING: The tenant specifications are being modified.'."\n" + ."\n" + .'- EXPANDING: The number of nodes is scaling up.'."\n" + ."\n" + .'- REDUCING: The number of nodes is scaling down.'."\n" + ."\n" + .'- SPEC\\_UPGRADING: The instance specifications are being upgraded.'."\n" + ."\n" + .'- DISK\\_UPGRADING: The storage capacity is scaling up.'."\n" + ."\n" + .'- WHITE\\_LIST\\_MODIFYING: The whitelist is being modified.'."\n" + ."\n" + .'- PARAMETER\\_MODIFYING: Parameters are being modified.'."\n" + ."\n" + .'- SSL\\_MODIFYING: The SSL certificate is being changed.'."\n" + ."\n" + .'- PREPAID\\_EXPIRE\\_CLOSED: The subscription cluster is suspended due to an overdue payment.'."\n" + ."\n" + .'- ARREARS\\_CLOSED: The pay-as-you-go cluster is suspended due to an overdue payment.'."\n" + ."\n" + .'- PENDING\\_DELETE: The instance is being deleted.'."\n" + .' The cluster is usually in the ONLINE state.', 'type' => 'string', 'example' => 'ONLINE'], + 'Resource' => [ + 'title' => 'The information about cluster resources.', + 'description' => 'The resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => 'The information about the CPU resources of the cluster.', + 'description' => 'The CPU resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => ['title' => 'The total number of CPU cores of the cluster.', 'description' => 'The total number of CPU cores of the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + 'UsedCpu' => ['title' => 'The number of CPU cores used in the cluster.', 'description' => 'The number of used CPU cores of the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UnitCpu' => ['title' => 'The number of CPU cores of each replica node in the cluster.', 'description' => 'The number of CPU cores of each replica node in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OriginalTotalCpu' => ['title' => '原始CPU', 'description' => 'The original number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], ], - 'Role' => [ - 'title' => '拥有的角色。', - 'description' => 'You can call this operation to modify the database privileges of a specified account in a tenant. ', - 'type' => 'string', - 'example' => 'ReadOnly', + 'example' => '', + ], + 'Memory' => [ + 'title' => 'The information about the memory resources of the cluster.', + 'description' => 'The memory resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => ['title' => 'The total memory size of the cluster, in GB.', 'description' => 'The total memory of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'UsedMemory' => ['title' => 'The size of used memory in the cluster, in GB.', 'description' => 'The used memory of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UnitMemory' => ['title' => 'The memory size of each replica node in the cluster, in GB.', 'description' => 'The memory of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OriginalTotalMemory' => ['title' => '原始内存', 'description' => 'The original memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '72'], ], - 'Table' => [ - 'title' => '表的名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'tbl_pay1', + 'example' => '', + ], + 'DiskSize' => [ + 'title' => 'The information about the storage resources of the cluster.', + 'description' => 'The storage resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['title' => 'The total storage space of the cluster, in GB.', 'description' => 'The total storage space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'UsedDiskSize' => ['title' => 'The size of used storage space of the cluster, in GB.', 'description' => 'The used storage space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UnitDiskSize' => ['title' => 'The storage space of each replica node in the cluster, in GB.', 'description' => 'The storage space of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'DataUsedSize' => ['description' => 'The size of the data disk, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '200', 'title' => ''], + 'MaxDiskUsedPercent' => ['description' => 'The maximum disk usage, in percentage.', 'type' => 'number', 'format' => 'double', 'example' => '0.14', 'title' => ''], + 'MaxDiskUsedObServer' => [ + 'description' => 'The maximum disk usage of the server.', + 'type' => 'array', + 'items' => ['description' => 'The list of OBServer nodes with the highest data disk usage.', 'type' => 'string', 'example' => 'i-bp1fhj23fs32dfbg4****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'OriginalTotalDiskSize' => ['title' => '原始磁盘', 'description' => 'The original disk size.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'MaxDiskSize' => ['title' => '最大可创建磁盘大小', 'description' => 'The maximum disk size that can be created.', 'type' => 'number', 'format' => 'double', 'example' => '80000'], ], - 'IsSuccess' => [ - 'title' => '是否授权成功。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', + ], + 'UnitCount' => ['title' => 'The number of resource units in the cluster. ', 'description' => 'The number of resource units in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LogDiskSize' => [ + 'title' => 'The information about the log disk space of the cluster.', + 'description' => 'The log disk resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['title' => 'The total log disk space of the cluster, in GB. ', 'description' => 'The total log disk space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '400'], + 'UnitDiskSize' => ['title' => 'The log disk space of each replica node in the cluster. Unit: GB.', 'description' => 'The log storage space of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'LogAssignedSize' => ['description' => 'The allocated log storage space, in GB.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'MaxLogAssignedObServer' => [ + 'description' => 'The information about the maximum storage space allocated to the server.', + 'type' => 'array', + 'items' => ['description' => 'The list of OBServer nodes with the highest log disk usage.', 'type' => 'string', 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxLogAssignedPercent' => ['description' => 'The maximum percentage of allocated log storage space.', 'type' => 'string', 'example' => '6.68', 'title' => ''], + 'OriginalTotalDiskSize' => ['title' => '日志盘原始大小', 'description' => 'The original size of the log disk.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], + 'example' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The capacity unit.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => ['description' => 'The maximum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MinCapacityUnit' => ['description' => 'The minimum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UsedCapacityUnit' => ['description' => 'The used capacity unit.', 'type' => 'string', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'example' => '账号具备的数据库权限信息列表。', + 'example' => '', ], - 'UserName' => [ - 'title' => '账号名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'pay_test', + 'AutoUpgradeObVersion' => ['title' => 'Indicates whether automatic upgrade of the OBServer version is enabled. ', 'description' => 'Indicates whether to automatically upgrade the OBServer version.', 'type' => 'boolean', 'example' => 'true'], + 'ObRpmVersion' => ['title' => 'The detailed information of the OBServer version. ', 'description' => 'The detailed version information of the OBServer.', 'type' => 'string', 'example' => '2.2.77-20210526202046'], + 'IsLatestObVersion' => ['title' => 'Indicates whether the OBServer version is the latest. ', 'description' => 'Indicates whether the OBServer is of the latest version.', 'type' => 'boolean', 'example' => 'true'], + 'AvailableZones' => [ + 'title' => 'The list of zones. ', + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => ['description' => 'The list of zones.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'example' => '', ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => '', + 'EnableUpgradeLogDisk' => ['title' => 'Indicates whether the log disk specifications can be upgraded. ', 'description' => 'Indicates whether the log disk specifications can be upgraded.', 'type' => 'boolean', 'example' => 'false'], + 'Zones' => [ + 'description' => 'The ID of the zone where the instance belongs.
'."\n" + .'For more information, see [DescribeZones](~~25610~~) to obtain the list of zones.
', + 'type' => 'array', + 'items' => ['description' => 'The ID of the zone where the instance belongs.
'."\n" + .'For more information, see [DescribeZones](https://www.alibabacloud.com/help/zh/doc-detail/25610.htm) to obtain the list of zones.
', 'type' => 'string', 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'InstanceRole' => ['title' => '实例角色', 'description' => 'The instance role.', 'type' => 'string', 'example' => 'NORMAL'], + 'NodeNum' => ['description' => 'The number of nodes in the cluster.'."\n" + .'If the deployment mode is n-n-n, the number of nodes is n × 3.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'ReplicaMode' => ['description' => 'The number of full-featured replicas.'."\n" + .'The return value can be 3 or 2.'."\n" + ."\n" + .'- 3: three full-featured replicas.'."\n" + ."\n" + .'- 2: two full-featured replicas.'."\n" + ."\n" + .'A three-zone deployment supports three full-featured replicas. A dual-zone deployment supports two full-featured replicas. A single-zone deployment can support two or three full-featured replicas.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'IsolationOptimization' => ['title' => '是否开启Cgroup', 'description' => 'Indicates whether Cgroup is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'EnableIsolationOptimization' => ['title' => '是否允许开通隔离优化', 'description' => 'Indicates whether isolation optimization can be enabled.', 'type' => 'boolean', 'example' => 'false'], + 'InTempCapacityStatus' => ['description' => 'The temporary capacity status.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DataDiskAutoScale' => ['title' => '是否开启数据自动协调', 'description' => 'Indicates whether automatic data scaling is enabled.'."\n" + ."\n" + .'>
This parameter is deprecated.
', 'type' => 'boolean', 'example' => '-'], + 'TenantCreatable' => [ + 'description' => 'The tenants that can be created.', + 'type' => 'object', + 'properties' => [ + 'EnableCreateTenant' => ['title' => '集群是否允许创建租户', 'description' => 'Indicates whether the cluster allows tenant creation.', 'type' => 'boolean', 'example' => 'true'], + 'DisableCreateTenantReason' => ['title' => '集群不允许创建租户的原因', 'description' => 'The reason why the cluster does not allow tenant creation.', 'type' => 'string', 'example' => 'CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT'], + ], + 'title' => '', + 'example' => '', + ], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => 'The configuration of automatic data disk scaling.', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => ['title' => '是否开启', 'description' => 'Indicates whether the feature is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'Upperbound' => ['title' => '扩容上限', 'description' => 'The upper limit for scaling.', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'UpperThreshold' => ['title' => '日常扩容阈值', 'description' => 'The threshold for daily scale-out.', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + 'UpperMergeThreshold' => ['title' => '合并扩容阈值', 'description' => 'The threshold for merged scale-out.', 'type' => 'integer', 'format' => 'int64', 'example' => '90'], + 'MaxDiskSize' => ['title' => '磁盘最大值', 'description' => 'The maximum disk size.', 'type' => 'integer', 'format' => 'int64', 'example' => '80000'], + 'ScaleStepInNormal' => ['title' => '日常扩容步长', 'description' => 'The step size for daily scale-out.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'ScaleStepInMerge' => ['title' => '合并扩容步长', 'description' => 'The step size for merged scale-out.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UpperScaleStrategy' => ['title' => '扩容策略（RAW/PERCENTAGE）', 'description' => 'The scale-out policy. Valid values: RAW and PERCENTAGE.', 'type' => 'string', 'example' => 'RAW'], + 'UpperScaleStep' => ['title' => '扩容步长', 'description' => 'The scale-out step size.', 'type' => 'string', 'example' => '5'], + ], + 'example' => '', + ], + 'EnableProxyService' => ['description' => 'Indicates whether the proxy service is enabled.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProxyServiceStatus' => ['title' => '代理服务状态', 'description' => 'The status of the proxy service.', 'type' => 'string', 'example' => 'ONLINE'], + 'ProxyClusterId' => ['title' => '代理集群 ID', 'description' => 'The ID of the proxy cluster.'."\n" + ."\n" + .'> This parameter is returned only when EnableProxyService is true.', 'type' => 'string', 'required' => false, 'example' => 'proxy-56****a6tg2o'], + 'CpuArchitecture' => [ + 'title' => '集群的 CPU 架构', + 'description' => 'The CPU architecture of the cluster.', 'type' => 'string', - 'example' => 't33h8y08k****', + 'example' => 'X86', + 'enum' => ['X86', 'ARM'], + ], + 'ReadOnlyResource' => [ + 'title' => '集群的资源信息', + 'description' => 'The resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => 'The CPU resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => ['title' => '集群总CPU，单位：核数', 'description' => 'The total number of CPU cores of the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + 'UsedCpu' => ['title' => '集群已使用的CPU，单位：核数', 'description' => 'The number of used CPU cores of the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UnitCpu' => ['title' => '集群中每个副本节点的CPU，单位：核数', 'description' => 'The number of CPU cores of each replica node in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OriginalTotalCpu' => ['title' => '原始CPU', 'description' => 'The original number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + ], + 'example' => '', + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => 'The memory resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => ['title' => '集群总内存，单位：GB', 'description' => 'The total memory of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'UsedMemory' => ['title' => '集群已使用的内存，单位：GB', 'description' => 'The used memory of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UnitMemory' => ['title' => '集群中每个副本的内存，单位：GB', 'description' => 'The memory of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OriginalTotalMemory' => ['title' => '原始内存', 'description' => 'The original memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '72'], + ], + 'example' => '', + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => 'The storage resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['title' => '集群总存储空间，单位：GB', 'description' => 'The total storage space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'UsedDiskSize' => ['title' => '集群已使用的存储空间，单位：GB', 'description' => 'The used storage space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UnitDiskSize' => ['title' => '集群每个副本的存储空间，单位：GB', 'description' => 'The storage space of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'DataUsedSize' => ['description' => 'The used storage space, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '200', 'title' => ''], + 'MaxDiskUsedPercent' => ['description' => 'The maximum disk usage, in percentage.', 'type' => 'number', 'format' => 'double', 'example' => '0.14', 'title' => ''], + 'MaxDiskUsedObServer' => [ + 'description' => 'The maximum disk usage of the server.', + 'type' => 'array', + 'items' => ['description' => 'The maximum disk usage of the server.', 'type' => 'string', 'example' => 'i-bp1fhj23fs32dfbg4****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'OriginalTotalDiskSize' => ['title' => '原始磁盘', 'description' => 'The original disk size.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'MaxDiskSize' => ['title' => '最大可创建磁盘大小', 'description' => 'The maximum disk size that can be created.', 'type' => 'number', 'format' => 'double', 'example' => '80000'], + ], + 'example' => '', + ], + 'UnitCount' => ['title' => '集群的资源Unit数量。', 'description' => 'The number of resource units in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LogDiskSize' => [ + 'title' => '集群的日志盘资源信息', + 'description' => 'The log disk resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['title' => '集群总日志盘空间，单位GB。', 'description' => 'The total log disk space of the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '400'], + 'UnitDiskSize' => ['title' => '集群每个副本的日志存储空间，单位：GB', 'description' => 'The log storage space of each replica in the cluster, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'LogAssignedSize' => ['description' => 'The allocated log storage space.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'MaxLogAssignedObServer' => [ + 'description' => 'The OBServer to which the maximum log space is allocated.', + 'type' => 'array', + 'items' => ['description' => 'The OBServer to which the maximum log space is allocated.', 'type' => 'string', 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxLogAssignedPercent' => ['description' => 'The maximum percentage of allocated log space.', 'type' => 'string', 'example' => '6.68', 'title' => ''], + ], + 'example' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The capacity unit.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => ['description' => 'The maximum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MinCapacityUnit' => ['description' => 'The minimum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UsedCapacityUnit' => ['description' => 'The used capacity unit.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], + 'UnitSpec' => ['title' => '代理服务的单元规格', 'description' => 'The unit specifications of the proxy service.', 'type' => 'string', 'example' => '2C4G'], + 'SharedUnitNumLimit' => ['title' => '共享模式代理服务的单元数量上限', 'description' => 'The upper limit on the number of units for the proxy service in shared mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'ExclusiveUnitNumLimit' => ['title' => '独占模式代理服务的单元数量上限', 'description' => 'The upper limit on the number of units for the proxy service in exclusive mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EnableReadOnlyReplica' => ['description' => 'Indicates whether read-only replicas are supported.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'EnableReadOnlyReplicaManagement' => ['description' => 'Indicates whether you can purchase read-only replicas for the cluster.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PrimaryInstance' => ['title' => "\n" + .'主实例Id', 'description' => 'The ID of the primary instance.', 'type' => 'string', 'example' => 'ob3h8ytroxxxxx'], + 'PrimaryRegion' => ['title' => '主实例Region', 'description' => 'The region of the primary instance.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'SpecType' => ['title' => '规格类型', 'description' => 'The specification type.', 'type' => 'string', 'example' => 'dedicatedspec'], + 'AllowModifyInternetAddressConnectionLimit' => ['title' => '是否允许修改公网最大连接数', 'description' => 'Indicates whether the maximum number of connections over the Internet can be modified.', 'type' => 'boolean', 'example' => 'false'], + 'AllowCreateProxySqlFirewallRule' => ['title' => '是否允许使用 ODP SQL 防火墙', 'description' => 'Indicates whether the ODP SQL firewall is allowed.', 'type' => 'boolean', 'example' => 'false'], + 'Iops' => ['type' => 'integer', 'format' => 'int32', 'example' => '10000', 'description' => '', 'title' => ''], ], 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"Series\\": \\"Normal\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DataMergeTime\\": \\"02:00\\",\\n \\"AutoRenewal\\": true,\\n \\"IsTrustEcs\\": true,\\n \\"Status\\": \\"ONLINE\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\",\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"AutoUpgradeObVersion\\": true,\\n \\"ObRpmVersion\\": \\"2.2.77-20210526202046\\",\\n \\"IsLatestObVersion\\": true,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"EnableUpgradeLogDisk\\": false,\\n \\"Zones\\": [\\n \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\"\\n ],\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"NodeNum\\": 6,\\n \\"ReplicaMode\\": \\"2\\",\\n \\"IsolationOptimization\\": false,\\n \\"EnableIsolationOptimization\\": false,\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScale\\": true,\\n \\"TenantCreatable\\": {\\n \\"EnableCreateTenant\\": true,\\n \\"DisableCreateTenantReason\\": \\"CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT\\"\\n },\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\",\\n \\"UpperScaleStep\\": \\"5\\"\\n },\\n \\"EnableProxyService\\": true,\\n \\"ProxyServiceStatus\\": \\"ONLINE\\",\\n \\"ProxyClusterId\\": \\"proxy-56****a6tg2o\\",\\n \\"CpuArchitecture\\": \\"X86\\",\\n \\"ReadOnlyResource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\"\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"UnitSpec\\": \\"2C4G\\",\\n \\"SharedUnitNumLimit\\": 3,\\n \\"ExclusiveUnitNumLimit\\": 1,\\n \\"EnableReadOnlyReplica\\": true,\\n \\"EnableReadOnlyReplicaManagement\\": false,\\n \\"PrimaryInstance\\": \\"ob3h8ytroxxxxx\\",\\n \\"PrimaryRegion\\": \\"cn-hangzhou\\",\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"AllowModifyInternetAddressConnectionLimit\\": false,\\n \\"AllowCreateProxySqlFirewallRule\\": false,\\n \\"Iops\\": 10000\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstance', + 'changeSet' => [ + ['createdAt' => '2025-08-05T15:58:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-03T13:53:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-19T11:02:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T13:01:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-04-15T11:25:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-02T12:38:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-07T09:36:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-20T11:33:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-30T13:51:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-07-04T02:53:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-17T02:26:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-21T09:50:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-15T11:37:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantUser\\": {\\n \\"UserRole\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"IsSuccess\\": true\\n }\\n ],\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n db_pay1\\n ReadOnly\\n tbl_pay1
\\n true\\n \\n pay_test\\n t33h8y08k****\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantUserRoles', ], - 'DeleteTenantUsers' => [ - 'summary' => 'You can call this operation to delete one or more database accounts. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstanceAvailableZones' => [ + 'summary' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', + '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' => 'E3D924FB-52****B253-0C1A7EFB778C'], + 'ZoneList' => [ + 'description' => 'The return result of the request.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Zone' => ['description' => 'The name of the physical zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'IsInCluster' => ['description' => 'Indicates whether the cluster is deployed in the zone.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ReplicateZoneIndex' => ['description' => 'The index of the replicated zone.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'LogicalZoneName' => ['description' => 'The name of the logical zone.', 'type' => 'string', 'example' => 'cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'Users', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户名及具备的角色列表。', - 'description' => 'A list of usernames.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["testUser"]', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"ZoneList\\": [\\n {\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsInCluster\\": true,\\n \\"ReplicateZoneIndex\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInstanceAvailableZones', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceAvailableZones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeInstanceCreatableZone' => [ + 'summary' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the zone. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', + 'title' => 'The return result of the request. ', + 'description' => 'The list of zones. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + 'RequestId' => ['title' => '-', 'description' => 'Indicates whether the cluster is deployed in the zone. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'ZoneList' => [ + 'title' => 'The request ID. ', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeInstanceCreatableZone**. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'IsInCluster' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeInstanceCreatableZone'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Indicates whether the zone is used in cluster deployment.', 'type' => 'boolean', 'example' => 'true'], + 'Zone' => ['title' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone. ', 'description' => 'DescribeInstanceCreatableZone', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'FullCopyId' => ['description' => 'Replica ordinal number.', 'title' => 'Replica ordinal number', 'type' => 'string', 'example' => '1'], + 'LogicalZoneName' => ['description' => 'Logical zone name.', 'title' => 'Logical replica', 'type' => 'string', 'example' => 'cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2'], + 'ReplicateZoneIndex' => ['description' => 'Replica zone index.', 'title' => 'Replica zone ordinal number', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DeleteTenantUsers', - ], - 'CreateDatabase' => [ - 'summary' => 'You can call this operation to create a database in a tenant. ', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"ZoneList\\": [\\n {\\n \\"IsInCluster\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"FullCopyId\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\",\\n \\"ReplicateZoneIndex\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query zone information', + 'changeSet' => [ + ['createdAt' => '2025-02-13T13:01:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceCreatableZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeInstanceSSL' => [ + 'summary' => 'Queries the SSL details of an OceanBase cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'DatabaseName', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', - 'description' => 'Alibaba Cloud CLI', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sms_pre', - ], + 'schema' => ['description' => 'The OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '租户id, 仅支持mysql模式;', - 'description' => 'The name of the database. '."\n" - .'You cannot use reserved keywords, such as test and mysql. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => 'OceanBase tenant ID', 'description' => 'The OceanBase tenant ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], - [ - 'name' => 'Encoding', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '数据库编码方式。目前支持utf8mb4, utf16, gbk, gb18030, binary ', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'utf8mb4', + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C', 'title' => ''], + 'InstanceSSL' => [ + 'description' => 'The instance SSL details.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The OceanBase cluster ID.', 'type' => 'string', 'example' => 'ob317v4uif****', 'title' => ''], + 'EnableSSL' => ['description' => 'Indicates whether SSL link encryption is enabled.', 'type' => 'string', 'example' => 'OPEN', 'title' => ''], + 'ValidPeriod' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2024-09-20 07:55:03.0', 'title' => ''], + 'CaUrl' => ['description' => 'The CA certificate URL.', 'type' => 'string', 'example' => 'https://xxxx', 'title' => ''], + 'Status' => ['description' => 'The SSL status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'ForceSSLSupport' => ['description' => 'Indicates whether forced SSL is supported.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'ForceSSL' => [ + 'description' => 'The forced SSL status.', + 'type' => 'string', + 'example' => 'CLOSE', + 'enum' => ['CLOSE', 'OPEN'], + 'title' => '', + ], + 'AutoUpdate' => [ + 'description' => 'Indicates whether automatic SSL certificate updates are enabled.', + 'enumValueTitles' => ['CLOSE' => 'Automatic update is disabled.', 'OPEN' => 'Automatic update is enabled.'], + 'type' => 'string', + 'example' => 'OPEN', + 'title' => '', + ], + 'TenantId' => ['description' => 'The OceanBase tenant ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'CertValid' => ['description' => 'Indicates whether the certificate is currently valid.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"OPEN\\",\\n \\"ValidPeriod\\": \\"2024-09-20 07:55:03.0\\",\\n \\"CaUrl\\": \\"https://xxxx\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ForceSSLSupport\\": false,\\n \\"ForceSSL\\": \\"CLOSE\\",\\n \\"AutoUpdate\\": \\"OPEN\\",\\n \\"TenantId\\": \\"\\",\\n \\"CertValid\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Query cluster SSL', + 'changeSet' => [ + ['createdAt' => '2025-10-21T14:02:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-13T13:01:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:05.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ [ - 'name' => 'Collation', - 'in' => 'formData', - 'schema' => [ - 'title' => '字符序. 目前支持的字符序为:'."\n" - .'● Encoding为utf8mb4时, Collation支持utf8mb4_general_ci,utf8mb4_bin,utf8mb4_unicode_ci'."\n" - .'● Encoding为utf16时, Collation支持utf16_general_ci,utf16_unicode_ci,utf16_bin'."\n" - .'● Encoding为gbk时, Collation支持gbk_chinese_ci,gbk_bin'."\n" - .'● Encoding为gb18030时, Collation支持gb18030_chinese_ci,gb18030_bin'."\n" - .'● Encoding为binary时, Collation支持binary', - 'description' => 'The encoding standard of the database.'."\n" - .'For more information, see the Charset field returned by the DescribeCharset operation. ', - 'type' => 'string', - 'required' => false, - 'example' => 'utf8mb4_general_ci', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeInstanceSecurityConfigs' => [ + 'summary' => 'You can call this operation to query security check items of an OceanBase cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The collation.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'Description', + 'name' => 'CheckId', 'in' => 'formData', - 'schema' => [ - 'title' => '数据库描述信息。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **CreateDatabase**. ', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test database', - ], + 'schema' => ['title' => '检测的唯一标识', 'description' => 'The unique identifier of the check.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'Example 1', + 'title' => '', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'DatabaseName' => [ - 'title' => '数据库名称。', - 'description' => 'CreateDatabase', - 'type' => 'string', - 'example' => 'sms_pre', + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'InstanceSecurityConfigs' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => ['title' => '', 'description' => 'The total number of security check items for the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'TotalRiskCount' => ['title' => '', 'description' => 'The total number of detected cluster security risks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'SecurityConfigs' => [ + 'title' => '', + 'description' => 'The list of check items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the specific check item.', + 'type' => 'object', + 'properties' => [ + 'ConfigName' => ['title' => '', 'description' => 'The name of the specific check item.', 'type' => 'string', 'example' => 'xxx'], + 'Risk' => ['title' => '', 'description' => 'Specifies whether a risk is detected.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], + 'RiskDescription' => ['title' => '', 'description' => 'Security recommendations.', 'type' => 'string', 'example' => 'xxx'], + 'ConfigGroup' => ['title' => '', 'description' => 'The group of the check.', 'type' => 'string', 'example' => 'WHITELIST'], + 'ConfigDescription' => ['title' => '', 'description' => 'The name of the check item.', 'type' => 'string', 'example' => '校验集群白名单范围是否过大'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'CheckTime' => ['title' => '2023-08-07 15:30:00', 'description' => 'The time when the check was performed.', 'type' => 'string', 'example' => '2023-08-07 15:30:00'], + 'InstanceId' => ['title' => 'Oceanbase集群ID。', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'CheckId' => ['title' => '检测的唯一标识', 'description' => 'The unique identifier of the check.', 'type' => 'string', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSecurityConfigs\\": {\\n \\"TotalCheckCount\\": 5,\\n \\"TotalRiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigName\\": \\"xxx\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"xxx\\",\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ],\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckId\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceSecurityConfigs', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSecurityConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"DatabaseName\\": \\"sms_pre\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n sms_pre\\n","errorExample":""}]', - 'title' => 'CreateDatabase', ], - 'DescribeDatabases' => [ - 'summary' => 'You can call this operation to query databases in a tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstanceSummary' => [ + 'summary' => 'Obtains the overview information about OceanBase instances.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10525,380 +7612,170 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['title' => '', 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page returned. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows returned on each page. '."\n" - .'- Maximum value: 100. '."\n" - .'- Default value: 10', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'InstanceSummary' => [ + 'description' => 'The overview information about OceanBase instances.', + 'type' => 'object', + 'properties' => [ + 'TotalInstancesCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'OverLoadInstancesCount' => ['description' => 'The number of overloaded instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ImmediatelyExpiredInstancesCount' => ['description' => 'The total number of expired instances to be released.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RunningInstancesCount' => ['description' => 'The number of running instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'InsufficientDiskInstancesCount' => ['description' => 'The total number of clusters with capacity risks.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ExpiredInstancesCount' => ['description' => 'The number of expired instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AlarmSummaryCount' => ['description' => 'The total number of alerts during the query period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AnomalySQLCount' => ['description' => 'The total number of abnormal SQL statements.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ClusterInstancesCount' => ['title' => '', 'description' => 'The number of cluster instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TenantInstancesCount' => ['title' => '', 'description' => 'The number of tenant instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalOmsInstancesCount' => ['description' => 'The number of data transmission instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RegionalInstanceSummaryList' => [ + 'description' => 'A list of regional instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'TotalInstancesCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'example' => '3', 'format' => 'int64', 'title' => ''], + 'ImmediatelyExpiredInstancesCount' => ['description' => 'The number of instances about to expire.', 'type' => 'integer', 'example' => '1', 'format' => 'int64', 'title' => ''], + 'RunningInstancesCount' => ['description' => 'The total number of running instances.', 'type' => 'integer', 'example' => '1', 'format' => 'int64', 'title' => ''], + 'ExpiredInstancesCount' => ['description' => 'The number of expired instances.', 'type' => 'integer', 'example' => '1', 'format' => 'int64', 'title' => ''], + 'RecentCreatedInstancesCount' => ['description' => 'The number of recently created instances.', 'type' => 'integer', 'example' => '1', 'format' => 'int64', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'DatabaseName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', - 'description' => 'The name of the database. '."\n" - .'You cannot use reserved keywords, such as test and mysql. ', - 'type' => 'string', - 'required' => false, - 'example' => 'sms_pre', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"InstanceSummary\\": {\\n \\"TotalInstancesCount\\": 3,\\n \\"OverLoadInstancesCount\\": 1,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"InsufficientDiskInstancesCount\\": 2,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"AlarmSummaryCount\\": 1,\\n \\"AnomalySQLCount\\": 1,\\n \\"ClusterInstancesCount\\": 1,\\n \\"TenantInstancesCount\\": 1,\\n \\"TotalOmsInstancesCount\\": 1,\\n \\"RegionalInstanceSummaryList\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"TotalInstancesCount\\": 3,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"RecentCreatedInstancesCount\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceSummary', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeInstanceTags' => [ + 'summary' => 'You can call this operation to query the tags of clusters.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SearchKey', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询列表的删选关键字。', - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'pay', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'WithTables', + 'name' => 'InstanceIds', 'in' => 'formData', - 'schema' => [ - 'title' => '是否返回数据库中的表信息。'."\n" - .'默认值：false。如果表的数量过大则可能导致接口超时', - 'description' => 'Specifies whether to return the information about tables in the database.'."\n" - .'Default value: false. '."\n" - .'> The operation may time out if the database contains a large number of tables.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The list of cluster IDs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["ob3za5w73as8rk"]'], ], [ - 'name' => 'InstanceId', + 'name' => 'Tags', 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob****n0abo9uo', - ], + 'schema' => ['title' => '', 'description' => 'The tags.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request. ', + 'title' => '', + 'description' => 'The returned response.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '租户中的数据库总数。', - 'description' => 'The total number of databases in the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Databases' => [ - 'title' => '租户中的数据库列表。', - 'description' => 'The list of databases in the tenant. ', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TagResources' => [ + 'title' => '', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'The list of databases in the tenant. ', + 'description' => 'The returned response.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '数据库的状态。 - ONLINE: 运行中 - DELETING: 删除中', - 'description' => 'The status of the database. Valid values: '."\n" - .'- ONLINE: The database is running. '."\n" - .'- DELETING: The database is being deleted.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'Description' => [ - 'title' => '数据库的描述信息。', - 'description' => 'The description of the database. ', - 'type' => 'string', - 'example' => 'test db', - ], - 'Encoding' => [ - 'title' => '数据库的编码。目前支持utf8mb4、gbk等编码。', - 'description' => 'The encoding standard of the database. Encoding standards such as utf8mb4 and GBK are supported. ', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'DbType' => [ - 'title' => '数据库类型', - 'description' => 'The database type.', - 'type' => 'string', - 'example' => 'mysql', - ], - 'DatabaseName' => [ - 'title' => '数据库名称。', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'sms_pre', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the database was created.', - 'type' => 'string', - 'example' => '2022-02-21 15:41:06', - ], - 'Users' => [ - 'title' => '对该数据库赋权的账号信息。', - 'description' => 'The list of accounts that are granted privileges on this database.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of accounts that are granted privileges on this database.', - 'type' => 'object', - 'properties' => [ - 'UserType' => [ - 'title' => '账号类型。 - Admin：超级账户 - Normal：普通账户', - 'description' => 'The type of the account. Valid values: '."\n" - .'- Admin: the super administrator account. '."\n" - .'- Normal: a general account.', - 'type' => 'string', - 'example' => 'Normal', - ], - 'Role' => [ - 'title' => '账号赋予该库的角色权限。 对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', - 'description' => 'The role of the account. '."\n" - .'In MySQL mode, a role is a database-level role. Valid values: '."\n" - .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" - .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" - .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" - .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'UserName' => [ - 'title' => '账号名称。', - 'description' => 'The name of the account. ', - 'type' => 'string', - 'example' => 'user_pay_ro', - ], - 'Privileges' => [ - 'description' => 'If you have granted custom privileges on the database, this parameter indicates the custom privileges, separated by commas (,). Otherwise, no data is returned for this parameter.', - 'type' => 'string', - 'example' => 'select,delete,update', - ], - ], - ], - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'Tables' => [ - 'title' => '数据库表信息', - 'description' => 'The list of database tables.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of database tables.', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'title' => '数据库表名', - 'description' => 'The name of the database table. ', - 'type' => 'string', - 'example' => 'testTables', - ], - ], - ], - ], - 'RequiredSize' => [ - 'title' => '所需容量 单位（GB）', - 'description' => 'The storage space required, in GB.', - 'type' => 'number', - 'format' => 'double', - 'example' => '5.67 GB', - ], - 'DataSize' => [ - 'title' => '实际数据大小单位（GB）', - 'description' => 'The actual data size, in GB. '."\n" - .'>This parameter is no longer used in later versions. RequiredSize is used instead.>', - 'type' => 'number', - 'format' => 'double', - 'example' => '5.67 GB', - ], - 'Collation' => [ - 'title' => '字符序', - 'description' => 'The collation.', - 'type' => 'string', - 'example' => 'utf8mb4_general_ci', - ], - 'InstanceId' => [ - 'title' => '所属集群Id', - 'description' => 'The ID of the cluster to which the tenant belongs.', - 'type' => 'string', - 'example' => 'obsdh2f****', - ], - 'TenantName' => [ - 'title' => '租户名', - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'tenantABC', - ], + 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'ResourceType' => ['title' => '', 'description' => 'The type of the resource.', 'type' => 'string', 'example' => 'instance'], + 'Tag' => ['title' => '', 'description' => 'The tag of the resource.', 'type' => 'string', 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]'], ], + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Databases\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"Description\\": \\"test db\\",\\n \\"Encoding\\": \\"utf8mb4\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DatabaseName\\": \\"sms_pre\\",\\n \\"CreateTime\\": \\"2022-02-21 15:41:06\\",\\n \\"Users\\": [\\n {\\n \\"UserType\\": \\"Normal\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"UserName\\": \\"user_pay_ro\\",\\n \\"Privileges\\": \\"select,delete,update\\"\\n }\\n ],\\n \\"TenantId\\": \\"t4pnum****\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"testTables\\"\\n }\\n ],\\n \\"RequiredSize\\": 0,\\n \\"DataSize\\": 0,\\n \\"Collation\\": \\"utf8mb4_general_ci\\",\\n \\"InstanceId\\": \\"obsdh2f****\\",\\n \\"TenantName\\": \\"tenantABC\\"\\n }\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n ONLINE\\n test db\\n utf8mb4\\n mysql\\n sms_pre\\n 2022-02-21 15:41:06\\n \\n Normal\\n ReadOnly\\n user_pay_ro\\n \\n t33h8y08k****\\n \\n testTables\\n \\n 0\\n 5.67\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeDatabases', - ], - 'ModifyDatabaseDescription' => [ - 'summary' => 'You can call this operation to modify the description of an OceanBase database. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The description of the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyDatabaseDescription**. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', - 'description' => 'Example 1', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sms_pre', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库描述信息。', - 'description' => ' ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'this is a test database', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"ob317v4uif****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": \\"[{\\\\\\"Key\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"Value\\\\\\", \\\\\\"xxx\\\\\\"},{}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInstanceTags', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyDatabaseDescription', ], - 'ModifyTenantUserStatus' => [ - 'summary' => 'You can call this operation to lock or unlock a specified database account. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstanceTenantModes' => [ + 'summary' => 'The return result of the request. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10906,129 +7783,69 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', - 'description' => 'The list of database accounts in the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_test', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'UserStatus', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库账号的状态。 Locked：锁定 Normal：解锁', - 'description' => 'The status of the database account. Valid values: '."\n" - .'- Locked: The account is locked. '."\n" - .'- Online: The account is unlocked. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'The ID of the tenant. ', - ], - ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyTenantUserStatus**. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeInstanceTenantModes**. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => '$.parameters[5].schema.example', + 'title' => 'The list of tenant modes. ', + 'description' => 'Example 1', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Example 1', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantUser' => [ - 'title' => '租户中的数据库账号信息', - 'description' => ' ', + 'InstanceModes' => [ + 'title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeInstanceTenantModes'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', + 'description' => 'Tenant list information. ', 'type' => 'array', 'items' => [ - 'description' => 'You can call this operation to lock or unlock a specified database account. ', - 'type' => 'object', - 'properties' => [ - 'UserStatus' => [ - 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', - 'description' => '', - 'type' => 'string', - 'example' => 'LOCKED', - ], - 'UserName' => [ - 'title' => '账号名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'pay_test', - ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => '', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - ], + 'description' => 'You can call this operation to query the modes of tenants. ', + 'type' => 'string', + 'enumValueTitles' => ['MySQL' => 'MySQL', 'Oracle' => 'Oracle'], + 'example' => 'Oracle', + 'title' => '', ], + 'enumValueTitles' => [], + 'example' => '', ], + 'RequestId' => ['title' => ' ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceModes\\": [\\n \\"Oracle\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Query Tenant Mode List Information ', + 'changeSet' => [ + ['createdAt' => '2022-08-15T11:37:07.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTenantModes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUser\\": [\\n {\\n \\"UserStatus\\": \\"LOCKED\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n LOCKED\\n pay_test\\n t33h8y08k****\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyTenantUserStatus', ], - 'ModifyDatabaseUserRoles' => [ - 'summary' => 'You can call this operation to modify the privileges of an account on a database. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstanceTopology' => [ + 'summary' => 'Query the topology information of an OceanBase cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11036,429 +7853,371 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'DatabaseName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sms_pre', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'A list of usernames and their respective roles. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'Users', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户名及具备的角色列表。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"UserName":"omstest","Role":"readwrite"}]', - ], - ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The account information. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The ID of the tenant. ', + 'title' => '', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'TenantUser' => [ - 'title' => '账号信息。', - 'description' => 'The name of the database. ', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'InstanceTopology' => [ + 'title' => '', + 'description' => 'The topology of the cluster.', 'type' => 'object', 'properties' => [ - 'DatabaseName' => [ - 'title' => '数据库名称。', - 'description' => 'Example 1', - 'type' => 'string', - 'example' => 'sms_pre', - ], - 'Users' => [ - 'title' => '对数据库有赋权的账户信息', - 'description' => ' ', + 'Tenants' => [ + 'title' => '', + 'description' => 'The list of tenants.', 'type' => 'array', 'items' => [ - 'description' => 'You can call this operation to modify the privileges of an account on a database. ', + 'description' => 'The details of a tenant.', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'title' => '账号赋予该库的角色权限。 对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', - 'description' => '', - 'type' => 'string', - 'example' => 'ReadOnly', + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 't33h8y08k****', 'title' => ''], + 'TenantName' => ['description' => 'The tenant name.', 'type' => 'string', 'example' => 'pay_online', 'title' => ''], + 'TenantCpu' => ['description' => 'The number of CPU cores for the tenant.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'TenantMemory' => ['description' => 'The memory size of the tenant, in GB.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'TenantMode' => ['description' => 'The tenant mode.'."\n" + ."\n" + .'- Oracle: Oracle mode.'."\n" + ."\n" + .'- MySQL: MySQL mode.', 'type' => 'string', 'example' => 'Oracle', 'title' => ''], + 'TenantZones' => [ + 'title' => '', + 'description' => 'The list of zones for the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a tenant zone.', + 'type' => 'object', + 'properties' => [ + 'TenantZoneRole' => ['description' => 'The access role of the zone.'."\n" + ."\n" + .'- ReadWrite: The zone is readable and writable.'."\n" + ."\n" + .'- ReadOnly: The zone is read-only.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'IsPrimaryTenantZone' => ['description' => 'Indicates whether the zone is the primary zone.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TenantZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'Units' => [ + 'title' => '', + 'description' => 'The list of resource units.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a unit.', + 'type' => 'object', + 'properties' => [ + 'UnitId' => ['description' => 'The resource unit ID.', 'type' => 'string', 'title' => '', 'example' => '1002'], + 'UnitStatus' => ['description' => 'The status of the resource unit.'."\n" + ."\n" + .'- ONLINE: The unit is running.'."\n" + ."\n" + .'- IMMIGRATING: The unit is being migrated in.'."\n" + ."\n" + .'- EMIGRATING: The unit is being migrated out.'."\n" + ."\n" + .'- CANCEL\\_IMMIGRATING: The immigration is being canceled.'."\n" + ."\n" + .'- CANCEL\\_EMIGRATING: The emigration is being canceled.'."\n" + ."\n" + .'- DELETING: The unit is being deleted.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the OBServer node where the resource unit is located.', 'type' => 'string', 'example' => 'i-bp16niirq4zdmgvm****', 'title' => ''], + 'UnitCpu' => ['description' => 'The number of CPU cores for the unit.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'UnitMemory' => ['description' => 'The memory size of the unit, in GB.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'EnableMigrateUnit' => ['description' => 'Indicates whether the unit can be migrated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ManualMigrate' => ['description' => 'Indicates whether the migration is manual.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableCancelMigrateUnit' => ['description' => 'Indicates whether the migration can be canceled.
'."\n" + .'This parameter applies only to units that are being manually immigrated or emigrated.
', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UnitDataSize' => ['description' => 'The amount of data used by the unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ReplicaType' => ['description' => 'The replica type.
'."\n" + .'OceanBase cluster monitoring uses this parameter to filter nodes.
'."\n" + ."\n" + .'- By default, this parameter is not specified. This setting applies to OceanBase monitoring and access proxy monitoring. For OceanBase monitoring queries, if you do not specify this parameter, data from nodes of all replica types is returned.'."\n" + ."\n" + .'- FULL: This value is valid only for OceanBase monitoring. It specifies that only the monitoring data of full-featured replica nodes is queried.'."\n" + ."\n" + .'- READONLY: This value is valid only for OceanBase monitoring. It specifies that only the monitoring data of read-only replica nodes is queried.', 'type' => 'string', 'example' => 'FULL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'LogicalZone' => ['description' => 'The replica ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h-z0'], + 'ReplicaType' => ['description' => 'The replica type of the tenant.', 'type' => 'string', 'title' => '', 'example' => 'FULL'], + 'ReadOnlyReplicaType' => ['description' => 'The read-only replica type.', 'type' => 'string', 'example' => 'ROW_STORE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'UserName' => [ - 'title' => '账号名称。', - 'description' => '', + 'TenantStatus' => ['description' => 'The tenant status.'."\n" + ."\n" + .'- PENDING\\_CREATE: The tenant is being created.'."\n" + ."\n" + .'- RESTORE: The tenant is being restored.'."\n" + ."\n" + .'- ONLINE: The tenant is running.'."\n" + ."\n" + .'- SPEC\\_MODIFYING: The specifications are being modified.'."\n" + ."\n" + .'- ALLOCATING\\_INTERNET\\_ADDRESS: The public IP address is being allocated.'."\n" + ."\n" + .'- PENDING\\_OFFLINE\\_INTERNET\\_ADDRESS: The public IP address is being disabled.'."\n" + ."\n" + .'- PRIMARY\\_ZONE\\_MODIFYING: The primary zone is being modified.'."\n" + ."\n" + .'- PARAMETER\\_MODIFYING: Parameters are being modified.'."\n" + ."\n" + .'- WHITE\\_LIST\\_MODIFYING: The whitelist is being modified.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'TenantDeployType' => ['description' => 'The deployment type of the tenant.'."\n" + ."\n" + .'- multiple: multiple data centers.'."\n" + ."\n" + .'- single: a single data center.'."\n" + ."\n" + .'- dual: two data centers.', 'type' => 'string', 'example' => 'multiple', 'title' => ''], + 'TenantUnitNum' => ['description' => 'The number of units in the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PrimaryZoneDeployType' => [ + 'description' => 'The deployment mode of the primary zone.', + 'enumValueTitles' => ['RANDOM' => 'RANDOM', 'STATIC' => 'STATIC'], 'type' => 'string', - 'example' => 'user_pay_ro', + 'title' => '', + 'example' => 'RANDOM', ], + 'TenantDiskSize' => ['description' => 'The data size of the tenant.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '2'], + 'TenantUnitCpu' => ['description' => 'The number of CPU cores per unit for the tenant.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '4'], + 'TenantUnitMemory' => ['description' => 'The memory size per unit of the tenant.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '16'], ], + 'title' => '', + 'example' => '', ], 'example' => '', ], - 'TenantId' => [ - 'title' => '租户ID。', - 'description' => '', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - ], - 'example' => '', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantUser\\": {\\n \\"DatabaseName\\": \\"sms_pre\\",\\n \\"Users\\": [\\n {\\n \\"Role\\": \\"ReadOnly\\",\\n \\"UserName\\": \\"user_pay_ro\\"\\n }\\n ],\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n sms_pre\\n \\n ReadOnly\\n user_pay_ro\\n \\n t33h8y08k****\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'ModifyDatabaseUserRoles', - ], - 'DeleteDatabases' => [ - 'summary' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'DatabaseNames', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称列表。 其为Json格式的数组，数组中每个对象都为数据库名称的字符串。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["sms_pre", "pay_pre"]', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DeleteDatabases', - ], - 'DescribeParameters' => [ - 'summary' => 'You can call this operation to query the information of cluster or tenant parameters. ', - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '498529', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'Dimension', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', - 'description' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TENANT', - ], - ], - [ - 'name' => 'DimensionValue', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', - 'description' => 'Alibaba Cloud CLI', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The default value of the parameter. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Parameters' => [ - 'title' => '参数列表信息', - 'description' => 'Indicates whether a restart is required for changes to the parameter to take effect. Valid values: '."\n" - .'- true: A restart is required. '."\n" - .'- false: A restart is not required. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID of the parameter type. '."\n" - .'You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID. ', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => '参数的描述信息。', - 'description' => 'The description of the parameter. ', - 'type' => 'string', - 'example' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeParameters**. ', - ], - 'ValueType' => [ - 'title' => '参数取值的类型。 其支持： - ENUM: 数值枚举 - RANGE: 数值范围 - TIME: 时间 - CAPACITY：存储容量值（K，M，G）', - 'description' => 'The invalid value range of the parameter. '."\n" - .'It is an array with two string elements, which represents a range. The first element represents the minimum value and the second element represents the maximum value. ', - 'type' => 'string', - 'example' => 'CAPACITY', - ], - 'CurrentValue' => [ - 'title' => '参数的当前取值。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => '600', - ], - 'NeedReboot' => [ - 'title' => '修改此参数是否需要重启 - true：需要重启 - false：不需要重启', - 'description' => 'The name of the parameter. ', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'connect_timeout', - ], - 'DefaultValue' => [ - 'title' => '参数的默认取值。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeParameters'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&Dimension=TENANT'."\n" - .'&DimensionValue=ob2mr3oae0****'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'example' => '600s', - ], - 'RejectedValue' => [ - 'title' => '参数的不允许取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', - 'description' => '{'."\n" - .' "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",'."\n" - .' "Parameters": ['."\n" - .' {'."\n" - .' "Description": "The maximum delay allowed in weak-consistency reads.",'."\n" - .' "ValueType": "CAPACITY",'."\n" - .' "CurrentValue": "600",'."\n" - .' "NeedReboot": false,'."\n" - .' "Name": "connect_timeout",'."\n" - .' "DefaultValue": "600s",'."\n" - .' "RejectedValue": ['."\n" - .' "1s"'."\n" - .' ],'."\n" - .' "AcceptableValue": ['."\n" - .' "1s"'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - 'type' => 'array', - 'items' => [ - 'description' => ''."\n" - .' EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'."\n" - .' '."\n" - .' The maximum delay allowed in weak-consistency reads.'."\n" - .' CAPACITY'."\n" - .' 600'."\n" - .' false'."\n" - .' connect_timeout'."\n" - .' 600s'."\n" - .' 1s'."\n" - .' 1s'."\n" - .' '."\n" - .'', - 'type' => 'string', - 'example' => '1s', + 'Zones' => [ + 'title' => '', + 'description' => 'The zone information of the cluster.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a zone.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ZoneDisk' => ['description' => 'The storage capacity of the zone.', 'type' => 'string', 'example' => '200 GB', 'title' => ''], + 'Nodes' => [ + 'title' => '', + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a node.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'i-bp16niirq4zdmgvm****', 'title' => ''], + 'NodeCopyId' => ['description' => 'The ID of the replica to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NodeStatus' => ['description' => 'The running status of the node.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'NodeResource' => [ + 'title' => '', + 'description' => 'The resource information of the node.', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '', + 'description' => 'The CPU resources of the node.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => ['description' => 'The number of CPU cores used by the node.', 'type' => 'number', 'format' => 'float', 'example' => '4', 'title' => ''], + 'TotalCpu' => ['description' => 'The total number of CPU cores for the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '14', 'title' => ''], + ], + 'example' => '', + ], + 'Memory' => [ + 'title' => '', + 'description' => 'The memory resources of the node.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => ['description' => 'The amount of memory used by the node, in GB.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'TotalMemory' => ['description' => 'The total memory size of the node, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '70', 'title' => ''], + ], + 'example' => '', + ], + 'DiskSize' => [ + 'title' => '', + 'description' => 'The storage resources of the node.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['description' => 'The total disk space of the node, in GB.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100'], + 'UsedDiskSize' => ['description' => 'The used disk space of the node, in GB.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '50'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'ReplicaType' => ['description' => 'The replica type. Valid values:'."\n" + ."\n" + .'- FULL'."\n" + ."\n" + .'- READONLY', 'type' => 'string', 'example' => 'FULL', 'title' => ''], + 'FullCopyId' => ['description' => 'The ID of the full-featured replica.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ReadOnlyCopyId' => ['description' => 'The ID of the read-only replica.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'LogicalZone' => ['description' => 'The replica ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h-z0'], + 'ReadOnlyReplicaType' => ['description' => 'The read-only replica type.', 'type' => 'string', 'example' => 'ROW_STORE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ZoneResource' => [ + 'title' => '', + 'description' => 'The zone information.', + 'type' => 'object', + 'properties' => [ + 'DiskSize' => [ + 'title' => '', + 'description' => 'The storage resources of the node.', + 'type' => 'object', + 'properties' => [ + 'MaxDiskUsedPercent' => ['description' => 'The maximum disk usage, as a percentage.', 'type' => 'number', 'format' => 'double', 'example' => '0.14', 'title' => ''], + 'MaxDiskUsedObServer' => [ + 'description' => 'The IDs of the OBServer nodes with the highest disk usage.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the OBServer node with the highest disk usage.', 'type' => 'string', 'example' => 'i-bp1fhj23fs32dfbg4****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'AcceptableValue' => [ - 'title' => '参数的可接受取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', - 'description' => ' DescribeParameters', - 'type' => 'array', - 'items' => [ - 'title' => 'ob317v4uif****', - 'description' => 'ob317v4uif****', - 'type' => 'string', - 'example' => '1s', + 'example' => '', + ], + 'Replicas' => [ + 'description' => 'The replica information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogicalZone' => ['description' => 'The replica ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h-z0'], + 'NodeNum' => ['description' => 'The number of replica nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'ZoneLogicalName' => ['description' => 'The region of the replica.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'], + 'ZoneRegionName' => ['description' => 'The zone of the replica.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'], + 'ReplicaResource' => [ + 'description' => 'The replica resource information.', + 'type' => 'object', + 'properties' => [ + 'Memory' => [ + 'description' => 'The memory resources of the replica.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => ['description' => 'The amount of memory used by the replica.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '16'], + 'TotalMemory' => ['description' => 'The total memory of the replica.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '32'], + ], + 'title' => '', + 'example' => '', + ], + 'DiskSize' => [ + 'description' => 'The disk resources of the replica.', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => ['description' => 'The amount of disk space used by the replica.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '50'], + 'TotalDiskSize' => ['description' => 'The total disk space of the replica.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + ], + 'title' => '', + 'example' => '', + ], + 'Cpu' => [ + 'description' => 'The CPU resources of the replica.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => ['description' => 'The total number of CPU cores for the replica.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '16'], + 'UsedCpu' => ['description' => 'The number of CPU cores used by the replica.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '8'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ZoneLogicalId' => ['description' => 'The replica number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'."\n"], + 'ReplicaType' => ['description' => 'The replica type.', 'type' => 'string', 'title' => '', 'example' => 'FULL'], + 'Status' => [ + 'description' => 'The status of the replica. Valid values: `ACTIVE`, `INACTIVE`, and `UNKNOWN`.', + 'type' => 'string', + 'enum' => ['ACTIVE', 'INACTIVE', 'UNKNOWN'], + 'title' => '', + 'example' => 'ACTIVE', + ], + 'ReadOnlyReplicaType' => [ + 'description' => 'The read-only replica type.', + 'type' => 'string', + 'enum' => ['ROW_STORE', 'COLUMN_STORE', 'NOT_READONLY_REPLICA'], + 'example' => 'ROW_STORE', + 'title' => '', + ], + 'OnlineNodeNum' => ['title' => 'Number of online edge zones ', 'description' => 'The number of online nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], + 'description' => 'The details of a replica.', + 'title' => '', + 'example' => '', ], - 'Readonly' => [ - 'title' => '参数是否只读', - 'description' => '参数是否只读', - 'type' => 'boolean', - ], - 'Unit' => [ - 'title' => '参数值单位', - 'type' => 'string', - 'example' => 's', - ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceTopology\\": {\\n \\"Tenants\\": [\\n {\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"TenantCpu\\": 2,\\n \\"TenantMemory\\": 10,\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"IsPrimaryTenantZone\\": true,\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Units\\": [\\n {\\n \\"UnitId\\": \\"1002\\",\\n \\"UnitStatus\\": \\"ONLINE\\",\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"UnitCpu\\": 2,\\n \\"UnitMemory\\": 10,\\n \\"EnableMigrateUnit\\": true,\\n \\"ManualMigrate\\": true,\\n \\"EnableCancelMigrateUnit\\": true,\\n \\"UnitDataSize\\": 10,\\n \\"ReplicaType\\": \\"FULL\\"\\n }\\n ],\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"TenantDeployType\\": \\"multiple\\",\\n \\"TenantUnitNum\\": 1,\\n \\"PrimaryZoneDeployType\\": \\"RANDOM\\",\\n \\"TenantDiskSize\\": 2,\\n \\"TenantUnitCpu\\": 4,\\n \\"TenantUnitMemory\\": 16\\n }\\n ],\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ZoneDisk\\": \\"200 GB\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"NodeCopyId\\": 1,\\n \\"NodeStatus\\": \\"ONLINE\\",\\n \\"NodeResource\\": {\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 4,\\n \\"TotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 10,\\n \\"TotalMemory\\": 70\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 100,\\n \\"UsedDiskSize\\": 50\\n }\\n },\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"FullCopyId\\": 1,\\n \\"ReadOnlyCopyId\\": 1,\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"ZoneResource\\": {\\n \\"DiskSize\\": {\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ]\\n }\\n }\\n }\\n ],\\n \\"Replicas\\": [\\n {\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"NodeNum\\": 1,\\n \\"ZoneLogicalName\\": \\"cn-hangzhou-h\\",\\n \\"ZoneRegionName\\": \\"cn-hangzhou-h\\",\\n \\"ReplicaResource\\": {\\n \\"Memory\\": {\\n \\"UsedMemory\\": 16,\\n \\"TotalMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 50,\\n \\"TotalDiskSize\\": 100\\n },\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 16,\\n \\"UsedCpu\\": 8\\n }\\n },\\n \\"ZoneLogicalId\\": 1,\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\",\\n \\"OnlineNodeNum\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query cluster topology information ', + 'changeSet' => [ + ['createdAt' => '2025-04-22T14:06:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-04T06:30:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:25:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T06:07:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTopology', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Parameters\\": [\\n {\\n \\"Description\\": \\"弱读允许的最大时间延迟时间\\",\\n \\"ValueType\\": \\"CAPACITY\\",\\n \\"CurrentValue\\": \\"600\\",\\n \\"NeedReboot\\": false,\\n \\"Name\\": \\"connect_timeout\\",\\n \\"DefaultValue\\": \\"600s\\",\\n \\"RejectedValue\\": [\\n \\"1s\\"\\n ],\\n \\"AcceptableValue\\": [\\n \\"2s\\"\\n ],\\n \\"Readonly\\": false,\\n \\"Unit\\": \\"s\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 弱读允许的最大时间延迟时间\\n CAPACITY\\n 600\\n false\\n connect_timeout\\n 600s\\n 1s\\n 1s\\n \\n","errorExample":""}]', - 'title' => ' DescribeParameters', ], - 'DescribeParametersHistory' => [ - 'summary' => 'You can call this operation to query the modification history of cluster or tenant parameters. ', - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeInstances' => [ + 'summary' => 'Retrieves a list of OceanBase clusters.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11466,373 +8225,622 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'Dimension', + 'name' => 'ResourceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', - 'description' => 'The type of the parameter. '."\n" - .'Valid values: CLUSTER and TENANT. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TENANT', - ], + 'schema' => ['title' => 'The ID of the resource group. If you do not specify this parameter, all resources are returned. ', 'description' => 'The ID of the resource group. If you omit this parameter, the API returns instances from all resource groups.', 'type' => 'string', 'example' => 'group1', 'required' => false], ], [ - 'name' => 'DimensionValue', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', - 'description' => 'The resource ID of the parameter type. '."\n" - .'You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID. ', - 'type' => 'string', - 'required' => false, - 'example' => 't4qx8****', - ], + 'schema' => ['title' => 'The number of rows to return on each page. Maximum value: 100. Default value: 10.', 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'StartTime', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '参数历史查看的起始时间。', - 'description' => 'The start time of querying the slow query execution.'."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13 15:40:43', - ], + 'schema' => ['title' => 'The number of the page to return. Start value: 1. Default value: 1.', 'description' => 'The page number.'."\n" + ."\n" + .'- Starts from 1.'."\n" + ."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EndTime', + 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'title' => '参数历史查看的结束时间。', - 'description' => 'The end time of the time range for querying the SQL execution history. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13 15:40:43', - ], + 'schema' => ['title' => 'The name of the OceanBase cluster. It must be 1 to 20 characters in length. If this parameter is not specified, the value is the instance ID by default. ', 'description' => 'The name of the OceanBase cluster. The name must be 1 to 20 characters long and can contain English or Chinese characters. If this parameter is not specified, the default value is the instance ID of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob4prod'], ], [ - 'name' => 'PageSize', + 'name' => 'SearchKey', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['title' => 'The search keyword. ', 'description' => 'The keyword for a fuzzy search on the instance ID, instance name, tenant ID, and tenant name.', 'type' => 'string', 'example' => 'pay', 'required' => false], ], [ - 'name' => 'PageNumber', + 'name' => 'WithOBCloudInstances', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request.', + 'title' => 'The return result of the request. ', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Respond' => [ - 'description' => 'The list of parameter modification records.', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total count, which takes effect in a pagination query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PageNumber' => [ - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Parameters' => [ - 'description' => 'The information about parameters.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about parameters.', + 'Instances' => [ + 'title' => 'The list of OceanBase clusters. ', + 'description' => 'Details of the OceanBase clusters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a single OceanBase cluster.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'vpcId', 'description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-8vb8qjrixzovjpy******'], + 'CommodityCode' => ['title' => 'The product code of the OceanBase cluster. - oceanbase_oceanbasepre_public_cn: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in a China site. - oceanbase_oceanbasepost_public_cn: indicates an OceanBase cluster that is billed based on the pay-as-you-go plan and that is deployed in a China site. - oceanbase_obpre_public_intl: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in an international site. ', 'description' => 'The product code of the OceanBase cluster.'."\n" + ."\n" + .'- `oceanbase_oceanbasepre_public_cn`: indicates a subscription OceanBase cluster on the China site.'."\n" + ."\n" + .'- `oceanbase_oceanbasepost_public_cn`: indicates a pay-as-you-go OceanBase cluster on the China site.'."\n" + ."\n" + .'- `oceanbase_obpre_public_intl`: indicates a subscription OceanBase cluster on the international site.'."\n" + ."\n" + .'- `oceanbase_obpost_public_intl`: indicates a pay-as-you-go OceanBase cluster on the international site.', 'type' => 'string', 'example' => 'oceanbase_oceanbasepost_public_cn'], + 'ExpireTime' => ['title' => 'The time in UTC when the cluster expires. ', 'description' => 'The expiration time of the cluster, in UTC.'."\n" + ."\n" + .'> This parameter is returned only for subscription instances.', 'type' => 'string', 'example' => '2021-10-17T16:00:00Z'], + 'State' => ['title' => 'The status of the cluster. Valid values: - PENDING_CREATE: The cluster is being created. - ONLINE: The cluster is running. - TENANT_CREATING: The tenant is being created. - TENANT_SPEC_MODIFYING: The tenant specifications are being modified. - EXPANDING: Nodes are being added to the cluster to increase its capacity. - REDUCING: Nodes are being removed from the cluster to reduce its capacity. - SPEC_UPGRADING: The service plan is being upgraded. - DISK_UPGRADING: The storage space is being expanded. - WHITE_LIST_MODIFYING: The whitelist is being modified. - PARAMETER_MODIFYING: Parameters are being modified. - SSL_MODIFYING: The SSL certificate is being changed. - PREPAID_EXPIRE_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to PREPAY. - ARREARS_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to POSTPAY. - PENDING_DELETE: The cluster is being deleted. Generally, the cluster is in the ONLINE state. ', 'description' => 'The cluster status.'."\n" + ."\n" + .'- `ONLINE`: Running.'."\n" + ."\n" + .'- `PENDING_CREATE`: Creating.'."\n" + ."\n" + .'- `ARREARS_CLOSED`: The pay-as-you-go cluster is shut down due to an overdue payment.'."\n" + ."\n" + .'- `PREPAID_EXPIRE_CLOSED`: The subscription cluster is shut down after it expires.'."\n" + ."\n" + .'- `WHITE_LIST_MODIFYING`: The IP whitelist is being modified.'."\n" + ."\n" + .'- `SSL_MODIFYING`: The SSL configuration is being changed.'."\n" + ."\n" + .'- `PARAMETER_MODIFYING`: Parameters are being modified.'."\n" + ."\n" + .'- `TENANT_CREATING`: A tenant is being created.'."\n" + ."\n" + .'- `TENANT_SPEC_MODIFYING`: The instance type of a tenant is being modified.'."\n" + ."\n" + .'- `EXPANDING`: Nodes are being scaled out.'."\n" + ."\n" + .'- `REDUCING`: Nodes are being scaled in.'."\n" + ."\n" + .'- `ZONE_CHANGING`: Availability zones are being changed.'."\n" + ."\n" + .'- `SPEC_UPGRADING`: The instance type is being scaled up.'."\n" + ."\n" + .'- `SPEC_DOWNGRADING`: The instance type is being scaled down.'."\n" + ."\n" + .'- `DISK_UPGRADING`: The storage space is being scaled up.'."\n" + ."\n" + .'- `UPGRADING`: The cluster is being upgraded.'."\n" + ."\n" + .'- `PENDING_DELETE`: The cluster is being deleted.'."\n" + ."\n" + .'- `DELETED`: The cluster is deleted.'."\n" + ."\n" + .'- `ABNORMAL`: The cluster is in an abnormal state.'."\n" + ."\n" + .'- `OFFLINE`: The cluster is offline.'."\n" + ."\n" + .'- `STANDBY_CREATING`: A standby cluster is being created.'."\n" + ."\n" + .'- `STANDBY_DELETING`: A standby cluster is being deleted.'."\n" + ."\n" + .'- `SWITCHOVER_SWITCHING`: A primary/standby switchover is in progress.'."\n" + ."\n" + .'- `STANDBY_DISCONNECTING`: A standby cluster is being detached.'."\n" + ."\n" + .'- `LOG_DISK_UPGRADING`: The log disk is being scaled up.'."\n" + ."\n" + .'- `ISOLATION_OPTIMIZATION_MODIFYING`: The isolation optimization settings are being changed.'."\n" + ."\n" + .'- `DISKTYPE_MODIFYING`: The data disk type is being changed.'."\n" + ."\n" + .'- `PROXY_SERVICE_CREATING`: The proxy service is being enabled.'."\n" + ."\n" + .'- `PROXY_SERVICE_DELETING`: The proxy service is being disabled.'."\n" + ."\n" + .'- `PROXY_SERVICE_SPEC_MODIFYING`: The proxy service specifications are being modified.'."\n" + ."\n" + .'- `READONLY_ADD_NODE`: A read-only node is being added.'."\n" + ."\n" + .'- `READONLY_REDUCE_NODE`: A read-only node is being removed.'."\n" + ."\n" + .'- `READONLY_REDUCE_ZONE`: The availability zone for the read-only replica is being removed.'."\n" + ."\n" + .'- `READONLY_ADD_ZONE`: The availability zone for the read-only replica is being added.'."\n" + ."\n" + .'- `READONLY_UPGRADE_SPEC`: The instance type of the read-only replica is being scaled up.'."\n" + ."\n" + .'- `READONLY_UPGRADE_DISK`: The storage space of the read-only replica is being scaled up.'."\n" + ."\n" + .'- `READONLY_DOWNGRADE_SPEC`: The instance type of the read-only replica is being scaled down.'."\n" + ."\n" + .'- `READONLY_DOWNGRADE_DISK`: The storage space of the read-only replica is being scaled down.'."\n" + ."\n" + .'- `CREATING_TENANT_READONLY_REPLICA`: A read-only replica is being created for the tenant.'."\n" + ."\n" + .'- `DELETING_TENANT_READONLY_REPLICA`: The read-only replica of the tenant is being deleted.'."\n" + ."\n" + .'- `DISK_DOWNGRADING`: The storage space is being scaled down.'."\n" + ."\n" + .'- `DEPLOY_MODE_MODIFYING`: The deployment mode is being changed.'."\n" + ."\n" + .'> Typically, a cluster is in the Running (`ONLINE`) state.', 'type' => 'string', 'example' => 'ONLINE'], + 'InstanceClass' => ['title' => 'The specifications of the cluster. You can specify one of the following four plans: - 8C32G: indicates 8 CPU cores and 32 GB of memory. - 14C70G: indicates 14 CPU cores and 70 GB of memory. - 30C180G: indicates 30 CPU cores and 180 GB of memory. - 62C400G: indicates 62 CPU cores and 400 GB of memory. ', 'description' => 'The instance type of the cluster. Supported types include:'."\n" + ."\n" + .'- `4C16GB`: 4 cores, 16 GB of memory.'."\n" + ."\n" + .'- `8C32GB`: 8 cores, 32 GB of memory.'."\n" + ."\n" + .'- `14C70GB`: 14 cores, 70 GB of memory.'."\n" + ."\n" + .'- `24C120GB`: 24 cores, 120 GB of memory.'."\n" + ."\n" + .'- `30C180GB`: 30 cores, 180 GB of memory.'."\n" + ."\n" + .'- `62C400GB`: 62 cores, 400 GB of memory.'."\n" + ."\n" + .'- `104C600GB`: 104 cores, 600 GB of memory.'."\n" + ."\n" + .'- `16C70GB`: 16 cores, 70 GB of memory.'."\n" + ."\n" + .'- `32C160GB`: 32 cores, 160 GB of memory.'."\n" + ."\n" + .'- `64C380GB`: 64 cores, 380 GB of memory.'."\n" + ."\n" + .'- `20C32GB`: 20 cores, 32 GB of memory.'."\n" + ."\n" + .'- `40C64GB`: 40 cores, 64 GB of memory.'."\n" + ."\n" + .'- `16C32GB`: 16 cores, 32 GB of memory.'."\n" + ."\n" + .'- `32C70GB`: 32 cores, 70 GB of memory.'."\n" + ."\n" + .'- `64C180GB`: 64 cores, 180 GB of memory.'."\n" + ."\n" + .'- `32C180GB`: 32 cores, 180 GB of memory.'."\n" + ."\n" + .'- `64C400GB`: 64 cores, 400 GB of memory.', 'type' => 'string', 'example' => '14C70G'], + 'CreateTime' => ['title' => 'The time in UTC when the cluster was created. ', 'description' => 'The time when the cluster was created, in UTC.', 'type' => 'string', 'example' => '2021-10-19T07:13:41Z'], + 'DeployMode' => ['title' => 'The data replica distribution mode of the cluster. Valid values: n: indicates the single-IDC mode. n-n: indicates the dual-IDC mode. n-n-n: indicates the multi-IDC mode. The integer n represents the number of OBServer nodes in each IDC. ', 'description' => 'The distribution mode of data replicas, formatted as `n-n-n`. Each `n` represents the number of OBServer nodes in a data center.', 'type' => 'string', 'example' => '1-1-1'], + 'CpuArchitecture' => ['title' => '集群的 CPU 架构', 'description' => 'The CPU architecture of the cluster.', 'type' => 'string', 'example' => 'X86_64、 AARCH64'], + 'MaintainTime' => ['title' => 'The time period in UTC for the daily routine maintenance of the cluster. ', 'description' => 'The daily maintenance window of the cluster, in UTC.', 'type' => 'string', 'example' => '19:00Z-20:00Z'], + 'DeployType' => ['title' => 'The deployment type of the cluster. Valid values: - multiple: multi-IDC deployment. - single: single-IDC deployment. - dual: dual-IDC deployment.', 'description' => 'The deployment type of the cluster.'."\n" + ."\n" + .'- `multiple`: multiple data centers.'."\n" + ."\n" + .'- `single`: a single data center.'."\n" + ."\n" + .'- `dual`: dual data centers.', 'type' => 'string', 'example' => 'multiple'], + 'PayType' => ['title' => 'The billing method for the OceanBase cluster. Valid values:- PREPAY: the subscription billing method. - POSTPAY: the pay-as-you-go billing method.', 'description' => 'The billing method of the OceanBase cluster:'."\n" + ."\n" + .'- `PREPAY`: subscription.'."\n" + ."\n" + .'- `POSTPAY`: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY'], + 'DiskSize' => ['title' => 'The size of the storage space, in GB. ', 'description' => 'The storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'DiskType' => ['title' => 'The type of the storage disk where the cluster is deployed. The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', 'description' => 'The storage type of the cluster.', 'type' => 'string', 'example' => 'cloud_essd_pl1'], + 'InstanceId' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'ExpireSeconds' => ['title' => 'The time elapsed since the expiration of the cluster, in seconds. ', 'description' => 'The remaining validity period of the cluster, in seconds.'."\n" + ."\n" + .'> For subscription clusters, if the cluster has not expired, this parameter indicates the remaining validity period. If the cluster has expired, this parameter indicates the duration since expiration.', 'type' => 'integer', 'format' => 'int32', 'example' => '2606682'], + 'Mem' => ['title' => 'The memory size of the instance, in GB. ', 'description' => 'The memory size, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'EnableUpgradeNodes' => ['title' => 'Indicates whether new nodes can be added. ', 'description' => 'Indicates whether you can add new nodes.', 'type' => 'boolean', 'example' => 'true'], + 'Cpu' => ['title' => 'The number of CPU cores of the cluster. ', 'description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '14'], + 'AvailableZones' => [ + 'title' => 'The information about the zone in which the cluster is deployed. ', + 'description' => 'The availability zones where the cluster is deployed.', + 'type' => 'array', + 'items' => ['description' => 'An availability zone where the cluster is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'example' => '', + ], + 'Version' => ['title' => 'The OBServer version. ', 'description' => 'The OBServer version.', 'type' => 'string', 'example' => '2.2.77'], + 'InstanceName' => ['title' => 'The name of the OceanBase cluster. ', 'description' => 'The name of the OceanBase cluster. The name must be 1 to 20 characters in length and can contain letters or Chinese characters. If this parameter is not specified, the value of `InstanceId` is used by default.', 'type' => 'string', 'example' => 'ob4test'], + 'Series' => ['title' => 'The series of the OceanBase cluster. Valid values: - NORMAL: the high availability edition. - BASIC: the basic edition.', 'description' => 'The series of the OceanBase instance.'."\n" + ."\n" + .'- `normal` (default): Standard Cluster Edition (cloud disk).'."\n" + ."\n" + .'- `normal_ssd`: Standard Cluster Edition (local disk).'."\n" + ."\n" + .'- `history`: History Database Cluster Edition.'."\n" + ."\n" + .'- `normal_kv`: OBKV cluster.'."\n" + ."\n" + .'- `normal_hg`: a trusted computing cluster.', 'type' => 'string', 'example' => 'NORMAL'], + 'UsedDiskSize' => ['title' => 'The size of used storage space of the cluster, in GB. ', 'description' => 'The used storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'ResourceGroupId' => ['title' => 'The ID of the resource group. ', 'description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'group1'], + 'Resource' => [ + 'title' => 'The information about cluster resources.', + 'description' => 'The resource information of the cluster.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '修改状态。 - APPLIED：成功 - SCHEDULING：待修改。', - 'description' => 'The modification status of the parameter. Valid values: '."\n" - .'* APPLIED: The parameter was modified.'."\n" - .'* SCHEDULING: The parameter was to be modified.', - 'type' => 'string', - 'example' => 'APPLIED', - ], - 'OldValue' => [ - 'title' => '参数修改前的值。', - 'description' => 'The value of the parameter before the modification.', - 'type' => 'string', - 'example' => '10', - ], - 'UpdateTime' => [ - 'title' => '参数修改的生效时间。', - 'description' => 'The time when the parameter modification took effect.', - 'type' => 'string', - 'example' => '2024-11-26T08:03:34Z', + 'Cpu' => [ + 'title' => 'The information about the CPU resources of the cluster.', + 'description' => 'The CPU resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => ['title' => 'The total number of CPU cores of the cluster.', 'description' => 'The total number of CPU cores.', 'type' => 'number', 'format' => 'double', 'example' => '14'], + 'UsedCpu' => ['title' => 'The number of CPU cores used in the cluster.', 'description' => 'The number of used CPU cores.', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'UnitCpu' => ['title' => 'The number of CPU cores of each replica node in the cluster.', 'description' => 'The number of CPU cores per replica node.', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'OriginalTotalCpu' => ['title' => '原始CPU', 'description' => 'The original total number of CPU cores.', 'type' => 'number', 'format' => 'double', 'example' => '14'], + ], + 'example' => '', ], - 'CreateTime' => [ - 'title' => '参数修改的发起时间。', - 'description' => 'The time when the parameter modification was initiated.', - 'type' => 'string', - 'example' => '2024-11-26T08:03:34Z', + 'Memory' => [ + 'title' => 'The information about the memory resources of the cluster.', + 'description' => 'The memory resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => ['title' => 'The total memory size of the cluster, in GB.', 'description' => 'The total memory size, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '70'], + 'UsedMemory' => ['title' => 'The size of used memory in the cluster, in GB.', 'description' => 'The amount of memory used, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'UnitMemory' => ['title' => 'The memory size of each replica node in the cluster, in GB.', 'description' => 'The memory size of each replica node, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OriginalTotalMemory' => ['title' => '原始内存', 'description' => 'The original total memory size.', 'type' => 'number', 'format' => 'double', 'example' => '72'], + ], + 'example' => '', ], - 'DimensionValue' => [ - 'title' => '参数类型的资源标识。 如果为集群则为DEFAULT_DIMENSION_VALUE，若为租户的参数，则传入租户的TenantId。', - 'description' => 'The resource ID of the parameter type. When you called this operation to query the modification history of cluster parameters, the value is DEFAULT_DIMENSION_VALUE. When you called this operation to query the modification history of tenant parameters, the value is the tenant ID.', - 'type' => 'string', - 'example' => 't69uo********', + 'DiskSize' => [ + 'title' => 'The information about the storage resources of the cluster.', + 'description' => 'The storage resource information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => ['title' => 'The total storage space of the cluster, in GB.', 'description' => 'The total storage space, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '200'], + 'UsedDiskSize' => ['title' => 'The size of used storage space of the cluster, in GB.', 'description' => 'The used storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UnitDiskSize' => ['title' => 'The storage space of each replica node in the cluster, in GB.', 'description' => 'The storage space of each replica node, in GB.', 'type' => 'number', 'format' => 'double', 'example' => '200'], + 'OriginalTotalDiskSize' => ['title' => '原始磁盘', 'description' => 'The original total disk size.', 'type' => 'number', 'format' => 'double', 'example' => '200'], + ], + 'example' => '', ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => 'The name of the parameter.', - 'type' => 'string', - 'example' => 'connect_timeout', + 'UnitCount' => ['title' => 'The number of resource units in the cluster. ', 'description' => 'The number of resource units in the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CapacityUnit' => [ + 'description' => 'The capacity unit.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => ['description' => 'The maximum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MinCapacityUnit' => ['description' => 'The minimum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UsedCapacityUnit' => ['description' => 'The number of used capacity units.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'NewValue' => [ - 'title' => '参数修改后的值', - 'description' => 'The value of the parameter after the modification.', - 'type' => 'string', - 'example' => '30', + ], + 'example' => '', + ], + 'InstanceType' => ['description' => 'The type of the instance.'."\n" + ."\n" + .'- `cluster`: cluster instance.'."\n" + ."\n" + .'- `mtenant`: tenant instance in MySQL mode.'."\n" + ."\n" + .'- `mtenant_serverless`: Serverless instance in MySQL mode.', 'type' => 'string', 'example' => 'CLUSTER', 'title' => ''], + 'InstanceRole' => ['description' => 'The role of the instance.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'InTempCapacityStatus' => ['description' => 'Indicates whether the cluster has temporary capacity.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => 'The auto-scaling configuration of the data disk.', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => ['title' => '是否开启', 'description' => 'Indicates whether auto-scaling is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'Upperbound' => ['title' => '扩容上限', 'description' => 'The upper limit for scaling.', 'type' => 'number', 'format' => 'double', 'example' => '16'], + 'UpperThreshold' => ['title' => '日常扩容阈值', 'description' => 'The threshold for routine scaling.', 'type' => 'number', 'format' => 'double', 'example' => '80'], + 'UpperMergeThreshold' => ['title' => '合并扩容阈值', 'description' => 'The threshold for scaling out during major compactions.', 'type' => 'number', 'format' => 'double', 'example' => '90'], + 'MaxDiskSize' => ['title' => '磁盘最大值', 'description' => 'The maximum disk size.', 'type' => 'integer', 'format' => 'int64', 'example' => '80000'], + 'ScaleStepInNormal' => ['title' => '日常扩容步长'."\n", 'description' => 'The step size for routine scaling.', 'type' => 'number', 'format' => 'double', 'example' => '50'], + 'ScaleStepInMerge' => ['title' => '合并扩容步长', 'description' => 'The step size for scaling during major compactions.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'UpperScaleStrategy' => ['title' => '扩容策略（RAW/PERCENTAGE）', 'description' => 'The scaling strategy. Valid values: `RAW` and `PERCENTAGE`.', 'type' => 'string', 'example' => 'RAW'], + ], + 'example' => '', + ], + 'EnableReadOnlyReplicaManagement' => ['description' => 'Indicates whether read-only replicas can be purchased for the cluster.', 'type' => 'boolean', 'example' => 'yes', 'title' => ''], + 'SpecType' => ['title' => '规格类型', 'description' => 'The specification type.', 'type' => 'string', 'example' => 'dedicatedspec'], + 'ObRpmVersion' => ['title' => '集群的RPM版本信息'."\n" + ."\n", 'description' => 'The RPM version of the cluster.', 'type' => 'string', 'example' => '4.2.1.7-107030032024062709'], + 'ReplicaMode' => ['title' => 'Replica mode of the cluster.', 'description' => 'The replica mode of the cluster.', 'type' => 'string', 'example' => '3F、2F1A'], + 'Migratable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'MigrationInfo' => [ + 'description' => 'Information about migrating to Alibaba Cloud Marketplace.', + 'title' => 'Information about switching to Alibaba Cloud Marketplace.', + 'type' => 'object', + 'properties' => [ + 'Migratable' => ['title' => 'Switchable ', 'description' => 'Indicates whether the instance can be migrated.', 'type' => 'boolean', 'example' => ''], + 'CheckResult' => [ + 'description' => 'Provides the reason if migration is not supported.', + 'title' => 'If switching is not supported, detailed reasons are provided here.', + 'type' => 'object', + 'properties' => [ + 'Level' => ['title' => 'Result level ', 'description' => 'The level of the check result.', 'type' => 'string', 'example' => ''], + 'Code' => ['title' => 'Check item code ', 'description' => 'The code of the check item.', 'type' => 'string', 'example' => ''], + 'CodeName' => ['title' => 'Check item description ', 'description' => 'The description of the check item.', 'type' => 'string', 'example' => ''], + 'Module' => ['title' => 'Module name ', 'description' => 'The name of the module.', 'type' => 'string', 'example' => ''], + 'ModuleName' => ['title' => 'Module name description ', 'description' => 'The display name of the module.', 'type' => 'string', 'example' => ''], + 'SubModule' => ['title' => 'Submodule name', 'description' => 'The name of the submodule.', 'type' => 'string', 'example' => ''], + 'SubModuleName' => ['title' => 'Submodule name ', 'description' => 'The display name of the submodule.', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], ], + 'example' => '', ], + 'Iops' => ['type' => 'integer', 'format' => 'int32', 'example' => '10000', 'description' => '', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'TotalCount' => ['title' => 'The number of OceanBase clusters returned. ', 'description' => 'The total number of returned clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vb8qjrixzovjpy******\\",\\n \\"CommodityCode\\": \\"oceanbase_oceanbasepost_public_cn\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"State\\": \\"ONLINE\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CpuArchitecture\\": \\"X86_64、 AARCH64\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"DiskSize\\": 200,\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"ExpireSeconds\\": 2606682,\\n \\"Mem\\": 70,\\n \\"EnableUpgradeNodes\\": true,\\n \\"Cpu\\": 14,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"Version\\": \\"2.2.77\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"UsedDiskSize\\": 20,\\n \\"ResourceGroupId\\": \\"group1\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"UnitCount\\": 1,\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": 2\\n }\\n },\\n \\"InstanceType\\": \\"CLUSTER\\",\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\"\\n },\\n \\"EnableReadOnlyReplicaManagement\\": true,\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"ObRpmVersion\\": \\"4.2.1.7-107030032024062709\\",\\n \\"ReplicaMode\\": \\"3F、2F1A\\",\\n \\"Migratable\\": false,\\n \\"MigrationInfo\\": {\\n \\"Migratable\\": false,\\n \\"CheckResult\\": {\\n \\"Level\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"CodeName\\": \\"\\",\\n \\"Module\\": \\"\\",\\n \\"ModuleName\\": \\"\\",\\n \\"SubModule\\": \\"\\",\\n \\"SubModuleName\\": \\"\\"\\n }\\n },\\n \\"Iops\\": 10000\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Query cluster list ', + 'changeSet' => [ + ['createdAt' => '2025-07-03T13:53:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-22T14:06:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-02-13T13:01:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-19T06:10:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-02T12:38:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-07T09:36:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-20T11:33:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-30T13:50:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:36:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-04T02:53:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-01T03:58:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Respond\\": {\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"Parameters\\": [\\n {\\n \\"Status\\": \\"APPLIED\\",\\n \\"OldValue\\": \\"10\\",\\n \\"UpdateTime\\": \\"2024-11-26T08:03:34Z\\",\\n \\"CreateTime\\": \\"2024-11-26T08:03:34Z\\",\\n \\"DimensionValue\\": \\"t69uo********\\",\\n \\"Name\\": \\"connect_timeout\\",\\n \\"NewValue\\": \\"30\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 2\\n \\n APPLIED\\n 300\\n 2021-09-14 10:57:44\\n 2021-09-14 10:57:44\\n DEFAULT_DIMENSION_VALUE\\n connect_timeout\\n 200\\n \\n \\n","errorExample":""}]', - 'title' => ' DescribeParametersHistory', ], - 'ModifyParameters' => [ - 'summary' => 'You can call this operation to modify the parameters of a cluster or tenant. ', - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricsData' => [ + 'summary' => 'This API retrieves single- or multi-dimensional monitoring metrics for an OceanBase cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'Alibaba Cloud CLI', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'DimensionValue', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', - 'description' => 'The cause of the modification failure. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => true, 'example' => '2021-06-13T15:40:43Z', 'title' => ''], ], [ - 'name' => 'Dimension', + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => true, 'example' => '2021-06-13T15:40:43Z', 'title' => ''], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring metrics to query.
Separate multiple metrics with a comma. For example, "sql\\_all\\_count,sql\\_all\\_rt...".
', 'type' => 'string', 'required' => true, 'example' => 'sql_all_count', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => 'A string of key-value pairs. Use a colon (:) to separate keys from values, and a comma (,) to separate key-value pairs. For example: "app:OB,clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j".
'."\n" + .'The supported keys are as follows:
'."\n" + ."\n" + .'- app: The application type. Currently, only OceanBase is supported.'."\n" + ."\n" + .'- clusterId: The ID of the OceanBase cluster.'."\n" + ."\n" + .'- tenantId: The ID of the OceanBase tenant.'."\n" + ."\n" + .'- zoneId: The ID of the OceanBase zone.'."\n" + ."\n" + .'- serverId: The ID of the OBServer node.', 'type' => 'string', 'required' => true, 'example' => 'app:OB,clusterId:ob***', 'title' => ''], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'query', + 'schema' => ['description' => 'The fields by which to group the results. Separate multiple fields with a comma. For example: "app,clusterId,tenantId".', 'type' => 'string', 'required' => true, 'example' => 'app,clusterId', 'title' => ''], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'query', + 'schema' => ['description' => 'The metric key by which to sort the results.', 'type' => 'string', 'required' => false, 'example' => 'tps', 'title' => ''], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['description' => 'The sort order.'."\n" + ."\n" + .'- ASC: ascending order.'."\n" + ."\n" + .'- DESC: descending order.', 'type' => 'string', 'example' => 'DESC', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of items to return.', 'type' => 'string', 'example' => '5', 'title' => '', 'required' => false], + ], + [ + 'name' => 'ReplicaType', 'in' => 'formData', 'schema' => [ - 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', - 'description' => 'The ID of the OceanBase cluster. ', + 'description' => 'The replica type.
'."\n" + .'In OceanBase cluster monitoring, this parameter filters nodes by replica type.
'."\n" + ."\n" + .'- Default (unspecified): Retrieves monitoring data for all replica types. This applies to both OceanBase and access proxy monitoring.'."\n" + ."\n" + .'- FULL: Retrieves monitoring data from full-featured replica nodes only. This value is valid only for OceanBase monitoring.'."\n" + ."\n" + .'- READONLY: Retrieves monitoring data from read-only replica nodes only. This value is valid only for OceanBase monitoring.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TENANT', + 'required' => false, + 'enum' => ['FULL', 'READONLY'], + 'example' => 'FULL', + 'title' => '', ], ], [ - 'name' => 'Parameters', + 'name' => 'MetricScope', 'in' => 'formData', - 'schema' => [ - 'title' => '参数信息。 其为一个Json格式的数组，数组中每个对象包括两个元素：参数名称（Name）和参数值（Value）。 注意：集群和租户可修改的参数名称和参数值的范围不同，详见DescribeParameters。', - 'description' => 'The resource ID of the parameter type. '."\n" - .'You can leave this parameter unspecified when you call this operation to modify cluster parameters. In the case of tenant parameters, pass the tenant ID. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"Name":"connect_timeout","Value":"20"}]', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The parameters. '."\n" - .'It is a JSON array. Each object in the array has two elements: Name and Value. '."\n" - ."\n" - .'>
The names and values of cluster parameters that can be modified are different from those of tenant parameters. For more information, see DescribeParameters. ', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **ModifyParameters**. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Results' => [ - 'title' => '修改结果信息。', - 'description' => 'Example 1', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否修改成功。 - true：修改成功 - false：修改失败', - 'description' => ' ', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Message' => [ - 'title' => '修改失败信息。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'schedule timeout.', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => ['description' => 'A JSON-formatted string that contains the data points.', 'type' => 'string', 'example' => '[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]', 'title' => ''], + 'example' => '['."\n" + .' {'."\n" + .' "sql_select_count":75.****15****1515,'."\n" + .' "timestamp":165079****'."\n" + .' },'."\n" + .' ......'."\n" + .' ]', + 'title' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n \\"[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeMetricsData', + 'changeSet' => [ + ['createdAt' => '2025-07-03T13:53:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-15T11:26:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeMetricsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Results\\": {\\n \\"Success\\": false,\\n \\"Message\\": \\"schedule timeout.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n false\\n schedule timeout.\\n \\n","errorExample":""}]', - 'title' => 'ModifyParameters', ], - 'DescribeSessionList' => [ - 'summary' => 'You can call this operation to query sessions between the ApsaraDB for OceanBase and the application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeMetricsDataV2' => [ + 'summary' => 'You can call this operation to return metric data.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'TenantId', + 'name' => 'Metrics', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['title' => '', 'description' => 'The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt...".', 'type' => 'string', 'required' => true, 'example' => 'sql_all_rt'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The start time, in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-12T04:38:38Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The end time, in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-12T05:38:38Z'], + ], + [ + 'name' => 'Labels', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\\:). Multiple values of a key are separated with semicolons (\\;). Example: "clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*;t\\*\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j". The string can contain only the following fixed keys: '."\n" + .'* clusterId: the ID of the OceanBase cluster. '."\n" + .'* tenantId: the ID of the OceanBase Database tenant. '."\n" + .'* zoneId: the ID of the zone.'."\n" + .' * serverId: the ID of the OBServer node.', 'type' => 'string', 'required' => true, 'example' => 'clusterId:ob***'], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "clusterId,tenantId".', 'type' => 'string', 'required' => true, 'example' => 'clusterId'], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'formData', + 'schema' => ['title' => 'SortMetricKey', 'description' => 'The sort column.', 'type' => 'string', 'required' => false, 'example' => 'tps'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The sorting rule. Valid values: '."\n" + .'* ASC: in ascending order '."\n" + .'* DESC: in descending order', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The length of the data array returned after sorting.', 'type' => 'string', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'ReplicaType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" + .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" + .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried.'."\n" + .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', 'type' => 'string', 'required' => false, 'example' => 'FULL'], ], ], 'responses' => [ @@ -11842,52 +8850,66 @@ 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ - 'description' => 'The object information.', + 'title' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => 'The return result.', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'SessionId' => [ - 'title' => '代理服务的sesson Id', - 'description' => 'The session ID of the proxy service.', - 'type' => 'string', - 'example' => 'd2c90ad0-bc54-410f-bb89-2dcf14aa3c6d', + 'Labels' => [ + 'title' => '', + 'description' => 'The data label.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'clusterId:ob********', 'description' => 'The details of the label.', 'title' => ''], + 'example' => '', ], - 'Host' => [ - 'title' => '客户端地址，ip:port格式', - 'description' => 'The address of the client, with the format ip:port.', - 'type' => 'string', - 'example' => '192.***.**.100:80'."\n", + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'title' => '', + 'description' => 'The metric data.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '\'load1\': 1.29', 'description' => 'The metric data.', 'title' => ''], + 'example' => '', + ], + 'Timestamp' => ['title' => '', 'description' => 'The timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1702434300'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"4325\\",\\n \\"Host\\": \\"192.***.**.100:80\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeSessionList', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeMetricsDataV2', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Labels\\": {\\n \\"key\\": \\"clusterId:ob********\\"\\n },\\n \\"Data\\": [\\n {\\n \\"MetricValue\\": {\\n \\"key\\": \\"\'load1\': 1.29\\"\\n },\\n \\"Timestamp\\": 1702434300\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'BatchKillSessionList' => [ - 'summary' => 'You can call this operation to close sessions between the ApsaraDB for OceanBase and the application in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeSessionList.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeNodeMetrics' => [ + 'summary' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeNodeMetrics**. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11895,29749 +8917,16155 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The end time of the time range for querying monitoring data. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'description' => 'The list of nodes. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'TenantId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the tenant. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'SessionList', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '会话列表，用逗号拼接数组内容', - 'description' => 'The list of sessions, which is concatenated with commas.'."\n" - .'>The session information is obtained from the result returned by the DescribeSessionList API.', - 'type' => 'string', - 'required' => true, - 'example' => '342,354,343', - ], + 'schema' => ['title' => 'The request ID. ', 'description' => '$.parameters[6].schema.description', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - ], - ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '$.parameters[6].schema.example', 'description' => '$.parameters[6].schema.enumValueTitles', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tfafd34fs****'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', - 'title' => 'BatchKillSessionList', - ], - 'BatchKillProcessList' => [ - 'summary' => 'You can call this operation to close sessions in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeProcessStatsComposition.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => '$.parameters[9].schema.description', 'description' => '$.parameters[9].schema.example', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => '$.parameters[9].schema.enumValueTitles', 'description' => '$.parameters[7].schema.description', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], ], [ - 'name' => 'SessionList', + 'name' => 'Metrics', 'in' => 'formData', - 'schema' => [ - 'description' => 'The list of sessions to close.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"ProxySessId":"752113700739156671","SessionId":3221555062,"ServerIp":"10.***.**.***"}] ', - ], + 'schema' => ['title' => '$.parameters[7].schema.example', 'description' => '$.parameters[7].schema.enumValueTitles', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tps'], ], [ - 'name' => 'TenantId', + 'name' => 'NodeName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => true, - 'example' => 't33h8y08k****', - ], + 'schema' => ['title' => '$.parameters[8].schema.description', 'description' => '$.parameters[8].schema.example', 'type' => 'string', 'required' => false, 'example' => 'i-bp16niirq4zdmgvm****'], ], [ - 'name' => 'ByObSessionId', + 'name' => 'NodeIdList', 'in' => 'formData', - 'schema' => [ - 'title' => '表示是否根据指定的数据库连接ID来进行kill操作。默认为false，根据代理链接ID来进行KILL对应的所有数据库连接；', - 'type' => 'boolean', - ], + 'schema' => ['title' => '$.parameters[8].schema.enumValueTitles', 'description' => '$.parameters[10].schema.description', 'type' => 'string', 'required' => false, 'example' => '[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The return result of the request.', + 'title' => '$.parameters[10].schema.example', + 'description' => '$.parameters[10].schema.enumValueTitles', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The array of the return result.', - 'type' => 'array', - 'items' => [ - 'description' => 'The return result.', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the calling is successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'TotalCount' => ['title' => 'Example 1', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeNodeMetrics'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&PageSize=10'."\n" + .'&PageNumber=1'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&StartTime=2021-06-13 15:40:43'."\n" + .'&EndTime=2021-09-13 15:40:43'."\n" + .'&Metrics=tps'."\n" + .'&NodeName=i-bp16niirq4zdmgvm****'."\n" + .'&NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"]'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'RequestId' => ['title' => ' ', 'description' => 'You can call this operation to query the detailed metrics information of an OceanBase Database node. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'NodeMetrics' => ['title' => '{"name":"DescribeNodeMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeNodeMetrics\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"ob317v4uif****\\"},{\\"name\\":\\"PageSize\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"10\\"},{\\"name\\":\\"PageNumber\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"1\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tfafd34fs****\\"},{\\"name\\":\\"StartTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:40:43Z\\"},{\\"name\\":\\"EndTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-09-13T15:40:43Z\\"},{\\"name\\":\\"Metrics\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tps\\"},{\\"name\\":\\"NodeName\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"i-bp16niirq4zdmgvm****\\"},{\\"name\\":\\"NodeIdList\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"TotalCount\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"9\\"},{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"NodeMetrics\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"-\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', 'description' => 'Edge zone metric information.', 'type' => 'string', 'example' => '-'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"NodeMetrics\\": \\"-\\"\\n}","type":"json"}]', + 'title' => 'Query Edge Zone Metric Information', + 'changeSet' => [ + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeNodeMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'BatchKillProcessList', ], - 'DescribeProcessStatsComposition' => [ - 'summary' => 'You can call this operation to query session information.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeOasAnomalySQLList' => [ + 'summary' => 'This API returns a list of SQL statements flagged by the diagnostic system for potential performance issues.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'OceanBase 集群 ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the OceanBase instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'UId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The user identifier (UID) of the OceanBase database.', - 'type' => 'string', - 'required' => false, - 'example' => '139*************', - ], + 'schema' => ['description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'title' => '租户(如果是集群任务就不填)', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => false, - 'example' => 't33h8y08k****', - ], + 'schema' => ['description' => 'The beginning of the query period.
'."\n" + .'The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], ], [ - 'name' => 'SqlText', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'title' => '查询结束时间', - 'description' => 'The SQL statement, which can contain LIKE clauses. You can specify only part of the clauses in the SQL statement.', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], + 'schema' => ['description' => 'The end of the query period.
'."\n" + .'The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], ], [ - 'name' => 'ClientIp', + 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The IP address of the client.', - 'type' => 'string', - 'required' => false, - 'example' => '127.*.*.*', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'db_****', 'title' => ''], ], [ - 'name' => 'ServerIp', + 'name' => 'SearchKeyWord', 'in' => 'formData', - 'schema' => [ - 'description' => 'The IP address of the server.', - 'type' => 'string', - 'required' => false, - 'example' => '127.*.*.*', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'update', 'title' => ''], ], [ - 'name' => 'Users', + 'name' => 'SearchParam', 'in' => 'formData', - 'schema' => [ - 'description' => 'The username of the database.', - 'type' => 'string', - 'required' => false, - 'example' => '["test_user"]', - ], + 'schema' => ['description' => 'The performance metric to search by.', 'type' => 'string', 'required' => false, 'example' => 'cputime', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'SearchRule', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the session.', - 'type' => 'string', - 'required' => false, - 'example' => 'ACTIVE', - ], + 'schema' => ['description' => 'The search operator.
'."\n" + .'Valid values: `=`, `>`, `>=`, `<`, and `<=`.
', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => '0.01', 'title' => ''], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => ['description' => 'The SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => ['description' => 'The IP address of the node.', 'type' => 'string', 'required' => false, 'example' => 'i-bp19y05uq6x*********', 'title' => ''], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => ['description' => 'Use the at sign (@) to reference fields. For a list of available fields, see all columns returned by the [Query performance statistics for an SQL statement](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) API.', 'type' => 'string', 'required' => false, 'example' => '@avgCpuTime > 20 and @executions > 100', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'The language of the response.
'."\n" + .'Defaults to `zh-CN` for services in Chinese mainland and `en-US` for other regions.
', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum length of the returned SQL text.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65535', 'title' => ''], + ], + [ + 'name' => 'Current', + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Minimum value: 1.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => ['title' => '是否动态SQL', 'description' => 'Indicates if the SQL statement specified by `SqlId` is dynamic SQL.'."\n" + ."\n" + .'>
', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'MergeDynamicSql', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['title' => '返回结果时，是否合并动态 SQL', 'description' => 'Whether to merge the results of dynamic SQL statements.'."\n" + ."\n" + .'> This option aggregates SQL statements that are identical except for the values in their `IN` clauses.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The return result of the request.', + 'title' => '', + 'description' => 'The response to the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], 'Data' => [ - 'description' => 'The return result.', - 'type' => 'object', - 'properties' => [ - 'TotalSessionCount' => [ - 'description' => 'The total number of sessions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ActiveSessionCount' => [ - 'description' => 'The number of active sessions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'IdleSessionCount' => [ - 'description' => 'The number of sessions in the SLEEP state.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'AllProcessList' => [ - 'description' => 'The details of all sessions.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SqlText' => [ - 'description' => 'The SQL text.', - 'type' => 'string', - 'example' => 'select * from c1 where id = 100;', - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 'test_mysql', - ], - 'Database' => [ - 'description' => 'The name of the database.', - 'type' => 'string', - 'example' => 'c1', - ], - 'User' => [ - 'description' => 'The user to which the session belongs.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'ExecuteTime' => [ - 'description' => 'The definition of this parameter varies based on whether the SQL statement is executed.'."\n" - .'* When the request is accepted and the result is not returned to the client, this parameter indicates the time interval between the time when the request is accepted and the current time, in seconds.'."\n" - .'* When the request is not accepted, this parameter indicates the duration for which the current status lasts, in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'CpuTime' => [ - 'description' => 'The CPU time spent on executing the current SQL statement, in seconds. '."\n" - ."\n" - .'> This parameter is introduced since OceanBase Database V3.2.4 BP5.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServerIp' => [ - 'description' => 'The IP address of the server.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'SessionId' => [ - 'description' => 'The ID of the session.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '322441****', - ], - 'ProxySessId' => [ - 'description' => 'The session ID of the client. If an OceanBase Database Proxy (ODP) is used for connection, the session ID of the ODP is returned.', - 'type' => 'string', - 'example' => '7521015416********', - ], - 'Command' => [ - 'description' => 'The type of the SQL statement being executed in the session.', - 'type' => 'string', - 'example' => 'Query', - ], - 'Status' => [ - 'description' => 'The status of the session.', - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'SqlId' => [ - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'example' => '45CCBDC7DEBDCDAXXXXAFC********', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace.', - 'type' => 'string', - 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', - ], - 'PlanId' => [ - 'description' => 'The ID of the execution plan.', - 'type' => 'integer', - 'example' => '1898', - 'format' => 'int64', - ], - 'DynamicSql' => [ - 'type' => 'boolean', - ], - 'ProcessSqlLists' => [ - 'title' => '子 SQL 列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SqlText' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'Database' => [ - 'type' => 'string', - ], - 'User' => [ - 'type' => 'string', - ], - 'ExecuteTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CpuTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ServerIp' => [ - 'type' => 'string', - ], - 'ClientIp' => [ - 'type' => 'string', - ], - 'SessionId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ProxySessId' => [ - 'type' => 'string', - ], - 'Command' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'SqlId' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'PlanId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'DynamicSql' => [ - 'type' => 'boolean', - ], - 'ProcessSqlList' => [ - 'title' => '子 SQL 列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SqlText' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'Database' => [ - 'type' => 'string', - ], - 'User' => [ - 'type' => 'string', - ], - 'ExecuteTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CpuTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ServerIp' => [ - 'type' => 'string', - ], - 'ClientIp' => [ - 'type' => 'string', - ], - 'SessionId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ProxySessId' => [ - 'type' => 'string', - ], - 'Command' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'SqlId' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'PlanId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'DynamicSql' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - ], - 'ServerSn' => [ - 'type' => 'string', - ], - ], - 'description' => 'The details of all sessions.', + 'title' => '', + 'description' => 'Suspicious SQL information list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Suspicious SQL information.', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => ['description' => 'Average CPU time of suspicious SQL.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.24'], + 'AvgElapsedTime' => ['description' => 'Average response time of suspicious SQL.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.28'], + 'AvgGetPlanTime' => ['description' => 'The average time to obtain execution plans for suspicious SQL.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CpuTime' => ['description' => 'CPU time of suspicious SQL.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.23'], + 'DbName' => ['description' => 'Database name.', 'type' => 'string', 'title' => '', 'example' => 'db_***'], + 'DiagTypes' => [ + 'title' => '', + 'description' => 'Diagnosis type.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis type.', 'type' => 'string', 'example' => '['."\n" + .' "CPU_TIME_PROPORTION_HIGH"'."\n" + .']', 'title' => ''], + 'example' => '', ], - ], - 'SessionStatistics' => [ - 'description' => 'The session data in different dimensions.', - 'type' => 'object', - 'properties' => [ - 'UserStatistics' => [ - 'description' => 'The session data in the user dimension.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricValue' => [ - 'description' => 'The username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'ActiveCount' => [ - 'description' => 'The number of active sessions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Type' => [ - 'description' => 'The dimension. This value is fixed to user.', - 'type' => 'string', - 'example' => 'user', - ], - ], - 'description' => 'The session data in the user dimension.', - ], - ], - 'SourceStatistics' => [ - 'description' => 'The session data in the client dimension.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricValue' => [ - 'description' => 'The IP address of the client.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx', - ], - 'ActiveCount' => [ - 'description' => 'The number of active sessions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Type' => [ - 'description' => 'The dimension. This value is fixed to client.', - 'type' => 'string', - 'example' => 'client', - ], - ], - 'description' => 'The session data in the client dimension.', - ], - ], - 'DataBaseStatistics' => [ - 'description' => 'The session data in the database dimension.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricValue' => [ - 'description' => 'The name of the database.', - 'type' => 'string', - 'example' => 'test_database', - ], - 'ActiveCount' => [ - 'description' => 'The number of active sessions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Type' => [ - 'description' => 'The dimension. This value is fixed to database.', - 'type' => 'string', - 'example' => 'database', - ], + 'Diagnosis' => ['description' => 'Diagnosis details.'."\n" + ."\n" + .'>
This parameter is deprecated.
', 'type' => 'string', 'title' => '', 'example' => '-'], + 'Executions' => ['description' => 'The total number of executions of suspicious SQL.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1'], + 'LastExecutedTime' => ['description' => 'The last time the suspicious SQL was executed.', 'type' => 'string', 'example' => '2023-04-12T04:38:38Z', 'title' => ''], + 'RiskLevel' => ['description' => 'Risk level.', 'type' => 'string', 'title' => '', 'example' => 'high'], + 'SqlId' => ['title' => 'sql id ', 'description' => 'SQL ID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'SqlTextShort' => ['description' => 'SQL text prefix.', 'type' => 'string', 'title' => '', 'example' => 'delete /*+ XXX PARALLEL(4) */ from'], + 'Suggestion' => ['description' => 'Recommendations for suspicious SQL.', 'type' => 'string', 'title' => '', 'example' => 'review'], + 'SumElapsedTime' => ['description' => 'The total response time of suspicious SQL.', 'type' => 'number', 'format' => 'double', 'example' => '11452126.36', 'title' => ''], + 'UserName' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => 'test_user'], + 'DynamicSql' => ['title' => '是否动态SQL', 'description' => 'Whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false'], + 'SqlList' => [ + 'description' => 'SQL list.', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL list.', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => ['title' => '可疑SQL的平均cpu时间', 'description' => 'Average CPU time.', 'type' => 'number', 'format' => 'double', 'example' => '100.24'], + 'AvgElapsedTime' => ['title' => '可疑SQL的平均响应时间', 'description' => 'Average response time.', 'type' => 'number', 'format' => 'double', 'example' => '100.28'], + 'AvgGetPlanTime' => ['title' => '可疑SQL的平均获取执行计划的时间', 'description' => 'Average plan generation time.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'CpuTime' => ['title' => '可疑SQL的cpu时间', 'description' => 'Total CPU time.', 'type' => 'number', 'format' => 'double', 'example' => '100.23'], + 'DbName' => ['title' => '数据库名', 'description' => 'Database name.', 'type' => 'string', 'example' => 'test_hsp****eway'], + 'DiagTypes' => [ + 'title' => '诊断类型', + 'description' => 'Diagnosis type.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis type.', 'type' => 'string', 'example' => '['."\n" + .' "CPU_TIME_PROPORTION_HIGH"'."\n" + .' ]', 'title' => ''], + 'example' => '', ], - 'description' => 'The session data in the database dimension.', + 'Diagnosis' => ['title' => '诊断详情', 'description' => 'Diagnosis details.'."\n" + ."\n" + .'>
This parameter is deprecated.
', 'type' => 'string', 'example' => '-'], + 'Executions' => ['title' => '可疑SQL的总执行次数', 'description' => 'Total number of executions.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'LastExecutedTime' => ['title' => '最后一次执行可疑SQL的时间', 'description' => 'Last run time.', 'type' => 'string', 'example' => '2023-04-12T04:38:38Z'], + 'RiskLevel' => ['title' => '危险等级', 'description' => 'Risk level.', 'type' => 'string', 'example' => 'LOW'], + 'SqlId' => ['title' => 'sql id ', 'description' => 'SQL ID', 'type' => 'string', 'example' => '3A645****789F13DE0CF6D084FF9****'], + 'SqlTextShort' => ['title' => 'sql文本前缀', 'description' => 'SQL text.', 'type' => 'string', 'example' => 'select * from test'], + 'Suggestion' => ['title' => '可疑SQL的建议', 'description' => 'Suggestions for suspicious SQL.', 'type' => 'string', 'example' => '{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}'], + 'SumElapsedTime' => ['title' => '可疑SQL的总响应时间', 'description' => 'Total response time.', 'type' => 'number', 'format' => 'double', 'example' => '11452126.36'], + 'UserName' => ['title' => '用户名', 'description' => 'Username.', 'type' => 'string', 'example' => 'test_user'], + 'AvgDbTime' => ['title' => '平均数据库时间', 'description' => 'Average DB time.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SumDbTime' => ['title' => '总数据库时间', 'description' => 'Total DB time.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'AvgRetryCount' => ['description' => 'Average retry count.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], + 'SumRetryCount' => ['description' => 'Total retry count.', 'type' => 'number', 'format' => 'double', 'example' => '6', 'title' => ''], + 'AvgLogicalReads' => ['description' => 'Average logical read count.', 'type' => 'number', 'format' => 'double', 'example' => '25', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'AvgDbTime' => ['description' => 'Average DB time.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['title' => '总数据库时间', 'description' => 'total DB time', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'AvgRetryCount' => ['description' => 'Average retry count.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], + 'SumRetryCount' => ['description' => 'Total retry count.', 'type' => 'number', 'format' => 'double', 'example' => '6', 'title' => ''], + 'AvgLogicalReads' => ['description' => 'Average logical read count.', 'type' => 'number', 'format' => 'double', 'example' => '25', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId ', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], ], - 'ObVersion' => [ - 'title' => 'Ob版本号', - 'description' => 'The version of OceanBase Database.', - 'type' => 'string', - 'example' => '3.2.4', - ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '473469**-AA6F-4D**-B3DB-A***********'], + 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"TotalSessionCount\\": 100,\\n \\"ActiveSessionCount\\": 60,\\n \\"IdleSessionCount\\": 30,\\n \\"AllProcessList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c1\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlLists\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c2\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c3\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\\\n\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false\\n }\\n ]\\n }\\n ],\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\"\\n }\\n ],\\n \\"SessionStatistics\\": {\\n \\"UserStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_user\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"user\\"\\n }\\n ],\\n \\"SourceStatistics\\": [\\n {\\n \\"MetricValue\\": \\"xx.xx.xx.xx\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"client\\"\\n }\\n ],\\n \\"DataBaseStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_database\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"database\\"\\n }\\n ]\\n },\\n \\"ObVersion\\": \\"3.2.4\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeProcessStatsComposition', - ], - 'KillProcessList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"db_***\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 1,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"high\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ from\\",\\n \\"Suggestion\\": \\"review\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"test_hsp****eway\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n ]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 100,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"LOW\\",\\n \\"SqlId\\": \\"3A645****789F13DE0CF6D084FF9****\\",\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"Suggestion\\": \\"{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"TotalCount\\": 9\\n}","type":"json"}]', + 'title' => 'Query Suspicious SQL List ', + 'changeSet' => [ + ['createdAt' => '2025-09-23T12:29:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-11T06:41:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-08T12:08:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-02T12:38:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:37:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasAnomalySQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeOasSQLDetails' => [ + 'summary' => 'Query detailed SQL information, such as the SQL text and the names of tables involved.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'SessionList', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The list of the sessions that need to be closed.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"ServerIp":"192.168.13.119","SessionId":"3221614618"}]', - ], + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['description' => 'SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time of querying the SQL execution plan. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of querying the SQL execution plan. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether the SQL is dynamic.', 'title' => 'Is Dynamic SQL', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ParseTable', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether to parse the table schema.', 'title' => 'Parse Table Schema', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Returned response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ - 'description' => 'The data returned.', - 'type' => 'array', - 'items' => [ - 'description' => 'The data returned from the request.', - 'type' => 'object', - 'properties' => [ - 'SessionId' => [ - 'description' => 'The ID of the session.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1123', - ], - 'ServerIp' => [ - 'description' => 'The IP address of the server.', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'Status' => [ - 'description' => 'The status of the task.', - 'type' => 'string', - 'example' => 'SLEEP', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'Instance not found.', - ], - 'ClientIp' => [ - 'description' => 'The client IP address.', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't3ogqv07a56n4', - ], - 'User' => [ - 'description' => 'The database username.', - 'type' => 'string', - 'example' => 'oas', - ], - 'Database' => [ - 'description' => 'The name of the database.', - 'type' => 'string', - 'example' => 'test', - ], - 'SqlText' => [ - 'description' => 'The SQL statement.', - 'type' => 'string', - 'example' => ':', - ], - 'Command' => [ - 'description' => 'The start command for the container of the application.', - 'type' => 'string', - 'example' => 'select 1', - ], - 'ExecuteTime' => [ - 'description' => 'Execution time (UTC+8). If it is left empty, it means to execute immediately.', - 'type' => 'string', - 'example' => '142', - ], + 'description' => 'The list of the SQL execution plan.', + 'type' => 'object', + 'properties' => [ + 'Fulltext' => ['title' => '', 'description' => 'SQL text.', 'type' => 'string', 'example' => 'select * from test where id = ?'], + 'Tables' => [ + 'title' => '', + 'description' => 'The table name related to the SQL.', + 'type' => 'array', + 'items' => ['description' => 'The table name.', 'type' => 'string', 'example' => '[{"xxxx","xxxx","xxxx"},{...}...]', 'title' => ''], + 'example' => '', ], + 'UserName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'test_user'], + 'Statement' => ['title' => '', 'description' => 'Parameterized text.', 'type' => 'string', 'example' => 'select * from test where id = ?'], + 'DbName' => ['description' => 'The name of the database. ', 'type' => 'string', 'example' => 'test_db', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"Fulltext\\": \\"select * from test where id = ?\\",\\n \\"Tables\\": [\\n \\"[{\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\"},{...}...]\\"\\n ],\\n \\"UserName\\": \\"test_user\\",\\n \\"Statement\\": \\"select * from test where id = ?\\",\\n \\"DbName\\": \\"test_db\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query SQL Detailed Information', + 'changeSet' => [ + ['createdAt' => '2024-08-15T13:01:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-21T11:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": 1123,\\n \\"ServerIp\\": \\"127.*.*.*\\",\\n \\"Status\\": \\"SLEEP\\",\\n \\"ErrorMessage\\": \\"Instance not found.\\",\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"TenantId\\": \\"t3ogq******n4\\",\\n \\"User\\": \\"oas\\",\\n \\"Database\\": \\"test\\",\\n \\"SqlText\\": \\":\\",\\n \\"Command\\": \\"select 1\\",\\n \\"ExecuteTime\\": \\"142\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'KillProcessList', - 'summary' => 'You can call this operation to close a session.', ], - 'DescribeOasAnomalySQLList' => [ - 'summary' => 'You can call this API to view the list of SQL statements that are identified as having performance issues by the diagnostic system.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeOasSQLHistoryList' => [ + 'summary' => 'You can call this API to view the SQL execution history.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of the monitoring data. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['description' => 'The start time of querying the execution history of the SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of the monitoring data. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['description' => 'The end time of querying the execution history of the SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'db_****', - ], + 'schema' => ['description' => 'The name of the database. ', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ - 'name' => 'SearchKeyWord', + 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', - ], + 'schema' => ['description' => 'SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ - 'name' => 'SearchParam', + 'name' => 'NodeIp', 'in' => 'formData', - 'schema' => [ - 'description' => 'The search parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', - ], + 'schema' => ['description' => 'The IP address of the node. ', 'type' => 'string', 'required' => false, 'example' => 'i-bp19y05uq6x*********', 'title' => ''], ], [ - 'name' => 'SearchRule', + 'name' => 'AcceptLanguage', 'in' => 'formData', - 'schema' => [ - 'description' => 'The search rule. '."\n" - .'Valid values: "=", ">", ">=", "<", and "<="', - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + .'- zh: Chinese'."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], [ - 'name' => 'SearchValue', + 'name' => 'DynamicSql', 'in' => 'formData', + 'schema' => ['title' => '是否动态SQL', 'description' => 'Specifies whether the SQL statement is a dynamic SQL statement.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The search value. ', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', + 'title' => '', + 'description' => 'Returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The list of SQL execution history.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the execution history.', + 'type' => 'object', + 'properties' => [ + 'SQLId' => ['title' => 'SQL ID', 'description' => 'SQL ID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'DbName' => ['title' => '', 'description' => 'The name of the database. ', 'type' => 'string', 'example' => 'test_db'], + 'AvgAffectedRows' => ['title' => '', 'description' => 'Average updated rows during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '9978.75'], + 'AvgBlockCacheHit' => ['title' => '', 'description' => 'Average BlockCache hit count during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgBlockIndexCacheHit' => ['title' => '', 'description' => 'Average BlockIndexCache hit count during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgBloomFilterCacheHit' => ['title' => '', 'description' => 'Average BloomFilterCache hit count during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'Executions' => ['title' => '', 'description' => 'Total number of executions during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FailCount' => ['title' => '', 'description' => 'The total number of errors during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AvgRpcCount' => ['title' => '', 'description' => 'Average number of RPC sent during the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '8.0'], + 'RemotePlans' => ['title' => '', 'description' => 'Remote plan count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MissPlans' => ['title' => '', 'description' => 'Missed plan count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AvgReturnRows' => ['title' => '', 'description' => 'Average number of rows returned during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgLogicalReads' => ['title' => '', 'description' => 'Average logical reads during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'RetryCount' => ['title' => '', 'description' => 'Total number of retries during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AvgRowCacheHit' => ['title' => '', 'description' => 'Average RowCache hit count during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgDiskReads' => ['title' => '', 'description' => 'Average physical read count during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgMemstoreReadRows' => ['title' => '', 'description' => 'Average Memstore read rows during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgSsstoreReadRows' => ['title' => '', 'description' => 'Average Ssstore read rows during the execution period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0'], + 'AvgApplicationWaitTime' => ['title' => '', 'description' => 'Average Application event wait time (in milliseconds) during the client waiting period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'AvgElapsedTime' => ['title' => '', 'description' => 'Average response time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '1876.78'], + 'AvgExecuteTime' => ['title' => '', 'description' => 'Average plan execution time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '1895.7'], + 'AvgQueueTime' => ['title' => '', 'description' => 'Average queueing time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.01'], + 'AvgConcurrencyWaitTime' => ['title' => '', 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'AvgCpuTime' => ['title' => '', 'description' => 'Average CPU time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '1875.34'], + 'AvgDecodeTime' => ['title' => '', 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'AvgNetWaitTime' => ['title' => '', 'description' => 'Average network enqueue time (in milliseconds) during the network waiting period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'AvgUserIoWaitTime' => ['title' => '', 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'AvgGetPlanTime' => ['title' => '', 'description' => 'Average plan generation time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'MaxElapsedTime' => ['title' => '', 'description' => 'Max response time.', 'type' => 'number', 'format' => 'double', 'example' => '13643.3'], + 'SumWaitTime' => ['title' => '', 'description' => 'The total wait time (in milliseconds) during the internal waiting period.', 'type' => 'number', 'format' => 'double', 'example' => '9421.73'], + 'AvgScheduleTime' => ['title' => '', 'description' => 'Average Schedule event wait time (in milliseconds) during the scheduling period.', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'MaxCpuTime' => ['title' => '', 'description' => 'Max CPU time.', 'type' => 'number', 'format' => 'double', 'example' => '13641.9'], + 'SumElapsedTime' => ['description' => 'Total response time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '11452126.36', 'title' => ''], + 'Timestamp' => ['title' => '', 'description' => 'Timestamp for the sample.', 'type' => 'string', 'example' => '2023-04-12T04:46:38Z'], + 'Server' => ['title' => '', 'description' => 'The server where the SQL is executed.', 'type' => 'string', 'example' => 'i-bp1db1****8uemejio'], + 'UserName' => ['title' => '', 'description' => 'Username.', 'type' => 'string', 'example' => 'test_user'], + 'AvgPartitionCount' => ['title' => '', 'description' => 'Average number of partition accessed during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'FailPercentage' => ['title' => '', 'description' => 'Error percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode4012Count' => ['title' => '', 'description' => 'Number of occurrences of code 4012 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode4013Count' => ['title' => '', 'description' => 'Number of occurrences of code 4013 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode5001Count' => ['title' => '', 'description' => 'Number of occurrences of code 5001 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode5024Count' => ['title' => '', 'description' => 'Number of occurrences of code 5024 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode5167Count' => ['title' => '', 'description' => 'Number of occurrences of code 5167 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode5217Count' => ['title' => '', 'description' => 'Number of occurrences of code 5217 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetCode6002Count' => ['title' => '', 'description' => 'Number of occurrences of code 6002 during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgWaitTime' => ['title' => '', 'description' => 'Average wait time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '1442.49'], + 'AvgWaitCount' => ['title' => '', 'description' => 'Average number of waits during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'LocalPlanPercentage' => ['title' => '', 'description' => 'Local plan percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RemotePlanPercentage' => ['title' => '', 'description' => 'Remote plan percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DistPlanPercentage' => ['title' => '', 'description' => 'Distributed plan percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'AvgNetTime' => ['title' => '', 'description' => 'Average network transmission time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '8'], + 'AvgExecutorRpcCount' => ['title' => '', 'description' => 'Average number of RPC requests executed during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MissPlanPercentage' => ['title' => '', 'description' => 'Plan hit rage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'TableScanPercentage' => ['title' => '', 'description' => 'Table scan percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'StrongConsistencyPercentage' => ['title' => '', 'description' => 'Strong consistent transaction percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'WeakConsistencyPercentage' => ['title' => '', 'description' => 'Eventually consistent transaction percentage during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxAffectedRows' => ['title' => '', 'description' => 'Max updated rows during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'MaxReturnRows' => ['title' => '', 'description' => 'Max returned rows during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxWaitTime' => ['title' => '', 'description' => 'Max wait time (in milliseconds) during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '3.4'], + 'MaxApplicationWaitTime' => ['title' => '', 'description' => 'Max Application event wait time (in milliseconds) during the execution period', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxConcurrencyWaitTime' => ['title' => '', 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxUserIoWaitTime' => ['title' => '', 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxDiskReads' => ['title' => '', 'description' => 'Max physical read count during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExpectedWorkerCount' => ['title' => '', 'description' => 'Average degree of parallelism during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'AvgUsedWorkerCount' => ['title' => '', 'description' => 'Average number of threads used of the SQL during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'SumLogicalReads' => ['title' => '', 'description' => 'Total logical reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'ExecPs' => ['description' => 'Average execution count per second during the execution period.', 'type' => 'number', 'format' => 'double', 'example' => '0.31', 'title' => ''], + 'AvgDbTime' => ['description' => 'The average DB time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['description' => 'The total DB time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'WaitEvent' => ['description' => 'The wait event.', 'type' => 'string', 'example' => 'none', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"Executions\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"RetryCount\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"MaxElapsedTime\\": 13643.3,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgScheduleTime\\": 0,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"Timestamp\\": \\"2023-04-12T04:46:38Z\\",\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"AvgPartitionCount\\": 1,\\n \\"FailPercentage\\": 0,\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgWaitCount\\": 0,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"AvgNetTime\\": 8,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"ExecPs\\": 0.31,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"WaitEvent\\": \\"none\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOasSQLHistoryList', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLHistoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeOasSQLPlans' => [ + 'summary' => 'Retrieves SQL execution plans from the diagnosis system by SQLID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SqlId', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ - 'name' => 'NodeIp', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The node IP.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp19y05uq6x*********', - ], + 'schema' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ - 'name' => 'FilterCondition', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', - 'type' => 'string', - 'required' => false, - 'example' => '@avgCpuTime > 20 and @executions > 100', - ], + 'schema' => ['description' => 'The start of the time range to query SQL execution plans.'."\n" + ."\n" + .'The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'The end of the time range to query SQL execution plans.
'."\n" + .'The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], ], [ - 'name' => 'SqlTextLength', + 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Max length of the returned SQL text.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '65535', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', 'title' => ''], ], [ - 'name' => 'Current', + 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The current page.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AcceptLanguage', 'in' => 'formData', - 'schema' => [ - 'description' => 'Page size.'."\n" - .'- Start value: 1'."\n" - .'- Default value: 1', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- `zh-CN`: Chinese'."\n" + ."\n" + .'- `en-US`: English', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], [ 'name' => 'DynamicSql', 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'description' => 'Specifies whether the specified SQL statements are dynamic SQL statements.'."\n" - .'> This parameter specifies whether the values of the `SqlId` parameter are the IDs of dynamic SQL statements.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '是否动态SQL', 'description' => 'Specifies whether the SQL statement is a dynamic SQL.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'MergeDynamicSql', + 'name' => 'PlanUnionHash', 'in' => 'formData', - 'schema' => [ - 'title' => '返回结果时，是否合并动态 SQL', - 'description' => 'Specifies whether to merge dynamic SQL statements in the return result. '."\n" - ."\n" - .'> This parameter specifies whether to aggregate the results of IN queries.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The unique identifier of the execution plan.', 'type' => 'string', 'required' => false, 'example' => 'c4e9aaa797428df9a5a41828********', 'title' => ''], + ], + [ + 'name' => 'ReturnBriefInfo', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to return brief information about the execution plan.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => ['title' => 'Format sqlId', 'description' => 'The formatted SQL ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'Returned response.', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ - 'title' => '可疑SQL的个数', - 'description' => 'The information about suspicious SQL statements.', + 'description' => 'A list of SQL execution plans.', 'type' => 'array', 'items' => [ - 'description' => 'The information about suspicious SQL statements.', + 'description' => 'An SQL execution plan.', 'type' => 'object', 'properties' => [ - 'AvgCpuTime' => [ - 'title' => '可疑SQL的平均cpu时间', - 'description' => 'Average CPU time of the suspicious SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.24', - ], - 'AvgElapsedTime' => [ - 'title' => '可疑SQL的平均响应时间', - 'description' => 'Average response time of the suspicious SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.28', - ], - 'AvgGetPlanTime' => [ - 'title' => '可疑SQL的平均获取执行计划的时间', - 'description' => 'Average time to obtain the execution plan of the suspicious SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CpuTime' => [ - 'title' => '可疑SQL的cpu时间', - 'description' => 'CPU time of the suspicious SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.23', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'db_***', - ], - 'DiagTypes' => [ - 'title' => '诊断类型', - 'description' => 'The type of the diagnosis.', + 'PlanHash' => ['description' => 'The unique identifier for the SQL execution plan in the diagnostic system.', 'type' => 'string', 'example' => '1758****24913166****', 'title' => ''], + 'Plans' => [ + 'title' => '', + 'description' => 'A list of execution plans.', 'type' => 'array', 'items' => [ - 'description' => 'The type of the diagnosis.', - 'type' => 'string', - 'example' => '['."\n" - .' "TABLE_SCAN_INDEX_NOT_USED"'."\n" - .' ]', + 'description' => 'The details of an execution plan.', + 'type' => 'object', + 'properties' => [ + 'Uid' => ['description' => 'The plan\'s unique identifier.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAAAAAAI****AAFoT2QAF--7W****'], + 'PlanId' => ['description' => 'The plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '590****', 'title' => ''], + 'FirstLoadTime' => ['description' => 'The first load time of the execution plan.', 'type' => 'string', 'title' => '', 'example' => '2023-04-12T04:46:38Z'], + 'PlanType' => ['description' => 'The plan type. Valid values: `LOCAL`, `REMOTE`, and `DIST`.', 'type' => 'string', 'title' => '', 'example' => 'LOCAL'], + 'PlanHash' => ['description' => 'The unique identifier for the SQL execution plan in the diagnostic system.', 'type' => 'string', 'example' => '-86290582****886880', 'title' => ''], + 'PlanSize' => ['description' => 'The plan size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10****', 'title' => ''], + 'SchemaVersion' => ['description' => 'The schema version.', 'type' => 'integer', 'format' => 'int64', 'example' => '16838****3550464', 'title' => ''], + 'MergedVersion' => ['description' => 'The merged version.', 'type' => 'integer', 'format' => 'int64', 'example' => '513', 'title' => ''], + 'ObServerId' => ['description' => 'The server ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ObDbId' => ['description' => 'The database ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11006****828', 'title' => ''], + 'ServerId' => ['description' => 'The backend server instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'FirstLoadTimeUs' => ['description' => 'The first load time, in microseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684****03289441', 'title' => ''], + 'HitDiagnosis' => ['description' => 'Indicates whether the plan triggered a diagnosis.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'OutlineData' => ['description' => 'The `outline_data` field of the SQL execution plan.', 'type' => 'string', 'title' => '', 'example' => '/*+ BEGIN_OUTLINE_DATA INDEX(@\\"SEL$1\\'], + 'OutlineId' => ['description' => 'The outline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'CollectTimeUs' => ['description' => 'The collection time, in microseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684368****00000', 'title' => ''], + 'Server' => ['description' => 'The server where the SQL statement was executed.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1a9us038****jio'], + 'HitPercentage' => ['description' => 'The hit percentage.', 'type' => 'number', 'format' => 'double', 'example' => '100.0', 'title' => ''], + 'Executions' => ['description' => 'The total number of executions within the specified time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExecPs' => ['description' => 'The average number of executions per second within the specified time range.', 'type' => 'number', 'format' => 'double', 'example' => '0.31', 'title' => ''], + 'AvgDiskReads' => ['description' => 'The average number of physical reads within the specified time range.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'AvgDiskWrites' => ['description' => 'The average number of physical writes within the specified time range.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'AvgBufferGets' => ['description' => 'The average number of buffer gets within the specified time range.', 'type' => 'number', 'format' => 'double', 'example' => '30137.03', 'title' => ''], + 'AvgApplicationWaitTime' => ['description' => 'The average application wait time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'AvgConcurrencyWaitTime' => ['description' => 'The average concurrency wait time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'AvgUserIoWaitTime' => ['description' => 'The average user I/O wait time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'AvgRowProcessed' => ['description' => 'The average number of rows processed within the specified time range.', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'title' => ''], + 'AvgElapsedTime' => ['description' => 'The average elapsed time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1876.78', 'title' => ''], + 'AvgCpuTime' => ['description' => 'The average CPU time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1875.34', 'title' => ''], + 'LargeQueryPercentage' => ['description' => 'The percentage of queries that are long-running.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'DelayedLargeQueryPercentage' => ['description' => 'The percentage of long-running queries that were delayed.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'TimeoutPercentage' => ['description' => 'The timeout percentage.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'TableScan' => ['description' => 'Indicates whether the plan includes a full table scan.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PlanUnionHash' => ['description' => 'The identifier for a group of similar SQL execution plans.', 'type' => 'string', 'example' => '"52c7c53****53e61b3f7586b17****ad"', 'title' => ''], + 'SqlId' => ['description' => 'The SQL ID.', 'type' => 'string', 'example' => '46939C87ECA****95ED0FF64F44B****', 'title' => ''], + 'SqlText' => ['description' => 'The text of the SQL statement.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Diagnosis' => [ - 'title' => '诊断详情', - 'description' => 'The details of diagnosis.', - 'type' => 'string', - 'example' => '-', - ], - 'Executions' => [ - 'title' => '可疑SQL的总执行次数', - 'description' => 'Total execution count of the suspicious SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'LastExecutedTime' => [ + 'MergedVersion' => ['description' => 'The merged version.', 'type' => 'integer', 'format' => 'int64', 'example' => '513', 'title' => ''], + 'FirstLoadTime' => ['description' => 'The first load time.', 'type' => 'string', 'title' => '', 'example' => '2023-04-12T04:46:38Z'], + 'PlanType' => ['description' => 'The plan type.', 'type' => 'string', 'title' => '', 'example' => 'LOCAL'], + 'HitDiagnosis' => ['description' => 'Indicates whether the plan triggered a diagnosis.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HitPercentage' => ['description' => 'The hit percentage.', 'type' => 'number', 'format' => 'double', 'example' => '100.0', 'title' => ''], + 'AvgCpuTime' => ['description' => 'The average CPU time within the specified time range, in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1875.34', 'title' => ''], + 'PlanExplain' => [ 'title' => '', - 'description' => 'Last execution time of the suspicious SQL.', - 'type' => 'string', - 'format' => 'double', - 'example' => '2023-04-12T04:38:38Z', - ], - 'RiskLevel' => [ - 'title' => '危险等级', - 'description' => 'Risk level.', - 'type' => 'string', - 'example' => 'high', - ], - 'SqlId' => [ - 'title' => 'sql id ', - 'description' => 'SQL ID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + 'description' => 'The execution plan.', + 'type' => 'object', + 'properties' => [ + 'PlanJsonString' => ['description' => 'The JSON string of the SQL execution plan.', 'type' => 'string', 'example' => '"PlanJsonString":"{\\"RootOperations\\":[{\\"Children\\":[{\\"Children\\":[{\\"Cost\\":2000,\\"ObjectName\\":\\"TR\\",\\"Operator\\":\\"PHY_TABLE_SCAN\\",\\"Property\\":\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\",\\"Rows\\":86},{\\"Children\\":[{\\"Cost\\":2000,\\"ObjectName\\":\\"NA\\",\\"Operator\\":\\"PHY_TABLE_SCAN\\",\\"Property\\":\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\",\\"Rows\\":18}],\\"Cost\\":2013,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_SORT\\",\\"Property\\":\\"NULL\\",\\"Rows\\":18}],\\"Cost\\":4024,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_MERGE_JOIN\\",\\"Property\\":\\"NULL\\",\\"Rows\\":26}],\\"Cost\\":4025,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_SCALAR_AGGREGATE\\",\\"Property\\":\\"NULL\\",\\"Rows\\":1}]}"', 'title' => ''], + ], + 'example' => '', ], - 'SqlTextShort' => [ - 'title' => 'sql文本前缀', - 'description' => 'Prefix of the SQL text.', - 'type' => 'string', - 'example' => 'delete /*+ XXX PARALLEL(4) */ from', - ], - 'Suggestion' => [ - 'title' => '可疑SQL的建议', - 'description' => 'Suggestion for the suspicious SQL.', - 'type' => 'string', - 'example' => 'review', - ], - 'SumElapsedTime' => [ - 'title' => '', - 'description' => 'Total response time of the suspicious SQL.', - 'type' => 'number', - 'example' => '11452126.36', - 'format' => 'double', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'Username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'DynamicSql' => [ - 'title' => '是否动态SQL', - 'description' => '是否动态SQL', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SqlList' => [ - 'description' => 'The list of SQL statements.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of SQL statements.', - 'type' => 'object', - 'properties' => [ - 'AvgCpuTime' => [ - 'title' => '可疑SQL的平均cpu时间', - 'description' => 'The average CPU time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.24', - ], - 'AvgElapsedTime' => [ - 'title' => '可疑SQL的平均响应时间', - 'description' => 'The average response time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.28', - ], - 'AvgGetPlanTime' => [ - 'title' => '可疑SQL的平均获取执行计划的时间', - 'description' => 'The average plan generation time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CpuTime' => [ - 'title' => '可疑SQL的cpu时间', - 'description' => 'The total CPU time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.23', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database.', - 'type' => 'string', - 'example' => 'test_hsp****eway', - ], - 'DiagTypes' => [ - 'title' => '诊断类型', - 'description' => 'The diagnostic types.', - 'type' => 'array', - 'items' => [ - 'description' => 'The diagnostic types.', - 'type' => 'string', - 'example' => '['."\n" - .' "CPU_TIME_PROPORTION_HIGH"'."\n" - .' ]', - ], - ], - 'Diagnosis' => [ - 'title' => '诊断详情', - 'description' => 'The diagnostic details. '."\n" - ."\n" - .'> This parameter is deprecated.', - 'type' => 'string', - 'example' => '-', - ], - 'Executions' => [ - 'title' => '可疑SQL的总执行次数', - 'description' => 'The total number of executions.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'LastExecutedTime' => [ - 'description' => 'The last execution time.', - 'type' => 'string', - 'example' => '2023-04-12T04:38:38Z', - 'title' => '最后一次执行可疑SQL的时间', - ], - 'RiskLevel' => [ - 'title' => '危险等级', - 'description' => 'The risk level.', - 'type' => 'string', - 'example' => 'LOW', - ], - 'SqlId' => [ - 'title' => 'sql id ', - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'example' => '3A645****789F13DE0CF6D084FF9****', - ], - 'SqlTextShort' => [ - 'title' => 'sql文本前缀', - 'description' => 'The prefix of the SQL text.', - 'type' => 'string', - 'example' => 'select * from test', - ], - 'Suggestion' => [ - 'title' => '可疑SQL的建议', - 'description' => 'The suggestion on the suspicious SQL statement.', - 'type' => 'string', - 'example' => '{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}', - ], - 'SumElapsedTime' => [ - 'title' => '可疑SQL的总响应时间', - 'description' => 'The total response time.', - 'type' => 'number', - 'example' => '11452126.36', - 'format' => 'double', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'AvgDbTime' => [ - 'title' => '平均数据库时间', - 'description' => 'The average DB time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SumDbTime' => [ - 'title' => '总数据库时间', - 'description' => 'The total DB time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'AvgRetryCount' => [ - 'description' => 'The average number of retries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'SumRetryCount' => [ - 'description' => 'The total number of retries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '6', - ], - 'AvgLogicalReads' => [ - 'description' => 'The average number of logical reads.', - 'type' => 'number', - 'format' => 'double', - 'example' => '25', - ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', - ], - ], - ], - ], - 'AvgDbTime' => [ - 'description' => 'The average DB time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SumDbTime' => [ - 'title' => '总数据库时间', - 'description' => 'The total DB time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'AvgRetryCount' => [ - 'description' => 'The average number of retries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'SumRetryCount' => [ - 'description' => 'The total number of retries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '6', - ], - 'AvgLogicalReads' => [ - 'description' => 'The average number of logical reads.', - 'type' => 'number', - 'format' => 'double', - 'example' => '25', - ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', - ], - ], + 'Executions' => ['description' => 'The total number of executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PlanUnionHash' => ['description' => 'The identifier for a group of similar SQL execution plans.', 'type' => 'string', 'example' => '"52c7c53****53e61b3f7586b17****ad"', 'title' => ''], + 'QuerySql' => ['description' => 'The query statement.'."\n" + ."\n" + .'>
This parameter is not used and is always empty.
', 'type' => 'string', 'example' => '"select 1 from t"', 'title' => ''], + 'Bounded' => ['description' => 'Indicates whether execution plan binding is enabled for this execution plan.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TableScan' => ['title' => '该计划是否包含全表扫描', 'description' => 'Indicates whether the plan includes a full table scan.', 'type' => 'boolean', 'example' => 'false'], + 'OutlineId' => ['title' => '该计划使用的 outline id', 'description' => 'The outline ID that the plan uses.', 'type' => 'string', 'example' => '3********'], + 'OutlineStatus' => ['title' => '该计划使用outline时的状态，“已生效” 表示该计划的 outline_data 与 outline的 outlIne_content 能完全匹配上，“未知” 表示，无法判断状态。', 'description' => 'The status of the outline used by the plan. `Effective` indicates that the `outline_data` of the plan perfectly matches the `outline_content` of the outline. `Unknown` indicates that the status cannot be determined.', 'type' => 'string', 'example' => '已生效'], + 'ByFormatSqlId' => ['title' => 'Indicates whether it is a blur attach.', 'description' => 'Indicates whether fuzzy binding is enabled.', 'type' => 'boolean', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469**-AA6F-4D**-B3DB-A***********', - ], - 'TotalCount' => [ - 'description' => 'The total count. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"db_***\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 1,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"high\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ from\\",\\n \\"Suggestion\\": \\"review\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"test_hsp****eway\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n ]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 100,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"LOW\\",\\n \\"SqlId\\": \\"3A645****789F13DE0CF6D084FF9****\\",\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"Suggestion\\": \\"{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"TotalCount\\": 9\\n}","type":"json"}]', - 'title' => 'DescribeOasAnomalySQLList', - ], - 'DescribeSampleSqlRawTexts' => [ - 'summary' => 'You can call this operation to query the original text of a sampled SQL statement.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"PlanHash\\": \\"1758****24913166****\\",\\n \\"Plans\\": [\\n {\\n \\"Uid\\": \\"AAAAAAAAAAI****AAFoT2QAF--7W****\\",\\n \\"PlanId\\": 0,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"PlanSize\\": 0,\\n \\"SchemaVersion\\": 0,\\n \\"MergedVersion\\": 513,\\n \\"ObServerId\\": 2,\\n \\"ObDbId\\": 0,\\n \\"ServerId\\": 2,\\n \\"FirstLoadTimeUs\\": 0,\\n \\"HitDiagnosis\\": false,\\n \\"OutlineData\\": \\"/*+ BEGIN_OUTLINE_DATA INDEX(@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\",\\n \\"OutlineId\\": -1,\\n \\"CollectTimeUs\\": 0,\\n \\"Server\\": \\"i-bp1db1a9us038****jio\\",\\n \\"HitPercentage\\": 100,\\n \\"Executions\\": 1,\\n \\"ExecPs\\": 0.31,\\n \\"AvgDiskReads\\": 0,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgBufferGets\\": 30137.03,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgRowProcessed\\": 1,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"LargeQueryPercentage\\": 0,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TimeoutPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"SqlId\\": \\"46939C87ECA****95ED0FF64F44B****\\",\\n \\"SqlText\\": \\"\\"\\n }\\n ],\\n \\"MergedVersion\\": 513,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"HitDiagnosis\\": false,\\n \\"HitPercentage\\": 100,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"PlanExplain\\": {\\n \\"PlanJsonString\\": \\"\\\\\\"PlanJsonString\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"RootOperations\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TR\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":86},{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2013,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SORT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4024,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_MERGE_JOIN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":26}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4025,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SCALAR_AGGREGATE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":1}]}\\\\\\"\\"\\n },\\n \\"Executions\\": 1,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"QuerySql\\": \\"\\\\\\"select 1 from t\\\\\\"\\",\\n \\"Bounded\\": false,\\n \\"TableScan\\": false,\\n \\"OutlineId\\": \\"3********\\",\\n \\"OutlineStatus\\": \\"已生效\\",\\n \\"ByFormatSqlId\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query SQL Execution Plan', + 'changeSet' => [ + ['createdAt' => '2025-09-23T12:29:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-22T14:06:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-15T13:01:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:25:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-21T11:36:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeOasSlowSQLList' => [ + 'summary' => 'This operation retrieves a list of slow SQL statements.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob2mr3oae0****', - ], + 'schema' => ['description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['description' => 'Start time for querying historical slow SQL data.
'."\n" + .'This time must be in UTC format: YYYY-MM-DDThh:mm:ssZ.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['description' => 'End time for querying slow SQL data.
'."\n" + .'This time must be in UTC format: YYYY-MM-DDThh:mm:ssZ.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database.', - 'type' => 'string', - 'required' => true, - 'example' => 'test_db', - ], + 'schema' => ['description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => ['description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'update', 'title' => ''], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => ['description' => 'Query parameter.', 'type' => 'string', 'required' => false, 'example' => 'cputime', 'title' => ''], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => ['description' => 'Query rule.', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => ['description' => 'Query value.', 'type' => 'string', 'required' => false, 'example' => '0.01', 'title' => ''], ], [ 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'required' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['description' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ - 'name' => 'TraceId', + 'name' => 'NodeIp', 'in' => 'formData', - 'schema' => [ - 'description' => 'The trace ID of the executed query, which is the value of TraceId returned by DescribeSQLSamples.'."\n" - .'> Note '."\n" - .'Not all trace IDs of slow SQL statements can be used to query the original text.', - 'type' => 'string', - 'required' => false, - 'example' => 'YB420A700EFB-00060D53E42D0C61-0-0', - ], + 'schema' => ['description' => 'Database node IP address.', 'type' => 'string', 'required' => false, 'example' => 'i-bp18qljorblo8es*****', 'title' => ''], ], [ - 'name' => 'Limit', + 'name' => 'FilterCondition', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of returned rows of the SQL statement.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Reference all fields using the at sign (@). For available fields, see the columns returned by the [Query SQL performance statistics](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) operation.', 'type' => 'string', 'required' => false, 'example' => '@avgCpuTime > 20 and @executions > 100', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'Language for returned data.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => ['description' => 'Maximum length of the returned SQL text.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65535', 'title' => ''], ], [ 'name' => 'DynamicSql', 'in' => 'formData', - 'schema' => [ - 'title' => '是否为聚合sql', - 'description' => 'Specifies whether the SQL statement is an aggregation statement.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => 'Is Dynamic SQL', 'description' => 'Indicates whether the SQL is dynamic.'."\n" + ."\n" + .'>
Specifies whether the provided SQL ID belongs to a dynamic SQL statement.
', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => ['title' => 'When returning results, is dynamic SQL merged? ', 'description' => 'Indicates whether to merge dynamic SQL statements in the response.'."\n" + ."\n" + .'>
Specifies whether to aggregate results for SQL statements with IN clauses.
', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', + 'title' => '', + 'description' => 'Response to the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ - 'description' => 'The data list.', - 'type' => 'object', - 'properties' => [ - 'SqlText' => [ - 'description' => 'The SQL statement.', - 'type' => 'array', - 'items' => [ - 'description' => 'The SQL statement.', - 'type' => 'string', - 'example' => '{ "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C", "Data": { "SqlText": [ "\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\"" ] } }', + 'description' => 'List of slow SQL information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Slow SQL information.', + 'type' => 'object', + 'properties' => [ + 'Executions' => ['description' => 'Number of SQL executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RpcCount' => ['description' => 'Number of RPC calls during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemotePlans' => ['description' => 'Number of remote executions during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'MissPlans' => ['description' => 'Number of times the execution plan was not found in the cache during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'MaxElapsedTime' => ['description' => 'Maximum response time during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '260.044'], + 'TotalWaitTime' => ['description' => 'Total wait time during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '10.966'], + 'ExecPs' => ['description' => 'Average number of executions per second during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.31'], + 'MaxCpuTime' => ['description' => 'Maximum CPU time.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '257.967'], + 'ClientIp' => ['description' => 'Client IP address.', 'type' => 'string', 'title' => '', 'example' => '1*2.***.1*3.***'], + 'UserName' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => 'test_user'], + 'DbName' => ['description' => 'Database name.', 'type' => 'string', 'title' => '', 'example' => 'test_db'], + 'RetCode4012Count' => ['description' => 'Number of occurrences of error code 4012.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode4013Count' => ['description' => 'Number of occurrences of error code 4013.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5001Count' => ['description' => 'Number of occurrences of error code 5001.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5024Count' => ['description' => 'Number of occurrences of error code 5024.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5167Count' => ['description' => 'Number of occurrences of error code 5167.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5217Count' => ['description' => 'Number of occurrences of error code 5217.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode6002Count' => ['description' => 'Number of occurrences of error code 6002.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'FailPercentage' => ['description' => 'SQL execution error rate.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'SumWaitTime' => ['description' => 'Wait time (in milliseconds) for the longest wait event.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '9421.73'], + 'AvgWaitCount' => ['description' => 'Average number of waits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgRpcCount' => ['description' => 'Average number of RPC calls.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '8.0'], + 'LocalPlanPercentage' => ['description' => 'Percentage of local plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'RemotePlanPercentage' => ['description' => 'Percentage of remote plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'DistPlanPercentage' => ['description' => 'Percentage of distributed plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], + 'SumElapsedTime' => ['description' => 'Total response time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '11452126.36'], + 'AvgNetTime' => ['description' => 'Average network I/O time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExecutorRpcCount' => ['description' => 'Number of remote executions, corresponding to v$sl\\_audit.executor\\_rpc.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MissPlanPercentage' => ['description' => 'Percentage of plans not found in cache.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'TableScanPercentage' => ['description' => 'Percentage of full table scans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'StrongConsistencyPercentage' => ['description' => 'Percentage of strong reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], + 'WeakConsistencyPercentage' => ['description' => 'Percentage of weak reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxAffectedRows' => ['description' => 'Maximum number of affected rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '10000.0'], + 'MaxReturnRows' => ['description' => 'Maximum number of returned rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxWaitTime' => ['description' => 'Maximum wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3.4'], + 'MaxApplicationWaitTime' => ['description' => 'Maximum application wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxConcurrencyWaitTime' => ['description' => 'Maximum concurrency wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxUserIoWaitTime' => ['description' => 'Maximum I/O wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxDiskReads' => ['description' => 'Maximum number of disk reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExpectedWorkerCount' => ['description' => 'Expected concurrency.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3'], + 'AvgUsedWorkerCount' => ['description' => 'Average number of threads used.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3'], + 'SumLogicalReads' => ['description' => 'Total logical reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'Server' => ['description' => 'OBServer', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1a**s038**mej**'], + 'ServerIp' => ['description' => 'OBServer IP', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1a**s038**mej**'], + 'ServerPort' => ['description' => 'OBServer port', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10110'], + 'SqlTextShort' => ['description' => 'SQL text (first 100 characters).', 'type' => 'string', 'title' => '', 'example' => 'select a from b where'], + 'SqlType' => ['description' => 'SQL type.', 'type' => 'string', 'title' => '', 'example' => 'select '], + 'SqlId' => ['title' => 'SQL id', 'description' => 'SQL ID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'Inner' => ['description' => 'Indicates whether the SQL is internal.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'WaitEvent' => ['description' => 'Longest wait event.', 'type' => 'string', 'title' => '', 'example' => 'none'], + 'AvgAffectedRows' => ['description' => 'Average number of affected rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '9978.75'], + 'AvgReturnRows' => ['description' => 'Average number of returned rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgPartitionCount' => ['description' => 'Average number of partitions accessed.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1.0'], + 'FailCount' => ['description' => 'Number of execution errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AvgWaitTime' => ['description' => 'Average wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1.42'], + 'AvgElapsedTime' => ['description' => 'Average response time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1876.78'], + 'AvgCpuTime' => ['description' => 'Average CPU time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1875.34'], + 'AvgNetWaitTime' => ['description' => 'Average network time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgQueueTime' => ['description' => 'Average queue time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.01'], + 'AvgDecodeTime' => ['description' => 'Average parsing time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgGetPlanTime' => ['description' => 'Average time to get an execution plan (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExecuteTime' => ['description' => 'Average SQL execution time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1895.7'], + 'AvgApplicationWaitTime' => ['description' => 'Average application wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgConcurrencyWaitTime' => ['description' => 'Average concurrency wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgUserIoWaitTime' => ['description' => 'Average user I/O time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgScheduleTime' => ['description' => 'Average scheduling time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgRowCacheHit' => ['description' => 'Average number of Row Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBloomFilterCacheHit' => ['description' => 'Average number of Bloom Filter Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBlockCacheHit' => ['description' => 'Average number of Block Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBlockIndexCacheHit' => ['description' => 'Average number of Block Index Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgDiskReads' => ['description' => 'Average number of disk reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'RetryCount' => ['description' => 'Number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'AvgMemstoreReadRows' => ['description' => 'Average number of Memstore rows read.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgSsstoreReadRows' => ['description' => 'Average number of SSTable rows read.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgLogicalReads' => ['description' => 'Average logical reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'DynamicSql' => ['title' => 'Is Dynamic SQL', 'description' => 'Indicates whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false'], + 'SqlList' => [ + 'description' => 'List of SQL statements.', + 'type' => 'array', + 'items' => [ + 'description' => 'Response result.', + 'type' => 'object', + 'properties' => [ + 'Executions' => ['description' => 'Total number of executions during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RpcCount' => ['title' => 'Number of RPC calls during the period', 'description' => 'Total number of RPC calls.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'RemotePlans' => ['description' => 'Number of remote executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MissPlans' => ['description' => 'Number of times the plan cache was missed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MaxElapsedTime' => ['title' => 'Maximum response time during the period', 'description' => 'Maximum response time.', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'TotalWaitTime' => ['title' => 'Total wait time during the period ', 'description' => 'Total wait time (in ms) during SQL execution, corresponding to v$sql\\_audit.total\\_wait\\_time\\_micro (in μs).', 'type' => 'number', 'format' => 'double', 'example' => '100000'], + 'ExecPs' => ['title' => 'Average executions per second during the period ', 'description' => 'SQL execution frequency.', 'type' => 'number', 'format' => 'double', 'example' => '0.31'], + 'MaxCpuTime' => ['title' => 'Maximum CPU time', 'description' => 'Maximum CPU time.', 'type' => 'number', 'format' => 'double', 'example' => '257.967'], + 'ClientIp' => ['title' => 'Client IP address. ', 'description' => 'Client IP address.', 'type' => 'string', 'example' => '127.0.0.1'], + 'UserName' => ['title' => 'Username', 'description' => 'Username.', 'type' => 'string', 'example' => 'admin'], + 'DbName' => ['title' => 'Database name', 'description' => 'Database name.', 'type' => 'string', 'example' => 'test'], + 'RetCode4012Count' => ['title' => 'Number of occurrences of result code 4012 during the period ', 'description' => 'Number of occurrences of error code 4012.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode4013Count' => ['title' => 'Number of occurrences of result code 4013 during the period', 'description' => 'Number of occurrences of error code 4013.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode5001Count' => ['title' => 'Number of occurrences of result code 5001 during the period', 'description' => 'Number of occurrences of error code 5001.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode5024Count' => ['title' => 'Number of occurrences of result code 5024 during the period', 'description' => 'Number of occurrences of error code 5024.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode5167Count' => ['title' => 'Count of result code 5167 occurrences during the period ', 'description' => 'Number of occurrences of error code 5167.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode5217Count' => ['title' => 'Number of occurrences of result code 5217 during the period', 'description' => 'Number of occurrences of error code 5217.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetCode6002Count' => ['title' => 'Count of result code 6002 occurrences during the period ', 'description' => 'Number of occurrences of error code 6002.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'FailPercentage' => ['title' => 'Error percentage during the period', 'description' => 'SQL execution error rate.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'SumWaitTime' => ['title' => 'Total wait time (in milliseconds) during the period', 'description' => 'Wait time (in milliseconds) for the longest wait event.', 'type' => 'number', 'format' => 'double', 'example' => '9421.73'], + 'AvgWaitCount' => ['title' => 'Average number of waits during the period', 'description' => 'Average wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgRpcCount' => ['title' => 'Average number of RPC sends during the period', 'description' => 'Average number of RPC calls.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'LocalPlanPercentage' => ['title' => 'Local Plan Percentage During the Period ', 'description' => 'Percentage of local plans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RemotePlanPercentage' => ['title' => 'Remote Plan Percentage During the Period ', 'description' => 'Percentage of remote plans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DistPlanPercentage' => ['title' => 'Percentage of distributed plans during the period', 'description' => 'Percentage of distributed plans.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SumElapsedTime' => ['title' => 'Total response time during the period (ms)', 'description' => 'Total response time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '11452126.36'], + 'AvgNetTime' => ['title' => 'Average Network Transmission Time During the Period (ms) ', 'description' => 'Average network I/O time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExecutorRpcCount' => ['title' => 'Average number of RPC requests for execution during the period', 'description' => 'Number of remote executions, corresponding to v$sl\\_audit.executor\\_rpc.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MissPlanPercentage' => ['title' => 'Plan hit rate during the period ', 'description' => 'Percentage of plans not found in cache.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'TableScanPercentage' => ['title' => 'Table scan percentage during the period', 'description' => 'Percentage of full table scans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'StrongConsistencyPercentage' => ['title' => 'Percentage of transactions with strong consistency during the period', 'description' => 'Percentage of strong reads.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'WeakConsistencyPercentage' => ['title' => 'Percentage of transactions with weak consistency during the period', 'description' => 'Percentage of weak reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxAffectedRows' => ['title' => 'Maximum number of affected rows during the period ', 'description' => 'Maximum number of affected rows.', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'MaxReturnRows' => ['title' => 'Maximum number of returned rows during the period', 'description' => 'Maximum number of returned rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxWaitTime' => ['title' => 'Maximum wait time during the period (in milliseconds)', 'description' => 'Maximum wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '3.4'], + 'MaxApplicationWaitTime' => ['title' => 'Maximum management event wait time during the period (in milliseconds)', 'description' => 'Maximum application wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxConcurrencyWaitTime' => ['title' => 'Maximum concurrency wait time (in milliseconds) during the period ', 'description' => 'Maximum concurrency wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxUserIoWaitTime' => ['title' => 'Maximum UserIO event wait time during the period (in milliseconds) ', 'description' => 'Maximum I/O wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxDiskReads' => ['title' => 'Maximum number of physical reads during the period', 'description' => 'Maximum number of disk reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExpectedWorkerCount' => ['title' => 'Average degree of parallelism during the period', 'description' => 'Expected concurrency.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'AvgUsedWorkerCount' => ['title' => 'Average number of threads used by the SQL statement during the period', 'description' => 'Concurrency used.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'SumLogicalReads' => ['title' => 'Total SQL logical reads during the period', 'description' => 'Total logical reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'Server' => ['title' => 'Server where the SQL was executed', 'description' => 'OBServer', 'type' => 'string', 'example' => '10.**.**.6'], + 'ServerIp' => ['title' => 'IP address of the server where the SQL is executed', 'description' => 'OBServer IP', 'type' => 'string', 'example' => '11.***.**.69'], + 'ServerPort' => ['title' => 'Port of the server where the SQL is executed', 'description' => 'OBServer port', 'type' => 'integer', 'format' => 'int64', 'example' => '389'], + 'SqlTextShort' => ['title' => 'SQL text (first 100 characters)', 'description' => 'SQL text (first 100 characters).', 'type' => 'string', 'example' => 'select * from test'], + 'SqlType' => ['title' => 'SQL Type ', 'description' => 'SQL type.', 'type' => 'string', 'example' => 'SELECT'], + 'SqlId' => ['title' => 'SQL ID ', 'description' => 'SQL ID', 'type' => 'string', 'example' => '4CE89****8536A03374DD2****E76DE5'], + 'Inner' => ['title' => 'Is internal SQL ', 'description' => 'Indicates whether the SQL is internal.', 'type' => 'boolean', 'example' => 'false'], + 'WaitEvent' => ['title' => 'Longest wait event during the period ', 'description' => 'Longest wait event.', 'type' => 'string', 'example' => 'none'], + 'AvgAffectedRows' => ['title' => 'Average Number of Updated Rows During the Period ', 'description' => 'Average number of affected rows.', 'type' => 'number', 'format' => 'double', 'example' => '9978.75'], + 'AvgReturnRows' => ['title' => 'Average number of rows returned during the period', 'description' => 'Average number of returned rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgPartitionCount' => ['title' => 'Average number of partitions accessed during the period', 'description' => 'Average number of partitions accessed.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'FailCount' => ['description' => 'Number of execution errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'AvgWaitTime' => ['title' => 'Average wait time during the period (ms)', 'description' => 'Average wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '1.42'], + 'AvgElapsedTime' => ['title' => 'Average response time (in milliseconds) during the period ', 'description' => 'Average response time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '1876.78'], + 'AvgCpuTime' => ['title' => 'Average CPU time (milliseconds) during the period', 'description' => 'Average CPU time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '@avgCpuTime > 20 and @executions > 100'], + 'AvgNetWaitTime' => ['title' => 'Average network enqueue time during the period (ms)', 'description' => 'Average network time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgQueueTime' => ['title' => 'Average queue time during the period (in milliseconds)', 'description' => 'Average queue time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0.01'], + 'AvgDecodeTime' => ['title' => 'Average syntax parse time during the period (ms)', 'description' => 'Average syntax parsing time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgGetPlanTime' => ['title' => 'Average Plan Generation Time During the Period (ms) ', 'description' => 'Average plan generation time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExecuteTime' => ['title' => 'Average plan execution time during the period (in milliseconds)', 'description' => 'Average plan execution time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '1895.7'], + 'AvgApplicationWaitTime' => ['title' => 'Average management event wait time during the period (in milliseconds)', 'description' => 'Average application wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgConcurrencyWaitTime' => ['title' => 'Average wait time for concurrency management events during the period (ms)', 'description' => 'Average concurrency wait time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgUserIoWaitTime' => ['title' => 'Average UserIO event wait time during the period (in milliseconds) ', 'description' => 'Average user I/O time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgScheduleTime' => ['title' => 'Average wait time for schedule events during the period (in milliseconds)', 'description' => 'Average scheduling time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgRowCacheHit' => ['title' => 'Average Row Cache hit count during the period', 'description' => 'Average number of Row Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBloomFilterCacheHit' => ['title' => 'Average Bloom Filter Cache hit count during the period', 'description' => 'Average number of Bloom Filter Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBlockCacheHit' => ['title' => 'Average Block Cache hit count during the period', 'description' => 'Average number of Block Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBlockIndexCacheHit' => ['title' => 'Average number of BlockIndexCache hits during the period', 'description' => 'Average number of Block Index Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgDiskReads' => ['title' => 'Average number of physical reads during the period', 'description' => 'Average number of disk reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetryCount' => ['description' => 'Number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AvgMemstoreReadRows' => ['title' => 'Percentage of strong consistency transactions during the period', 'description' => 'Average number of Memstore rows read.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgSsstoreReadRows' => ['title' => 'Percentage of weak consistency transactions during the period', 'description' => 'Average number of SSTable rows read.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgLogicalReads' => ['title' => 'Average logical reads of SQL during the period ', 'description' => 'Average logical reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgDbTime' => ['description' => 'Average database time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['description' => 'Total database time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AvgDbTime' => ['description' => 'Average database time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['description' => 'Total database time (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"TotalWaitTime\\": 10.966,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerIp\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerPort\\": 10110,\\n \\"SqlTextShort\\": \\"select a from b where\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 5,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"127.0.0.1\\",\\n \\"UserName\\": \\"admin\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 0,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"10.**.**.6\\",\\n \\"ServerIp\\": \\"11.***.**.69\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"SqlType\\": \\"SELECT\\",\\n \\"SqlId\\": \\"4CE89****8536A03374DD2****E76DE5\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 22,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 0,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Slow SQL Query List', + 'changeSet' => [ + ['createdAt' => '2025-09-23T12:29:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-08T12:08:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:36:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSlowSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"SqlText\\": [\\n \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"EE205C00-30E4-****-****-87E3A8A2AA0C\\\\\\",\\\\n \\\\\\"Data\\\\\\": {\\\\n \\\\\\"SqlText\\\\\\": [\\\\n \\\\\\"\\\\\\\\\\\\\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\\\\\\\\\\\\\"\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeSampleSqlRawTexts', ], - 'DescribeOasSQLDetails' => [ - 'summary' => 'You can call this API to query detailed information about the SQL, including the SQL text, related table names, and so on.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeOasTopSQLList' => [ + 'summary' => 'Queries the list of SQL execution performance data collected by the diagnostic system.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], + 'schema' => ['description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ - 'name' => 'SqlId', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['description' => 'Start time for querying TOPSQL parameters. Use UTC time in the format YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'End time for querying TOPSQL parameters. Use UTC time in the format YYYY-MM-DDThh:mm:ssZ.'."\n" + ."\n" + .'This time supports only UTC in the format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_db', - ], + 'schema' => ['description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'SearchKeyWord', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying the SQL execution plan. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['description' => 'Keyword query.', 'type' => 'string', 'required' => false, 'example' => 'update', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SearchParam', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying the SQL execution plan. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['description' => 'Parameter query.', 'type' => 'string', 'required' => false, 'example' => 'cputime', 'title' => ''], ], [ - 'name' => 'DynamicSql', + 'name' => 'SearchRule', 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Query rule.', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], ], [ - 'name' => 'ParseTable', + 'name' => 'SearchValue', 'in' => 'formData', - 'schema' => [ - 'title' => '是否解析表结构', - 'type' => 'boolean', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '', - 'description' => 'Returned response.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The list of the SQL execution plan.', - 'type' => 'object', - 'properties' => [ - 'Fulltext' => [ - 'title' => 'SQL 文本', - 'description' => 'SQL text.', - 'type' => 'string', - 'example' => 'select a from b', - ], - 'Tables' => [ - 'title' => 'SQL 涉及的表名', - 'description' => 'The table name related to the SQL.', - 'type' => 'array', - 'items' => [ - 'description' => 'The table name.', - 'type' => 'string', - 'example' => '[{"xxxx","xxxx","xxxx"},{...}...]', - ], - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'Statement' => [ - 'title' => '参数化后的文本', - 'description' => 'Parameterized text.', - 'type' => 'string', - 'example' => 'select a from b', - ], - 'DbName' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'test_db', - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"Fulltext\\": \\"select * from test where id = ?\\",\\n \\"Tables\\": [\\n \\"[{\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\"},{...}...]\\"\\n ],\\n \\"UserName\\": \\"test_user\\",\\n \\"Statement\\": \\"select * from test where id = ?\\",\\n \\"DbName\\": \\"test_db\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeOasSQLDetails', - ], - 'DescribeOasSQLPlans' => [ - 'summary' => 'You can call this API to retrieve information about the SQL execution plan stored in the diagnostic system based on the SQL ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying the SQL execution plan. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['description' => 'Query value.', 'type' => 'string', 'required' => false, 'example' => '0.01', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SqlId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying the SQL execution plan. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['description' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ - 'name' => 'DbName', + 'name' => 'NodeIp', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_db', - ], + 'schema' => ['description' => 'Node IP.', 'type' => 'string', 'required' => false, 'example' => 'i-bp18l4****str4uk03', 'title' => ''], ], [ - 'name' => 'SqlId', + 'name' => 'FilterCondition', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['description' => 'Reference all fields using the @ symbol. For available fields, see the columns returned by the [Query SQL performance statistics](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) API.', 'type' => 'string', 'required' => false, 'example' => '@avgCpuTime > 20 and @executions > 100', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'formData', - 'schema' => [ - 'description' => 'Supported language. Valid values:'."\n" - .'- zh-CN: Chinese'."\n" - .'- en-US: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'Language for returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + ."\n" + .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], [ - 'name' => 'DynamicSql', + 'name' => 'SqlTextLength', 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'description' => 'Specifies whether the SQL statement is dynamic.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Maximum length of the returned SQL text.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65535', 'title' => ''], ], [ - 'name' => 'PlanUnionHash', + 'name' => 'DynamicSql', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the execution plan.', - 'type' => 'string', - 'required' => false, - 'example' => 'c4e9aaa797428df9a5a41828********', - ], + 'schema' => ['title' => 'Is Dynamic SQL', 'description' => 'Indicates whether the SQL is dynamic.'."\n" + ."\n" + .'>
Specifies whether the provided SQL ID belongs to a dynamic SQL statement.
', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'ReturnBriefInfo', + 'name' => 'MergeDynamicSql', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to return an overview of the execution plan.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => 'Whether to Merge Dynamic SQL in the Return Result', 'description' => 'Indicates whether to merge dynamic SQL statements in the response.'."\n" + ."\n" + .'>
Specifies whether to aggregate results for SQL statements containing IN clauses.
', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'FormatSqlId', + 'name' => 'CustomColumns', 'in' => 'formData', - 'schema' => [ - 'title' => 'format sqlId', - 'type' => 'string', - ], + 'schema' => ['title' => 'Custom Fields Rule', 'description' => 'Custom field rules. Reference all fields using the @ symbol. Supported operators include `+、-、*、/`. Field names must start with a lowercase letter. For available fields, see the columns returned by the [Query SQL performance statistics](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) API.', 'type' => 'string', 'required' => false, 'example' => '@failCount/@executions'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'Returned response.', + 'description' => 'Response to the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ - 'description' => 'The list of SQL execution plan.', + 'description' => 'List of TopSQL information.', 'type' => 'array', 'items' => [ - 'description' => 'The list of SQL execution plan.', + 'description' => 'TopSQL information.', 'type' => 'object', 'properties' => [ - 'PlanHash' => [ - 'description' => 'The internal identifier of the SQL execution plan in the diagnostic system.', - 'type' => 'string', - 'example' => '1758****24913166****', - ], - 'Plans' => [ - 'title' => '执行计划列表', - 'description' => 'The list of the execution plan.', + 'Executions' => ['description' => 'Number of SQL executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RpcCount' => ['description' => 'Total number of SQL RPC calls.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100'], + 'RemotePlans' => ['description' => 'Number of remote SQL executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MissPlans' => ['description' => 'Number of times the SQL plan cache was missed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MaxElapsedTime' => ['description' => 'Maximum SQL response time.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '10000'], + 'TotalWaitTime' => ['description' => 'Total wait time in milliseconds during SQL execution. This corresponds to v$sql\\_audit.total\\_wait\\_time\\_micro (in milliseconds).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100000'], + 'ExecPs' => ['description' => 'SQL execution frequency.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.31'], + 'MaxCpuTime' => ['description' => 'Maximum CPU time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '13641.9'], + 'CpuPercentage' => ['description' => 'CPU usage percentage.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], + 'ClientIp' => ['description' => 'Client IP address.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db****38uemejio'], + 'UserName' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => 'test_user'], + 'DbName' => ['description' => 'Database name.', 'type' => 'string', 'title' => '', 'example' => 'test_db'], + 'RetCode4012Count' => ['description' => 'Number of occurrences of error code 4012 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode4013Count' => ['description' => 'Number of occurrences of error code 4013 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5001Count' => ['description' => 'Number of occurrences of error code 5001 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5024Count' => ['description' => 'Number of occurrences of error code 5024 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5167Count' => ['description' => 'Number of occurrences of error code 5167 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5217Count' => ['description' => 'Number of occurrences of error code 5217 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode6002Count' => ['description' => 'Number of occurrences of error code 6002 during the period.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'FailPercentage' => ['description' => 'Error percentage during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'SumWaitTime' => ['description' => 'Total wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '9421.73'], + 'AvgWaitCount' => ['description' => 'Average number of waits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgRpcCount' => ['description' => 'Average number of SQL RPC calls.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '8.0'], + 'LocalPlanPercentage' => ['description' => 'Percentage of SQL local plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'RemotePlanPercentage' => ['description' => 'Percentage of SQL remote plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'DistPlanPercentage' => ['description' => 'Percentage of SQL distributed plans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], + 'SumElapsedTime' => ['description' => 'Total SQL response time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '11452126.36'], + 'AvgNetTime' => ['description' => 'Average network transmission time in milliseconds during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExecutorRpcCount' => ['description' => 'Number of remote SQL executions. This corresponds to v$sl\\_audit.executor\\_rpc.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MissPlanPercentage' => ['description' => 'Percentage of SQL plan cache misses.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'TableScanPercentage' => ['description' => 'Percentage of full table scans.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'StrongConsistencyPercentage' => ['description' => 'Percentage of strong reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100.0'], + 'WeakConsistencyPercentage' => ['description' => 'Percentage of weak reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxAffectedRows' => ['description' => 'Maximum number of affected rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '10000.0'], + 'MaxReturnRows' => ['description' => 'Maximum number of returned rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxWaitTime' => ['description' => 'Maximum wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3.4'], + 'MaxApplicationWaitTime' => ['description' => 'Maximum application wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxConcurrencyWaitTime' => ['description' => 'Maximum I/O wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxUserIoWaitTime' => ['description' => 'Maximum UserIO event wait time in milliseconds during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'MaxDiskReads' => ['description' => 'Maximum number of disk reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExpectedWorkerCount' => ['description' => 'Expected concurrency.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3'], + 'AvgUsedWorkerCount' => ['description' => 'Average number of threads used by SQL during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3'], + 'SumLogicalReads' => ['description' => 'Total logical reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'Server' => ['description' => 'OBServer.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1****8uemejio'], + 'ServerIp' => ['description' => 'OBServer IP.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1****8uemejio'], + 'ServerPort' => ['description' => 'OBServer port.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '389'], + 'SqlTextShort' => ['description' => 'SQL text (first 100 characters).', 'type' => 'string', 'title' => '', 'example' => 'delete /*+ XXX PARALLEL(4) */ fro'], + 'SqlType' => ['description' => 'SQL type.', 'type' => 'string', 'title' => '', 'example' => 'select '], + 'SqlId' => ['title' => 'SQL id', 'description' => 'SQL ID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'Inner' => ['description' => 'Indicates whether the SQL is internal.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'WaitEvent' => ['description' => 'Longest wait event.', 'type' => 'string', 'title' => '', 'example' => 'none'], + 'AvgAffectedRows' => ['description' => 'Average number of affected rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '9978.75'], + 'AvgReturnRows' => ['description' => 'Average number of returned rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgPartitionCount' => ['description' => 'Average number of partitions accessed during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1.0'], + 'FailCount' => ['description' => 'Number of execution errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AvgWaitTime' => ['description' => 'Average wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1442.49'], + 'AvgElapsedTime' => ['description' => 'Average response time in milliseconds during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '903.29'], + 'AvgCpuTime' => ['description' => 'Average CPU time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1875.34'], + 'AvgNetWaitTime' => ['description' => 'Average network time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgQueueTime' => ['description' => 'Average queue time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.01'], + 'AvgDecodeTime' => ['description' => 'Average parsing time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgGetPlanTime' => ['description' => 'Average time to get the execution plan in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgExecuteTime' => ['description' => 'Average SQL execution time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1895.7'], + 'AvgApplicationWaitTime' => ['description' => 'Average application wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgConcurrencyWaitTime' => ['description' => 'Average concurrency wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgUserIoWaitTime' => ['description' => 'Average user I/O time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgScheduleTime' => ['description' => 'Average scheduling time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgRowCacheHit' => ['description' => 'Average number of Row Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBloomFilterCacheHit' => ['description' => 'Average number of Bloom Filter Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBlockCacheHit' => ['description' => 'Average number of Block Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgBlockIndexCacheHit' => ['description' => 'Average number of Block Index Cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgDiskReads' => ['description' => 'Average number of physical reads during the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'RetryCount' => ['description' => 'Number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AvgMemstoreReadRows' => ['description' => 'Average number of Memstore read rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgSsstoreReadRows' => ['description' => 'Average number of SSTable read rows.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'AvgLogicalReads' => ['description' => 'Average logical reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'DynamicSql' => ['title' => 'Is Dynamic SQL', 'description' => 'Indicates whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false'], + 'SqlList' => [ + 'description' => 'List of SQL statements.'."\n" + ."\n" + .'>
This parameter appears only when mergeDynamicSql is set to true and the query contains an IN clause.
', + 'title' => 'SQL List', 'type' => 'array', 'items' => [ - 'description' => 'The list of the execution plan.', + 'description' => 'Response to the request.', 'type' => 'object', 'properties' => [ - 'Uid' => [ - 'title' => 'Plan的唯一标识', - 'description' => 'The unique identifier of the plan.', - 'type' => 'string', - 'example' => 'AAAAAAAAAAI****AAFoT2QAF--7W****', - ], - 'PlanId' => [ - 'description' => 'The ID of the plan.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '590****', - ], - 'FirstLoadTime' => [ - 'title' => 'Plan首次被加载的时间', - 'description' => 'First time to load the plan.', - 'type' => 'string', - 'example' => '2023-04-12T04:46:38Z', - ], - 'PlanType' => [ - 'title' => 'Plan的类型：LOCAL、REMOTE、DIST', - 'description' => 'Plan type, including LOCAL, REMOTE, DIST.', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'PlanHash' => [ - 'description' => 'The internal identifier of the SQL execution plan in the diagnostic system.', - 'type' => 'string', - 'example' => '-86290582****886880', - ], - 'PlanSize' => [ - 'description' => 'Plan size.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10****', - ], - 'SchemaVersion' => [ - 'description' => 'Schema version.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16838****3550464', - ], - 'MergedVersion' => [ - 'description' => 'Merge version.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '513', - ], - 'ObServerId' => [ - 'description' => 'Server ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ObDbId' => [ - 'description' => 'Database ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11006****828', - ], - 'ServerId' => [ - 'description' => 'The ID of the backend server instance.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'FirstLoadTimeUs' => [ - 'description' => 'First loading time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1684****03289441', - ], - 'HitDiagnosis' => [ - 'description' => 'Whether to hit the diagnosis.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'OutlineData' => [ - 'title' => 'Plan的outline_data字段', - 'description' => 'The outline_data parameter of the SQL execution plan.', - 'type' => 'string', - 'example' => '/*+ BEGIN_OUTLINE_DATA INDEX(@\\"SEL$1\\', - ], - 'OutlineId' => [ - 'description' => 'Outline ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CollectTimeUs' => [ - 'description' => 'Collection time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1684368****00000', - ], - 'Server' => [ - 'title' => 'server信息', - 'description' => 'The server where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1a9us038****jio', - ], - 'HitPercentage' => [ - 'description' => 'Hit rate.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'Executions' => [ - 'description' => 'The total number of executions during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecPs' => [ - 'description' => 'The average execution count per second during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], - 'AvgDiskReads' => [ - 'description' => 'The average physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgDiskWrites' => [ - 'description' => 'The average physical write count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBufferGets' => [ - 'description' => 'Average cache read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '30137.03', - ], - 'AvgApplicationWaitTime' => [ - 'description' => 'Average Application event waiting time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgConcurrencyWaitTime' => [ - 'description' => 'Average Concurrency event waiting time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgUserIoWaitTime' => [ - 'description' => 'Average UserIo event waiting time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgRowProcessed' => [ - 'description' => 'Average row processing waiting time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - ], - 'AvgElapsedTime' => [ - 'description' => 'Average interval waiting time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1876.78', - ], - 'AvgCpuTime' => [ - 'description' => 'Average CPU time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1875.34', - ], - 'LargeQueryPercentage' => [ - 'description' => 'Percentage of completed long-running queries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'DelayedLargeQueryPercentage' => [ - 'description' => 'Percentage of delayed long-running queries.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'TimeoutPercentage' => [ - 'description' => 'Percentage of timeouts.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'TableScan' => [ - 'description' => 'Whether a full table scan is performed.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PlanUnionHash' => [ - 'description' => 'The internal unique identifier of the SQL execution plan in the diagnostic system.', - 'type' => 'string', - 'example' => '"52c7c53****53e61b3f7586b17****ad"', - ], - 'SqlId' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'example' => '46939C87ECA****95ED0FF64F44B****', - ], - 'SqlText' => [ - 'type' => 'string', - ], + 'Executions' => ['description' => 'Number of SQL executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RpcCount' => ['title' => 'RPC count during the period', 'description' => 'Total number of SQL RPC calls.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'RemotePlans' => ['description' => 'Number of remote SQL executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MissPlans' => ['description' => 'Number of times the SQL plan cache was missed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'MaxElapsedTime' => ['title' => 'Maximum response time during the period', 'description' => 'Maximum SQL response time.', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'TotalWaitTime' => ['title' => 'Total wait time during the period', 'description' => 'Total wait time in milliseconds during SQL execution. This corresponds to v$sql\\_audit.total\\_wait\\_time\\_micro (in milliseconds).', 'type' => 'number', 'format' => 'double', 'example' => '100000'], + 'ExecPs' => ['title' => 'Average executions per second during the period', 'description' => 'SQL execution frequency.', 'type' => 'number', 'format' => 'double', 'example' => '0.31'], + 'MaxCpuTime' => ['title' => 'Maximum CPU time', 'description' => 'Maximum CPU time.', 'type' => 'number', 'format' => 'double', 'example' => '13641.9'], + 'CpuPercentage' => ['title' => 'CPU usage percentage', 'description' => 'CPU usage percentage.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'ClientIp' => ['title' => 'Client IP.', 'description' => 'Client IP address.', 'type' => 'string', 'example' => '127.*.*.*'], + 'UserName' => ['title' => 'Username', 'description' => 'Username.', 'type' => 'string', 'example' => 'test_user'], + 'DbName' => ['title' => 'Database Name', 'description' => 'Database name.', 'type' => 'string', 'example' => 'test'], + 'RetCode4012Count' => ['description' => 'Number of occurrences of error code 4012.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode4013Count' => ['description' => 'Number of occurrences of error code 4013.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5001Count' => ['description' => 'Number of occurrences of error code 5001.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5024Count' => ['description' => 'Number of occurrences of error code 5024.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5167Count' => ['description' => 'Number of occurrences of error code 5167.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode5217Count' => ['description' => 'Number of occurrences of error code 5217.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RetCode6002Count' => ['description' => 'Number of occurrences of error code 6002.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'FailPercentage' => ['title' => 'Error percentage during the period', 'description' => 'SQL execution error rate.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'SumWaitTime' => ['title' => 'Total wait time (ms) during the period', 'description' => 'Total wait time in milliseconds during the period. (waitTime, corresponding to v$sql\\_audit.wait\\_time\\_micro)', 'type' => 'number', 'format' => 'double', 'example' => '9421.73'], + 'AvgWaitCount' => ['title' => 'Average number of waits during the period', 'description' => 'Average number of waits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgRpcCount' => ['title' => 'Average number of RPC sends during the period', 'description' => 'Average number of SQL RPC calls.', 'type' => 'number', 'format' => 'double', 'example' => '8'], + 'LocalPlanPercentage' => ['title' => 'Percentage of local execution plans during the period', 'description' => 'Percentage of SQL local plans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RemotePlanPercentage' => ['title' => 'Remote Plan Percentage during the period ', 'description' => 'Percentage of SQL remote plans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DistPlanPercentage' => ['title' => 'Percentage of distributed plans during the period ', 'description' => 'Percentage of SQL distributed plans.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SumElapsedTime' => ['title' => 'Total response time during the period (in milliseconds)', 'description' => 'Total SQL response time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '11452126.36'], + 'AvgNetTime' => ['title' => 'Average Network Transmission Time (ms) during the period ', 'description' => 'Average SQL network I/O time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExecutorRpcCount' => ['title' => 'Average number of executor RPC requests during the period', 'description' => 'Number of remote SQL executions. This corresponds to v$sl\\_audit.executor\\_rpc.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MissPlanPercentage' => ['title' => 'Plan hit rate during the period', 'description' => 'Percentage of SQL plan cache misses.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'TableScanPercentage' => ['title' => 'Table scan percentage during the period', 'description' => 'Percentage of full table scans.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'StrongConsistencyPercentage' => ['title' => 'Percentage of strong consistency transactions during the period', 'description' => 'Percentage of strong reads.', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'WeakConsistencyPercentage' => ['title' => 'Percentage of weak consistency transactions during the period', 'description' => 'Percentage of weak reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxAffectedRows' => ['title' => 'Maximum number of affected rows during the period', 'description' => 'Maximum number of affected rows.', 'type' => 'number', 'format' => 'double', 'example' => '10000'], + 'MaxReturnRows' => ['title' => 'Maximum number of returned rows during the period', 'description' => 'Maximum number of returned rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxWaitTime' => ['title' => 'Maximum wait time during the period (in milliseconds)', 'description' => 'Maximum wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '3.4'], + 'MaxApplicationWaitTime' => ['title' => 'Maximum management event wait time during the period (in milliseconds)', 'description' => 'Maximum application wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxConcurrencyWaitTime' => ['title' => 'Maximum wait time for Concurrency events during the period (in milliseconds)', 'description' => 'Maximum concurrency wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxUserIoWaitTime' => ['title' => 'Maximum UserIO event wait time during the period (in milliseconds)', 'description' => 'Maximum I/O wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'MaxDiskReads' => ['title' => 'Maximum number of physical reads during the period ', 'description' => 'Maximum number of disk reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExpectedWorkerCount' => ['title' => 'Average degree of parallelism during the period ', 'description' => 'Expected concurrency.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'AvgUsedWorkerCount' => ['title' => 'Average number of threads used by SQL during the period', 'description' => 'Average number of threads used by SQL during the period.', 'type' => 'number', 'format' => 'double', 'example' => '3'], + 'SumLogicalReads' => ['title' => 'Total SQL logical reads during the period', 'description' => 'Total logical reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'Server' => ['title' => 'Server where the SQL was executed', 'description' => 'OBServer', 'type' => 'string', 'example' => 'i-bp1db1****8uemejio'], + 'ServerIp' => ['title' => 'IP address of the server where the SQL was executed', 'description' => 'OBServer IP', 'type' => 'string', 'example' => 'i-bp1db1****8uemejio'], + 'ServerPort' => ['title' => 'Port of the server where the SQL is executed', 'description' => 'OBServer port.', 'type' => 'integer', 'format' => 'int64', 'example' => '389'], + 'SqlTextShort' => ['title' => 'SQL text (first 100 characters) ', 'description' => 'SQL text (first 100 characters).', 'type' => 'string', 'example' => 'delete /*+ XXX PARALLEL(4) */ fro'], + 'SqlType' => ['title' => 'SQL Type', 'description' => 'SQL type.', 'type' => 'string', 'example' => 'select'], + 'SqlId' => ['title' => 'SQL ID ', 'description' => 'SQL ID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'Inner' => ['title' => 'Is Internal SQL', 'description' => 'Indicates whether the SQL is internal.', 'type' => 'boolean', 'example' => 'false'], + 'WaitEvent' => ['title' => 'Longest wait event during the period', 'description' => 'Longest wait event.', 'type' => 'string', 'example' => 'none'], + 'AvgAffectedRows' => ['title' => 'Average number of updated rows during the period ', 'description' => 'Average number of affected rows.', 'type' => 'number', 'format' => 'double', 'example' => '9978.75'], + 'AvgReturnRows' => ['title' => 'Average number of rows returned during the period', 'description' => 'Average number of returned rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgPartitionCount' => ['title' => 'Average number of partitions accessed during the period', 'description' => 'Average number of partitions accessed.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'FailCount' => ['description' => 'Number of execution errors.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AvgWaitTime' => ['title' => 'Average wait time during the period (ms)', 'description' => 'Average wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1442.49'], + 'AvgElapsedTime' => ['title' => 'Average response time (ms) during the period', 'description' => 'Average response time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '903.29'], + 'AvgCpuTime' => ['title' => 'Average CPU time (ms) during the period', 'description' => 'Average CPU time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1875.34'], + 'AvgNetWaitTime' => ['title' => 'Average network enqueue time during the period (milliseconds) ', 'description' => 'Average network time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgQueueTime' => ['title' => 'Average queue time (ms) during the period', 'description' => 'Average queue time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.01'], + 'AvgDecodeTime' => ['title' => 'Average syntax parse time during the period (ms)', 'description' => 'Average parsing time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgGetPlanTime' => ['title' => 'Average execution plan generation time during the period (in milliseconds)', 'description' => 'Average time to get the execution plan in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgExecuteTime' => ['title' => 'Average plan execution time during the period (in milliseconds)', 'description' => 'Average SQL execution time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '1895.7'], + 'AvgApplicationWaitTime' => ['title' => 'Average management event wait time for Application during the period (ms) ', 'description' => 'Average application wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgConcurrencyWaitTime' => ['title' => 'Average management event wait time for concurrency during the period (ms)', 'description' => 'Average concurrency wait time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgUserIoWaitTime' => ['title' => 'Average User I/O event wait time during the period (in milliseconds)', 'description' => 'Average user I/O time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgScheduleTime' => ['title' => 'Average wait time for Schedule events during the period (in milliseconds)', 'description' => 'Average scheduling time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgRowCacheHit' => ['title' => 'Average Row Cache hit count during the period', 'description' => 'Average number of Row Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBloomFilterCacheHit' => ['title' => 'Average number of Bloom Filter Cache hits during the period', 'description' => 'Average number of Bloom Filter Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBlockCacheHit' => ['title' => 'Average Block Cache hit count during the period', 'description' => 'Average number of Block Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgBlockIndexCacheHit' => ['title' => 'Average number of Block Index Cache hits during the period', 'description' => 'Average number of Block Index Cache hits.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgDiskReads' => ['title' => 'Average number of physical reads during the period', 'description' => 'Average number of disk reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RetryCount' => ['description' => 'Number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AvgMemstoreReadRows' => ['title' => 'Percentage of strong consistency transactions during the period', 'description' => 'Average number of Memstore read rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgSsstoreReadRows' => ['title' => 'Percentage of weak consistency transactions during the period', 'description' => 'Average number of SSTable read rows.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgLogicalReads' => ['title' => 'Average logical reads of the SQL during the period', 'description' => 'Average logical reads.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AvgDbTime' => ['description' => 'Average database time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['description' => 'Total database time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'MergedVersion' => [ - 'description' => 'Merge version.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '513', - ], - 'FirstLoadTime' => [ - 'title' => '首次加载时间', - 'description' => 'First loading time.', - 'type' => 'string', - 'example' => '2023-04-12T04:46:38Z', - ], - 'PlanType' => [ - 'title' => '执行计划类型', - 'description' => 'Execution plan type.', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'HitDiagnosis' => [ - 'description' => 'Whether to hit the diagnosis.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HitPercentage' => [ - 'description' => 'Hit rate.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'AvgCpuTime' => [ - 'description' => 'Average CPU time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1875.34', - ], - 'PlanExplain' => [ - 'title' => '执行计划', - 'description' => 'Execution plan.', + 'LastFailCode' => ['title' => 'Error code from the last failed execution during the period ', 'description' => 'Error code from the last failed execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '-4012'], + 'AvgDbTime' => ['description' => 'Average database time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SumDbTime' => ['description' => 'Total database time in milliseconds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'CustomColumns' => [ + 'description' => 'Custom columns.', + 'title' => 'Custom columns', 'type' => 'object', 'properties' => [ - 'PlanJsonString' => [ - 'description' => 'JSON string of the SQL execution plan.', - 'type' => 'string', - 'example' => '{\\"RootOperations\\":[{\\"Children\\', - ], + 'Expression' => ['title' => 'Expression for the custom column', 'description' => 'Expression for the custom column.', 'type' => 'string', 'example' => '@failCount/@executions'], + 'Value' => ['title' => 'Value computed based on the expression', 'description' => 'Value calculated from the expression.', 'type' => 'string', 'example' => '0.0'], ], + 'example' => '', ], - 'Executions' => [ - 'description' => 'Execution count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PlanUnionHash' => [ - 'description' => 'The internal unique identifier of the SQL execution plan in the diagnostic system.', - 'type' => 'string', - 'example' => '"52c7c53****53e61b3f7586b17****ad"', - ], - 'QuerySql' => [ - 'description' => 'The SQL for the query.', - 'type' => 'string', - 'example' => '"select 1 from t"', - ], - 'Bounded' => [ - 'description' => 'Whether to bind the execution plan.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'TableScan' => [ - 'title' => '该计划是否包含全表扫描', - 'description' => 'Indicates whether full table scan is performed.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'OutlineId' => [ - 'title' => '该计划使用的 outline id', - 'description' => 'The ID of the outline used by the execution plan.', - 'type' => 'string', - 'example' => '3********', - ], - 'OutlineStatus' => [ - 'title' => '该计划使用outline时的状态，“已生效” 表示该计划的 outline_data 与 outline的 outlIne_content 能完全匹配上，“未知” 表示，无法判断状态。', - 'description' => 'The outline status of the execution plan. Valid values:'."\n" - .'* **Effective**: indicates that the outline_data and outlIne_content fields exactly match with each other. '."\n" - .'* **Unknown**: indicates that the outline status is unknown.', - 'type' => 'string', - 'example' => 'Effective', - ], - 'ByFormatSqlId' => [ - 'title' => '是否为模糊绑定', - 'type' => 'boolean', - ], + 'ObDbId' => ['description' => 'Database ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11006111****4828', 'title' => ''], + 'FormatSqlId' => ['title' => 'FormatSqlId ', 'description' => 'FormatSqlId', 'type' => 'string', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"PlanHash\\": \\"1758****24913166****\\",\\n \\"Plans\\": [\\n {\\n \\"Uid\\": \\"AAAAAAAAAAI****AAFoT2QAF--7W****\\",\\n \\"PlanId\\": 0,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"PlanSize\\": 0,\\n \\"SchemaVersion\\": 0,\\n \\"MergedVersion\\": 513,\\n \\"ObServerId\\": 2,\\n \\"ObDbId\\": 0,\\n \\"ServerId\\": 2,\\n \\"FirstLoadTimeUs\\": 0,\\n \\"HitDiagnosis\\": false,\\n \\"OutlineData\\": \\"/*+ BEGIN_OUTLINE_DATA INDEX(@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\",\\n \\"OutlineId\\": -1,\\n \\"CollectTimeUs\\": 0,\\n \\"Server\\": \\"i-bp1db1a9us038****jio\\",\\n \\"HitPercentage\\": 100,\\n \\"Executions\\": 1,\\n \\"ExecPs\\": 0.31,\\n \\"AvgDiskReads\\": 0,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgBufferGets\\": 30137.03,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgRowProcessed\\": 1,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"LargeQueryPercentage\\": 0,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TimeoutPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"SqlId\\": \\"46939C87ECA****95ED0FF64F44B****\\",\\n \\"SqlText\\": \\"\\"\\n }\\n ],\\n \\"MergedVersion\\": 513,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"HitDiagnosis\\": false,\\n \\"HitPercentage\\": 100,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"PlanExplain\\": {\\n \\"PlanJsonString\\": \\"\\\\\\"PlanJsonString\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"RootOperations\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TR\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":86},{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2013,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SORT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4024,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_MERGE_JOIN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":26}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4025,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SCALAR_AGGREGATE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":1}]}\\\\\\"\\"\\n },\\n \\"Executions\\": 1,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"QuerySql\\": \\"\\\\\\"select 1 from t\\\\\\"\\",\\n \\"Bounded\\": false,\\n \\"TableScan\\": false,\\n \\"OutlineId\\": \\"3********\\",\\n \\"OutlineStatus\\": \\"已生效\\",\\n \\"ByFormatSqlId\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeOasSQLPlans', - ], - 'DescribeSQLSamples' => [ - 'summary' => 'You can call this API to view the sample data of the execution details of the slow queries.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"i-bp1db****38uemejio\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 0,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"LastFailCode\\": -4012,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"CustomColumns\\": {\\n \\"Expression\\": \\"@failCount/@executions\\",\\n \\"Value\\": \\"0.0\\"\\n },\\n \\"ObDbId\\": 0,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query TopSQL List', + 'changeSet' => [ + ['createdAt' => '2025-09-23T12:29:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-08T12:08:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-22T14:06:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:37:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasTopSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeOutlineBinding' => [ + 'summary' => 'Queries the bound Outline or throttling information for a SQL statement by its SQL ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], ], [ - 'name' => 'TenantId', + 'name' => 'TableName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID.', - 'type' => 'string', - 'required' => false, - 'example' => 't4louaeei****', - ], + 'schema' => ['title' => 'The name of the tenant. It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to SYS. ', 'description' => 'The tenant name. Note: Although this parameter is named TableName, it specifies the tenant name. The name must be 2–20 characters long, consist of letters, digits, and underscores (\\_), be case-sensitive, start with a letter or an underscore, and not be the reserved word sys.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_online'], ], [ - 'name' => 'StartTime', + 'name' => 'DatabaseName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying the slow query execution.'."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['title' => 'The name of the database.', 'description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb'], ], [ - 'name' => 'EndTime', + 'name' => 'SQLId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying the slow query execution.'."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['title' => 'SQLID', 'description' => 'The SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], ], [ - 'name' => 'DbName', + 'name' => 'IsConcurrentLimit', 'in' => 'formData', - 'schema' => [ - 'description' => 'The database name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_db', - ], + 'schema' => ['title' => 'When the value is True, the throttling information in the database is queried based on the SQL ID.', 'description' => '- Set to `true` to query the throttling information.'."\n" + ."\n" + .'- Set to `false` to query the bound index or bound execution plan.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'SqlId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The OceanBase instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'ReturnSqlText', + 'name' => 'DynamicSql', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to return the SQL text.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'schema' => ['title' => 'Is Template SQL ', 'description' => 'Indicates whether the SQL is a template SQL.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => ['title' => 'Formatted SQL ID ', 'description' => 'The ID of the formatted SQL statement.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'OutlineBinding' => [ + 'title' => 'The binding information.', + 'description' => 'Details of the Outline binding.', + 'type' => 'object', + 'properties' => [ + 'BindPlan' => ['title' => 'The bound plan.', 'description' => 'The bound execution plan.', 'type' => 'string', 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******'], + 'OutlineId' => ['title' => 'OutlineID', 'description' => 'The Outline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'BindIndex' => ['title' => 'The bound index.', 'description' => 'The bound index.', 'type' => 'string', 'example' => 'PRIMARY'], + 'MaxConcurrent' => ['title' => 'The maximum number of concurrent tasks.', 'description' => 'The maximum number of concurrent executions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TableName' => ['title' => '表名称', 'description' => 'The table name.', 'type' => 'string', 'example' => 'cluster_info'], + 'SqlText' => ['title' => 'Rate-Limited Text', 'description' => 'The SQL text used for throttling.', 'type' => 'string', 'example' => ''], + 'SqlTextConcurrentNum' => ['title' => 'Rate-Limiting Numeric Value', 'description' => 'The concurrency limit for the SQL text.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'ByFormatSqlId' => ['title' => 'Is Blur Binding', 'description' => 'Indicates whether the binding is a fuzzy binding.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutlineBinding\\": {\\n \\"BindPlan\\": \\"PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\",\\n \\"OutlineId\\": -1,\\n \\"BindIndex\\": \\"PRIMARY\\",\\n \\"MaxConcurrent\\": 2,\\n \\"TableName\\": \\"cluster_info\\",\\n \\"SqlText\\": \\"\\",\\n \\"SqlTextConcurrentNum\\": 0,\\n \\"ByFormatSqlId\\": false\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Query Outline Binding Information ', + 'changeSet' => [ + ['createdAt' => '2025-09-23T12:29:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-22T14:06:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-17T02:26:43.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOutlineBinding', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'DescribeParameters' => [ + 'summary' => 'Queries the list of parameter information.', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The parameter type.'."\n" + .'Valid values: CLUSTER and TENANT.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TENANT'], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The resource identifier of the parameter type. '."\n" + .'You can leave this parameter empty for cluster parameters. For tenant parameters, specify the TenantId of the tenant.', 'type' => 'string', 'required' => false, 'example' => 'ob2mr3oae0****'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'Returned response.', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Parameters' => [ 'title' => '', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The list of sample data of slow query execution details.', + 'description' => 'The parameter list.', 'type' => 'array', 'items' => [ - 'description' => 'The list of sample data of slow query execution details.', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'Request ID.', - 'type' => 'integer', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - 'format' => 'int64', - ], - 'TraceId' => [ - 'title' => 'TraceId', - 'description' => 'Trace ID.', - 'type' => 'string', - 'example' => 'YB42C****-0005E303D1****-0-0', - ], - 'RequestTime' => [ - 'title' => 'SQL的请求时间', - 'description' => 'SQL request time.', - 'type' => 'string', - 'example' => '2023-04-12T04:46:38Z', - ], - 'Server' => [ - 'title' => 'String SQL执行所在的Server（svr_ip:svr_port）', - 'description' => 'The server where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1****8uemejio', - ], - 'ClientIp' => [ - 'title' => '客户端Ip', - 'description' => 'Client IP.', - 'type' => 'string', - 'example' => 'i-bp1db****38uemejio', - ], - 'ClientPort' => [ - 'title' => '', - 'description' => 'Client port.', - 'type' => 'integer', - 'example' => '4****', - 'format' => 'int32', - ], - 'DbName' => [ - 'title' => 'SQL访问的数据库', - 'description' => 'Database name.', - 'type' => 'string', - 'example' => 'test_db', - ], - 'UserName' => [ - 'title' => 'SQL的用户', - 'description' => 'Username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'SqlType' => [ - 'title' => 'SQL的类型', - 'description' => 'SQL type.', - 'type' => 'string', - 'example' => 'select', - ], - 'PlanId' => [ - 'title' => '', - 'description' => 'The execution plan ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '590****', - ], - 'AffectedRows' => [ - 'title' => '', - 'description' => 'Average updated rows during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000.0', - ], - 'ReturnRows' => [ - 'title' => '', - 'description' => 'Average returned rows during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.0', - ], - 'PartitionCount' => [ - 'title' => '', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1.0', - ], - 'RetCode' => [ - 'title' => '', - 'description' => 'Result code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WaitEvent' => [ - 'title' => '期间内的最长等待事件', - 'description' => 'Longest wait event during the execution period.', - 'type' => 'string', - 'example' => 'none', - ], - 'WaitTime' => [ - 'title' => '等待时间（毫秒)', - 'description' => 'Wait time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'WaitCount' => [ - 'title' => '', - 'description' => 'Wait count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.0', - ], - 'RpcCount' => [ - 'title' => '', - 'description' => 'Number of RPC sent.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8.0', - ], - 'PlanType' => [ - 'title' => '计划类型', - 'description' => 'Plan type.', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'Inner' => [ - 'title' => '是否内部SQL', - 'description' => 'Whether an internal SQL.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ExecutorRpc' => [ - 'description' => 'Whether to initiate RPC.', - 'type' => 'boolean', - 'example' => '0.0', - 'title' => '', - ], - 'HitPlan' => [ - 'description' => 'Whether to hit the execution plan.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'ElapsedTime' => [ - 'title' => '响应时间（毫秒）', - 'description' => 'Response time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '2182.66', - ], - 'CpuTime' => [ - 'title' => 'CPU时间（毫秒）', - 'description' => 'CPU time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '3377.57', - ], - 'NetTime' => [ - 'title' => '网络传输时间（毫秒）', - 'description' => 'Network transmission time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'NetWaitTime' => [ - 'title' => '网络入队时间（毫秒）', - 'description' => 'Network enqueue time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'QueueTime' => [ - 'title' => '排队时间（毫秒）', - 'description' => 'Queueing time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.02', - ], - 'DecodeTime' => [ - 'title' => '语法解析时间（毫秒）', - 'description' => 'Syntax parsing time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'GetPlanTime' => [ - 'title' => '计划生成时间（毫秒）', - 'description' => 'Plan generation time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.19', - ], - 'ExecuteTime' => [ - 'title' => '计划执行时间（毫秒）', - 'description' => 'Plan execution time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '8262.01', - ], - 'ApplicationWaitTime' => [ - 'title' => 'Application事件等待时间（毫秒）', - 'description' => 'Application event waiting time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'ConcurrencyWaitTime' => [ - 'title' => 'Concurrency事件等待时间（毫秒）', - 'description' => 'Concurrency event waiting time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'UserIoWaitTime' => [ - 'title' => 'UserIO事件等待时间（毫秒）', - 'description' => 'UserIO event waiting time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'ScheduleTime' => [ - 'title' => 'Schedule事件等待时间（毫秒）', - 'description' => 'Schedule event waiting time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RowCacheHit' => [ - 'title' => 'RowCache命中次数', - 'description' => 'RowCache hit count.', - 'type' => 'number', - 'format' => 'double', - 'example' => '498.0', - ], - 'BloomFilterCacheHit' => [ - 'title' => 'BloomFilterCache命中次数', - 'description' => 'BloomFilterCache hit count.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'BlockCacheHit' => [ - 'title' => 'BlockCache命中次数', - 'description' => 'BlockCache hit count', - 'type' => 'number', - 'format' => 'double', - 'example' => '99279.0', - ], - 'BlockIndexCacheHit' => [ - 'title' => 'BlockIndexCache命中次数'."\n" - .'磁盘读次数', - 'description' => 'BlockIndexCache hit count', - 'type' => 'number', - 'format' => 'double', - 'example' => '142514.0', - ], - 'DiskReads' => [ - 'title' => '磁盘读次数', - 'description' => 'Disk read count.', - 'type' => 'number', - 'format' => 'double', - 'example' => '96972.0', - ], - 'RetryCount' => [ - 'title' => '', - 'description' => 'Retry count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TableScan' => [ - 'description' => 'Whether to perform full table scan.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'ConsistencyLevel' => [ - 'title' => '一致性级别', - 'description' => 'Consistency level.', - 'type' => 'string', - 'example' => '3', - ], - 'MemstoreReadRows' => [ - 'title' => '', - 'description' => 'Memstore read row count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExpectedWorkerCount' => [ - 'title' => '', - 'description' => 'Degree of parallelism.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'UsedWorkerCount' => [ - 'title' => '', - 'description' => 'Actual number of SQL execution threads.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SsstoreReadRows' => [ - 'title' => '', - 'description' => 'Ssstore read row count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '986190', - ], - 'ObServerId' => [ - 'title' => 'server ID', - 'description' => 'Server ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ObUserId' => [ + 'Description' => ['title' => '', 'description' => 'The description of the parameter.', 'type' => 'string', 'example' => '弱读允许的最大时间延迟时间'], + 'ValueType' => ['title' => '', 'description' => 'The value type of the parameter. Valid values:'."\n" + .'- ENUM: numeric enumeration. '."\n" + .'- RANGE: numeric range. '."\n" + .'- TIME: time. '."\n" + .'- STRING: string.'."\n" + .'- ENUM_MULTIPLE: numeric enumeration with multiple selections.'."\n" + .'- CAPACITY: storage capacity value (K, M, G).', 'type' => 'string', 'example' => 'CAPACITY'], + 'CurrentValue' => ['title' => '', 'description' => 'The current value of the parameter.', 'type' => 'string', 'example' => '600'], + 'NeedReboot' => ['title' => '', 'description' => 'Indicates whether a restart is required after modifying this parameter. Valid values: '."\n" + .'- true: A restart is required. '."\n" + .'- false: A restart is not required.', 'type' => 'boolean', 'example' => 'false'], + 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => 'connect_timeout'], + 'DefaultValue' => ['title' => '', 'description' => 'The default value of the parameter.', 'type' => 'string', 'example' => '600s'], + 'RejectedValue' => [ 'title' => '', - 'description' => 'User ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100010', + 'description' => 'The rejected value range of the parameter.'."\n" + .'The format is an array with two string elements that represent a range. The first element is the minimum value, and the second element is the maximum value.', + 'type' => 'array', + 'items' => ['description' => 'The rejected value range of the parameter.', 'type' => 'string', 'example' => '1s', 'title' => ''], + 'example' => '', ], - 'ObDbId' => [ + 'AcceptableValue' => [ 'title' => '', - 'description' => 'Database ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11006111****4828', - ], - 'Statement' => [ - 'title' => '参数化SQL文本', - 'description' => 'Parameterized SQL text.', - 'type' => 'string', - 'example' => 'select a from b', - ], - 'TransHash' => [ - 'title' => 'transaction hash', - 'description' => 'Transaction hash.', - 'type' => 'string', - 'example' => '1219****927****73791', - ], - 'FullSqlText' => [ - 'description' => 'The full SQL text. '."\n" - ."\n" - .'> This parameter is unavailable.', - 'type' => 'string', - 'example' => 'select * from test where c1 > 1 and c2 > 3;', - ], - 'SqlText' => [ - 'description' => 'The SQL text.', - 'type' => 'string', - 'example' => 'select ** from t', - ], - 'ParamsValue' => [ - 'title' => 'SQL参数值', - 'description' => 'The parameter value of the SQL statement.', - 'type' => 'string', - 'example' => '1****', - ], - 'SqlId' => [ - 'type' => 'string', - ], - 'SqlTextShort' => [ - 'type' => 'string', + 'description' => 'The acceptable value range of the parameter.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The acceptable value range of the parameter.', 'type' => 'string', 'example' => '2s'], + 'example' => '', ], + 'Readonly' => ['title' => '', 'description' => 'Indicates whether the parameter is read-only.', 'type' => 'boolean', 'example' => 'false'], + 'Unit' => ['title' => '', 'description' => 'The unit of the current parameter value.', 'type' => 'string', 'example' => 's'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"RequestId\\": 0,\\n \\"TraceId\\": \\"YB42C****-0005E303D1****-0-0\\",\\n \\"RequestTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ClientIp\\": \\"i-bp1db****38uemejio\\",\\n \\"ClientPort\\": 0,\\n \\"DbName\\": \\"test_db\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"SqlType\\": \\"select\\",\\n \\"PlanId\\": 0,\\n \\"AffectedRows\\": 10000,\\n \\"ReturnRows\\": 0,\\n \\"PartitionCount\\": 1,\\n \\"RetCode\\": 0,\\n \\"WaitEvent\\": \\"none\\",\\n \\"WaitTime\\": 0,\\n \\"WaitCount\\": 0,\\n \\"RpcCount\\": 8,\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"Inner\\": false,\\n \\"ExecutorRpc\\": true,\\n \\"HitPlan\\": true,\\n \\"ElapsedTime\\": 2182.66,\\n \\"CpuTime\\": 3377.57,\\n \\"NetTime\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"QueueTime\\": 0.02,\\n \\"DecodeTime\\": 0,\\n \\"GetPlanTime\\": 0.19,\\n \\"ExecuteTime\\": 8262.01,\\n \\"ApplicationWaitTime\\": 0,\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"UserIoWaitTime\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"RowCacheHit\\": 498,\\n \\"BloomFilterCacheHit\\": 0,\\n \\"BlockCacheHit\\": 99279,\\n \\"BlockIndexCacheHit\\": 142514,\\n \\"DiskReads\\": 96972,\\n \\"RetryCount\\": 0,\\n \\"TableScan\\": false,\\n \\"ConsistencyLevel\\": \\"3\\",\\n \\"MemstoreReadRows\\": 0,\\n \\"ExpectedWorkerCount\\": 0,\\n \\"UsedWorkerCount\\": 0,\\n \\"SsstoreReadRows\\": 986190,\\n \\"ObServerId\\": 2,\\n \\"ObUserId\\": 100010,\\n \\"ObDbId\\": 0,\\n \\"Statement\\": \\"select a from b\\",\\n \\"TransHash\\": \\"1219****927****73791\\",\\n \\"FullSqlText\\": \\"select * from test where c1 > 1 and c2 > 3;\\",\\n \\"SqlText\\": \\"select ** from t\\",\\n \\"ParamsValue\\": \\"1****\\",\\n \\"SqlId\\": \\"\\",\\n \\"SqlTextShort\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeSQLSamples', - ], - 'DescribeOasSQLHistoryList' => [ - 'summary' => 'You can call this API to view the SQL execution history.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Parameters\\": [\\n {\\n \\"Description\\": \\"弱读允许的最大时间延迟时间\\",\\n \\"ValueType\\": \\"CAPACITY\\",\\n \\"CurrentValue\\": \\"600\\",\\n \\"NeedReboot\\": false,\\n \\"Name\\": \\"connect_timeout\\",\\n \\"DefaultValue\\": \\"600s\\",\\n \\"RejectedValue\\": [\\n \\"1s\\"\\n ],\\n \\"AcceptableValue\\": [\\n \\"2s\\"\\n ],\\n \\"Readonly\\": false,\\n \\"Unit\\": \\"s\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query parameter information list', + 'changeSet' => [ + ['createdAt' => '2023-08-21T11:36:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-17T02:26:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeParametersHistory' => [ + 'summary' => 'You can call this operation to query the modification history of cluster or tenant parameters. ', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying the execution history of the SQL statement. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'EndTime', + 'name' => 'Dimension', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying the execution history of the SQL statement. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], + 'schema' => ['title' => '', 'description' => 'The type of the parameter. '."\n" + .'Valid values: CLUSTER and TENANT. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TENANT'], ], [ - 'name' => 'DbName', + 'name' => 'DimensionValue', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], + 'schema' => ['title' => '', 'description' => 'The resource ID of the parameter type. '."\n" + .'You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID. ', 'type' => 'string', 'required' => false, 'example' => 't4qx8****'], ], [ - 'name' => 'SqlId', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['title' => '', 'description' => 'The start time of querying the slow query execution.'."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13 15:40:43'], ], [ - 'name' => 'NodeIp', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp19y05uq6x*********', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the time range for querying the SQL execution history. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13 15:40:43'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['title' => '', 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999', 'minimum' => '1', 'example' => '10'], ], [ - 'name' => 'DynamicSql', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'description' => 'Specifies whether the SQL statement is a dynamic SQL statement.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'Returned response.', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Respond' => [ + 'description' => 'The list of parameter modification records.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total count, which takes effect in a pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'PageNumber' => ['description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Parameters' => [ + 'description' => 'The information about parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about parameters.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '', 'description' => 'The modification status of the parameter. Valid values: '."\n" + .'* APPLIED: The parameter was modified.'."\n" + .'* SCHEDULING: The parameter was to be modified.', 'type' => 'string', 'example' => 'APPLIED'], + 'OldValue' => ['title' => '', 'description' => 'The value of the parameter before the modification.', 'type' => 'string', 'example' => '10'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the parameter modification took effect.', 'type' => 'string', 'example' => '2024-11-26T08:03:34Z'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the parameter modification was initiated.', 'type' => 'string', 'example' => '2024-11-26T08:03:34Z'], + 'DimensionValue' => ['title' => '', 'description' => 'The resource ID of the parameter type. When you called this operation to query the modification history of cluster parameters, the value is DEFAULT_DIMENSION_VALUE. When you called this operation to query the modification history of tenant parameters, the value is the tenant ID.', 'type' => 'string', 'example' => 't69uo********'], + 'Name' => ['title' => '', 'description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'connect_timeout'], + 'NewValue' => ['title' => '', 'description' => 'The value of the parameter after the modification.', 'type' => 'string', 'example' => '30'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The list of SQL execution history.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the execution history.', - 'type' => 'object', - 'properties' => [ - 'SQLId' => [ - 'title' => 'SQL ID', - 'description' => 'SQL ID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'test_db', - ], - 'AvgAffectedRows' => [ - 'title' => '', - 'description' => 'Average updated rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9978.75', - ], - 'AvgBlockCacheHit' => [ - 'title' => '', - 'description' => 'Average BlockCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBlockIndexCacheHit' => [ - 'title' => '', - 'description' => 'Average BlockIndexCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBloomFilterCacheHit' => [ - 'title' => '', - 'description' => 'Average BloomFilterCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Executions' => [ - 'title' => '期间内的总执行次数', - 'description' => 'Total number of executions during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FailCount' => [ - 'title' => '期间内的总错误次数', - 'description' => 'The total number of errors during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgRpcCount' => [ - 'title' => '', - 'description' => 'Average number of RPC sent during the execution.', - 'type' => 'number', - 'format' => 'double', - 'example' => '8.0', - ], - 'RemotePlans' => [ - 'title' => '远程计划数', - 'description' => 'Remote plan count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MissPlans' => [ - 'title' => '未命中计划次数', - 'description' => 'Missed plan count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgReturnRows' => [ - 'title' => '', - 'description' => 'Average number of rows returned during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgLogicalReads' => [ - 'title' => '', - 'description' => 'Average logical reads during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RetryCount' => [ - 'title' => '期间内的总计重试次数', - 'description' => 'Total number of retries during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgRowCacheHit' => [ - 'title' => '', - 'description' => 'Average RowCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgDiskReads' => [ - 'title' => '', - 'description' => 'Average physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgMemstoreReadRows' => [ - 'title' => '', - 'description' => 'Average Memstore read rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgSsstoreReadRows' => [ - 'title' => '', - 'description' => 'Average Ssstore read rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgApplicationWaitTime' => [ - 'title' => '客户端等待 期间内的平均Application事件等待时间（毫秒）', - 'description' => 'Average Application event wait time (in milliseconds) during the client waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgElapsedTime' => [ - 'title' => '期间内的平均响应时间（毫秒）', - 'description' => 'Average response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1876.78', - ], - 'AvgExecuteTime' => [ - 'title' => '期间内的平均计划执行时间（毫秒）', - 'description' => 'Average plan execution time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1895.7', - ], - 'AvgQueueTime' => [ - 'title' => '期间内的平均排队时间（毫秒）', - 'description' => 'Average queueing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.01', - ], - 'AvgConcurrencyWaitTime' => [ - 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', - 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgCpuTime' => [ - 'title' => '期间内的平均CPU时间（毫秒）', - 'description' => 'Average CPU time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1875.34', - ], - 'AvgDecodeTime' => [ - 'title' => '期间内的平均语法解析时间（毫秒）', - 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgNetWaitTime' => [ - 'title' => '网络等待 期间内的平均网络入队时间（毫秒）', - 'description' => 'Average network enqueue time (in milliseconds) during the network waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgUserIoWaitTime' => [ - 'title' => '期间内的平均UserIO事件等待时间（毫秒）', - 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgGetPlanTime' => [ - 'title' => '期间内的平均计划生成时间（毫秒）', - 'description' => 'Average plan generation time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxElapsedTime' => [ - 'title' => '最大响应时间', - 'description' => 'Max response time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '13643.3', - ], - 'SumWaitTime' => [ - 'title' => '内部等待 期间内的总等待时间（毫秒）', - 'description' => 'The total wait time (in milliseconds) during the internal waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9421.73', - ], - 'AvgScheduleTime' => [ - 'title' => '调度时间 期间内的平均Schedule事件等待时间（毫秒）', - 'description' => 'Average Schedule event wait time (in milliseconds) during the scheduling period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxCpuTime' => [ - 'title' => '最大 CPU 时间', - 'description' => 'Max CPU time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '13641.9', - ], - 'SumElapsedTime' => [ - 'description' => 'Total response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '11452126.36', - ], - 'Timestamp' => [ - 'title' => '采样时间点', - 'description' => 'Timestamp for the sample.', - 'type' => 'string', - 'example' => '2023-04-12T04:46:38Z', - ], - 'Server' => [ - 'title' => 'SQL执行所在的Server（svr_ip:svr_port, 兼容tars', - 'description' => 'The server where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1****8uemejio', - ], - 'UserName' => [ - 'title' => 'userName, 兼容tars', - 'description' => 'Username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'AvgPartitionCount' => [ - 'title' => '期间内平均访问分区数', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'FailPercentage' => [ - 'title' => '期间内的错误百分比', - 'description' => 'Error percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RetCode4012Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 4012 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode4013Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 4013 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5001Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5001 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5024Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5024 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5167Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5167 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5217Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5217 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode6002Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 6002 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgWaitTime' => [ - 'title' => '期间内的平均等待时间（毫秒）', - 'description' => 'Average wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1442.49', - ], - 'AvgWaitCount' => [ - 'title' => '期间内的平均等待次数', - 'description' => 'Average number of waits during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'LocalPlanPercentage' => [ - 'title' => '期间内的本地计划百分比', - 'description' => 'Local plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemotePlanPercentage' => [ - 'title' => '期间内的远程计划百分比', - 'description' => 'Remote plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DistPlanPercentage' => [ - 'title' => '期间内的分布式计划百分比', - 'description' => 'Distributed plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'AvgNetTime' => [ - 'title' => '期间内的平均网络传输时间（毫秒）', - 'description' => 'Average network transmission time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '8', - ], - 'AvgExecutorRpcCount' => [ - 'title' => '期间内的平均执行RPC请求次数', - 'description' => 'Average number of RPC requests executed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MissPlanPercentage' => [ - 'title' => '期间内的计划命中率', - 'description' => 'Plan hit rage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'TableScanPercentage' => [ - 'title' => '期间内的表扫描百分比', - 'description' => 'Table scan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'StrongConsistencyPercentage' => [ - 'title' => '期间内的强一致性事务百分比', - 'description' => 'Strong consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'WeakConsistencyPercentage' => [ - 'title' => '期间内的弱一致性事务百分比', - 'description' => 'Eventually consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MaxAffectedRows' => [ - 'title' => '期间内最大更新行数', - 'description' => 'Max updated rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '10000', - ], - 'MaxReturnRows' => [ - 'title' => '期间内最大返回行数', - 'description' => 'Max returned rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'title' => '期间内的最大等待时间（毫秒）', - 'description' => 'Max wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3.4', - ], - 'MaxApplicationWaitTime' => [ - 'title' => '期间内的最大Application事件等待时间（毫秒）', - 'description' => 'Max Application event wait time (in milliseconds) during the execution period', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MaxConcurrencyWaitTime' => [ - 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', - 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MaxUserIoWaitTime' => [ - 'title' => '期间内的最大UserIO事件等待时间（毫秒）', - 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MaxDiskReads' => [ - 'title' => '期间内的最大物理读次数', - 'description' => 'Max physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AvgExpectedWorkerCount' => [ - 'title' => '期间内平均并行度', - 'description' => 'Average degree of parallelism during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'AvgUsedWorkerCount' => [ - 'title' => '期间内sql平均使用线程数', - 'description' => 'Average number of threads used of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'SumLogicalReads' => [ - 'title' => '总逻辑读', - 'description' => 'Total logical reads.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'ExecPs' => [ - 'description' => 'Average execution count per second during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], - 'AvgDbTime' => [ - 'description' => 'The average DB time, in milliseconds.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SumDbTime' => [ - 'description' => 'The total DB time, in milliseconds.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'WaitEvent' => [ - 'description' => 'The wait event.', - 'type' => 'string', - 'example' => 'none', - ], - ], - ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"Executions\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"RetryCount\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"MaxElapsedTime\\": 13643.3,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgScheduleTime\\": 0,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"Timestamp\\": \\"2023-04-12T04:46:38Z\\",\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"AvgPartitionCount\\": 1,\\n \\"FailPercentage\\": 0,\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgWaitCount\\": 0,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"AvgNetTime\\": 8,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"ExecPs\\": 0.31,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"WaitEvent\\": \\"none\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeOasSQLHistoryList', - ], - 'DescribeOasTopSQLList' => [ - 'summary' => 'You can call this API to retrieve the list of data on the SQL execution performance collected by the diagnostic system.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Respond\\": {\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"Parameters\\": [\\n {\\n \\"Status\\": \\"APPLIED\\",\\n \\"OldValue\\": \\"10\\",\\n \\"UpdateTime\\": \\"2024-11-26T08:03:34Z\\",\\n \\"CreateTime\\": \\"2024-11-26T08:03:34Z\\",\\n \\"DimensionValue\\": \\"t69uo********\\",\\n \\"Name\\": \\"connect_timeout\\",\\n \\"NewValue\\": \\"30\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 2\\n \\n APPLIED\\n 300\\n 2021-09-14 10:57:44\\n 2021-09-14 10:57:44\\n DEFAULT_DIMENSION_VALUE\\n connect_timeout\\n 200\\n \\n \\n","errorExample":""}]', + 'title' => ' DescribeParametersHistory', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeParametersHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeProcessStatsComposition' => [ + 'summary' => 'DescribeProcessStatsComposition', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying the TOPSQL parameter. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying the TOPSQL parameter.'."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', - ], - ], - [ - 'name' => 'SearchParam', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', - ], - ], - [ - 'name' => 'SearchRule', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search rule. ', - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob********'], ], [ - 'name' => 'SearchValue', + 'name' => 'UId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The search value. ', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', - ], + 'schema' => ['title' => '', 'description' => 'The user identifier (UID) of the OceanBase database.', 'type' => 'string', 'required' => false, 'example' => '139*************'], ], [ - 'name' => 'SqlId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID.'."\n" - .'> When the SQL ID is provided, the system collects all the request data for the target SQL ID. When the SQL ID is empty, the system collects all the request data for the entire database instance.', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => false, 'example' => 't********'], ], [ - 'name' => 'NodeIp', + 'name' => 'SqlText', 'in' => 'formData', - 'schema' => [ - 'description' => 'The node IP.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp18l4****str4uk03', - ], + 'schema' => ['title' => '', 'description' => 'The SQL statement, which can contain LIKE clauses. You can specify only part of the clauses in the SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC'], ], [ - 'name' => 'FilterCondition', + 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', - 'type' => 'string', - 'required' => false, - 'example' => '@avgCpuTime > 20 and @executions > 100', - ], + 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '127.*.*.*', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ServerIp', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the response. Valid values:'."\n" - ."\n" - .'- zh: Chinese'."\n" - .'- en: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'The IP address of the server.', 'type' => 'string', 'required' => false, 'example' => '127.*.*.*', 'title' => ''], ], [ - 'name' => 'SqlTextLength', + 'name' => 'Users', 'in' => 'formData', - 'schema' => [ - 'description' => 'Max length of the returned SQL text.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '65535', - ], + 'schema' => ['description' => 'The username of the database.', 'type' => 'string', 'required' => false, 'example' => '["test_user"]', 'title' => ''], ], [ - 'name' => 'DynamicSql', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The status of the session.', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE', 'title' => ''], ], [ 'name' => 'MergeDynamicSql', 'in' => 'formData', - 'schema' => [ - 'title' => '返回结果时，是否合并动态 SQL', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'CustomColumns', - 'in' => 'formData', - 'schema' => [ - 'title' => '自定义字段规则', - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to merge dynamic SQL in the return result. '."\n" + .'>
Indicates whether to aggregate the results of IN queries in the output. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'Returned response.', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], + 'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], 'Data' => [ - 'description' => 'The list of Top SQL.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Executions' => [ - 'title' => '', - 'description' => 'Total number of executions during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RpcCount' => [ - 'title' => '期间的RPC次数', - 'description' => 'RPC count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RemotePlans' => [ - 'title' => '', - 'description' => 'Remote execution count during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MissPlans' => [ - 'title' => '', - 'description' => 'Missed hit count of the execution plan during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxElapsedTime' => [ - 'title' => '期间最大响应时间', - 'description' => 'Max response time during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '13643.3', - ], - 'TotalWaitTime' => [ - 'title' => '期间总等待时间', - 'description' => 'Total wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '10.966', - ], - 'ExecPs' => [ - 'title' => '期间的平均每秒执行次数', - 'description' => 'Average execution count per second during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'description' => 'Max CPU time (in milliseconds).', - 'type' => 'number', - 'format' => 'double', - 'example' => '13641.9', - ], - 'CpuPercentage' => [ - 'title' => 'CPU占比', - 'description' => 'CPU percentage.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'ClientIp' => [ - 'title' => '客户端 IP。', - 'description' => 'Client IP.', - 'type' => 'string', - 'example' => 'i-bp1db****38uemejio', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'Username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'test_db', - ], - 'RetCode4012Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 4012 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode4013Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 4013 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5001Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 5001 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5024Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 5024 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5167Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 5167 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5217Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 5217 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode6002Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of the code 6002 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'FailPercentage' => [ - 'title' => '期间内的错误百分比', - 'description' => 'Error percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'SumWaitTime' => [ - 'title' => '期间内的总等待时间（毫秒）', - 'description' => 'Total wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9421.73', - ], - 'AvgWaitCount' => [ - 'title' => '期间内的平均等待次数', - 'description' => 'Average wait count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgRpcCount' => [ - 'title' => '期间内的平均发送RPC次数', - 'description' => 'Average count of RPC sent during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '8.0', - ], - 'LocalPlanPercentage' => [ - 'title' => '期间内的本地计划百分比', - 'description' => 'Local plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RemotePlanPercentage' => [ - 'title' => '期间内的远程计划百分比', - 'description' => 'Remote plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'DistPlanPercentage' => [ - 'title' => '期间内的分布式计划百分比', - 'description' => 'Distributed plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'SumElapsedTime' => [ - 'title' => '期间内的总响应时间（毫秒）', - 'description' => 'Total response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '11452126.36', - ], - 'AvgNetTime' => [ - 'title' => '期间内的平均网络传输时间（毫秒）', - 'description' => 'Average network transmission time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExecutorRpcCount' => [ - 'title' => '期间内的平均执行RPC请求次数', - 'description' => 'Average number of RPC requests executed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MissPlanPercentage' => [ - 'title' => '期间内的计划命中率', - 'description' => 'Plan hit rage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'TableScanPercentage' => [ - 'title' => '期间内的表扫描百分比', - 'description' => 'Table scan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'StrongConsistencyPercentage' => [ - 'title' => '期间内的强一致性事务百分比', - 'description' => 'Strong consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'WeakConsistencyPercentage' => [ - 'title' => '期间内的弱一致性事务百分比', - 'description' => 'Eventually consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxAffectedRows' => [ - 'title' => '期间内的最大影响行数', - 'description' => 'Max affected rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '10000.0', - ], - 'MaxReturnRows' => [ - 'title' => '期间内的最大返回行数', - 'description' => 'Max returned rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxWaitTime' => [ - 'title' => '期间内的最大等待时间（毫秒', - 'description' => 'Max wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3.4', - ], - 'MaxApplicationWaitTime' => [ - 'title' => '期间内的最大Application事件等待时间（毫秒）', - 'description' => 'Max Application event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxConcurrencyWaitTime' => [ - 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', - 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxUserIoWaitTime' => [ - 'title' => '期间内的最大UserIO事件等待时间（毫秒）', - 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxDiskReads' => [ - 'title' => '期间内的最大物理读次数', - 'description' => 'Max physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExpectedWorkerCount' => [ - 'title' => '期间内平均并行度', - 'description' => 'Average degree of parallelism during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'AvgUsedWorkerCount' => [ - 'title' => '期间内sql平均使用线程数', - 'description' => 'Average number of threads used of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'SumLogicalReads' => [ - 'title' => '期间内 sql 总逻辑读', - 'description' => 'Total logical reads.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Server' => [ - 'title' => 'SQL执行所在的Server', - 'description' => 'The server where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1****8uemejio', - ], - 'ServerIp' => [ - 'title' => 'SQL执行所在的Server的IP', - 'description' => 'The server IP where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1****8uemejio', - ], - 'ServerPort' => [ - 'title' => 'SQL执行所在的Server的Port', - 'description' => 'The server port where the SQL is executed.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '389', - ], - 'SqlTextShort' => [ - 'title' => 'SQL的文本（前100字符）', - 'description' => 'SQL text (the first 100 characters).', - 'type' => 'string', - 'example' => 'delete /*+ XXX PARALLEL(4) */ fro', - ], - 'SqlType' => [ - 'title' => 'SQL类型', - 'description' => 'SQL type.', - 'type' => 'string', - 'example' => 'select ', - ], - 'SqlId' => [ - 'title' => 'SQL id', - 'description' => 'SQL ID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'Inner' => [ - 'title' => '是否是内部SQL', - 'description' => 'Whether a internal SQL.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'WaitEvent' => [ - 'title' => '期间内的最长等待事件', - 'description' => 'Longest wait event during the execution period.', - 'type' => 'string', - 'example' => 'none', - ], - 'AvgAffectedRows' => [ - 'title' => '期间内平均更新行数', - 'description' => 'Average updated rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9978.75', - ], - 'AvgReturnRows' => [ - 'title' => '期间内平均返回行数', - 'description' => 'Average returned rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgPartitionCount' => [ - 'title' => '期间内平均访问分区数', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - ], - 'FailCount' => [ - 'title' => '', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgWaitTime' => [ - 'title' => '期间内的平均等待时间（毫秒）', - 'description' => 'Average wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1442.49', - ], - 'AvgElapsedTime' => [ - 'title' => '期间内的平均响应时间（毫秒）', - 'description' => 'Average response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '903.29', - ], - 'AvgCpuTime' => [ - 'title' => '期间内的平均CPU时间（毫秒）', - 'description' => 'Average CPU time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1875.34', - ], - 'AvgNetWaitTime' => [ - 'title' => '期间内的平均网络入队时间（毫秒）', - 'description' => 'Average network enqueue time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgQueueTime' => [ - 'title' => '期间内的平均排队时间（毫秒）', - 'description' => 'Average queueing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.01', - ], - 'AvgDecodeTime' => [ - 'title' => '期间内的平均语法解析时间（毫秒）', - 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgGetPlanTime' => [ - 'title' => '期间内的平均计划生成时间（毫秒）', - 'description' => 'Average plan generation time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExecuteTime' => [ - 'title' => '期间内的平均计划执行时间（毫秒）', - 'description' => 'Average plan execution time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1895.7', - ], - 'AvgApplicationWaitTime' => [ - 'title' => '期间内的平均Application事件等待时间（毫秒）', - 'description' => 'Average Application event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgConcurrencyWaitTime' => [ - 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', - 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgUserIoWaitTime' => [ - 'title' => '期间内的平均UserIO事件等待时间（毫秒）', - 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgScheduleTime' => [ - 'title' => '期间内的平均Schedule事件等待时间（毫秒）', - 'description' => 'Average Schedule event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgRowCacheHit' => [ - 'title' => '期间内的平均RowCache命中次数', - 'description' => 'Average RowCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBloomFilterCacheHit' => [ - 'title' => '期间内的平均BloomFilterCache命中次数', - 'description' => 'Average BloomFilterCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBlockCacheHit' => [ - 'title' => '期间内的平均BlockCache命中次数', - 'description' => 'Average BlockCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBlockIndexCacheHit' => [ - 'title' => '期间内的平均BlockIndexCache命中次数', - 'description' => 'Average BlockIndexCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgDiskReads' => [ - 'title' => '期间内的平均物理读次数', - 'description' => 'Average physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RetryCount' => [ + 'description' => 'The return result.', + 'type' => 'object', + 'properties' => [ + 'TotalSessionCount' => ['description' => 'The total number of sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ActiveSessionCount' => ['description' => 'The number of active sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'IdleSessionCount' => ['description' => 'The number of sessions in the SLEEP state.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'AllProcessList' => [ + 'description' => 'The details of all sessions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => ['description' => 'The SQL text.', 'type' => 'string', 'example' => 'select * from c1 where id = 100;', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 't********', 'title' => ''], + 'Database' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'c1', 'title' => ''], + 'User' => ['description' => 'The user to which the session belongs.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'ExecuteTime' => ['description' => 'The definition of this parameter varies based on whether the SQL statement is executed.'."\n" + .'* When the request is accepted and the result is not returned to the client, this parameter indicates the time interval between the time when the request is accepted and the current time, in seconds.'."\n" + .'* When the request is not accepted, this parameter indicates the duration for which the current status lasts, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CpuTime' => ['description' => 'The CPU time spent on executing the current SQL statement, in seconds. '."\n" + ."\n" + .'> This parameter is introduced since OceanBase Database V3.2.4 BP5.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServerIp' => ['description' => 'The IP address of the server.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'SessionId' => ['description' => 'The ID of the session.', 'type' => 'integer', 'format' => 'int64', 'example' => '322441****', 'title' => ''], + 'ProxySessId' => ['description' => 'The session ID of the client. If an OceanBase Database Proxy (ODP) is used for connection, the session ID of the ODP is returned.', 'type' => 'string', 'example' => '7521015416********', 'title' => ''], + 'Command' => ['description' => 'The type of the SQL statement being executed in the session.', 'type' => 'string', 'example' => 'Query', 'title' => ''], + 'Status' => ['description' => 'The status of the session.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], + 'SqlId' => ['description' => 'The ID of the SQL statement.', 'type' => 'string', 'example' => '45CCBDC7DEBDCDAXXXXAFC********', 'title' => ''], + 'TraceId' => ['description' => 'The ID of the trace.', 'type' => 'string', 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the execution plan.', 'type' => 'integer', 'example' => '1898', 'format' => 'int64', 'title' => ''], + 'DynamicSql' => ['description' => 'Indicates whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProcessSqlLists' => [ + 'description' => 'Sub-SQL list.', + 'title' => 'Sub-SQL List', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SqlText' => ['description' => 'SQL text.', 'type' => 'string', 'example' => 'select * from c1 where id = 100;', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID. ', 'type' => 'string', 'example' => 't********', 'title' => ''], + 'Database' => ['description' => 'Database name. ', 'type' => 'string', 'example' => 'c2', 'title' => ''], + 'User' => ['description' => 'The user to whom the session belongs.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'ExecuteTime' => ['description' => 'The duration in seconds, depending on whether a command is executed:'."\n" + ."\n" + .'- If the request has been accepted but the response has not yet been returned to the client, this value represents the time interval from when the request was accepted to the current time.'."\n" + ."\n" + .'- If the status is not related to accepting a request, this value represents the duration of the current status.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CpuTime' => ['description' => 'CPU time consumed by the current command execution, in seconds. '."\n" + .'> '."\n" + .'> This field was introduced in Version V3.2.4 BP5.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServerIp' => ['description' => 'Server IP address.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'ClientIp' => ['description' => 'Client IP address.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'SessionId' => ['description' => 'Session ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '322441****', 'title' => ''], + 'ProxySessId' => ['description' => 'If the current client is ODP, this column displays the ODP session ID.', 'type' => 'string', 'example' => '7521015416********', 'title' => ''], + 'Command' => ['description' => 'The command that the session is executing. ', 'type' => 'string', 'example' => 'Query', 'title' => ''], + 'Status' => ['description' => 'The current status of the session.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], + 'SqlId' => ['description' => 'SQL ID.', 'type' => 'string', 'example' => '45CCBDC7DEBDCDAXXXXAFC********', 'title' => ''], + 'TraceId' => ['description' => 'Trace ID. ', 'type' => 'string', 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', 'title' => ''], + 'PlanId' => ['description' => 'Execution plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1898', 'title' => ''], + 'DynamicSql' => ['description' => 'Indicates whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProcessSqlList' => [ + 'description' => 'Sub-SQL list', + 'title' => 'Sub-SQL list', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SqlText' => ['description' => 'SQL text.', 'type' => 'string', 'example' => 'select * from c1 where id = 100;', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 't********', 'title' => ''], + 'Database' => ['description' => 'Database name.', 'type' => 'string', 'example' => 'c3', 'title' => ''], + 'User' => ['description' => 'The user to whom the session belongs.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'ExecuteTime' => ['description' => 'The duration in seconds, depending on whether a command is executed:'."\n" + ."\n" + .'- If the command is executed after accepting a request and before returning a response to the client, this value represents the interval from the time the request was accepted to the current time.'."\n" + ."\n" + .'- If the status is not related to accepting a request, this value represents the duration for which the current status has been maintained.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'CpuTime' => ['description' => 'CPU time consumed by the current command execution, in seconds. '."\n" + .'> '."\n" + .'> This field was introduced starting from Version V3.2.4 BP5.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ServerIp' => ['description' => 'Server IP address.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'ClientIp' => ['description' => 'Client IP.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'SessionId' => ['description' => 'Session ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '322441****', 'title' => ''], + 'ProxySessId' => ['description' => 'If the current client is ODP, this field displays the ODP session ID.', 'type' => 'string', 'example' => '7521015416********', 'title' => ''], + 'Command' => ['description' => 'The command that the session is executing.', 'type' => 'string', 'example' => 'Query', 'title' => ''], + 'Status' => ['description' => 'The current status of the session.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], + 'SqlId' => ['description' => 'SQL ID.', 'type' => 'string', 'example' => '45CCBDC7DEBDCDAXXXXAFC********'."\n", 'title' => ''], + 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', 'title' => ''], + 'PlanId' => ['description' => 'Execution plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1898', 'title' => ''], + 'DynamicSql' => ['description' => 'Indicates whether the SQL is dynamic.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ServerSn' => ['description' => 'Edge zone ID.', 'type' => 'string', 'example' => 'i-bp1*****sw64dhb*****', 'title' => ''], + ], + 'description' => 'The details of all sessions.', 'title' => '', - 'description' => 'Total retry count during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgMemstoreReadRows' => [ - 'title' => '期间内的强一致性事务百分比', - 'description' => 'Strong consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgSsstoreReadRows' => [ - 'title' => '期间内的弱一致性事务百分比', - 'description' => 'Eventually consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgLogicalReads' => [ - 'title' => '期间内 sql 平均逻辑读', - 'description' => 'Average logical reads of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'DynamicSql' => [ - 'title' => '是否动态SQL', - 'type' => 'boolean', + 'example' => '', ], - 'SqlList' => [ - 'title' => 'SQL列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Executions' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RpcCount' => [ - 'title' => '期间的RPC次数', - 'type' => 'number', - 'format' => 'double', - ], - 'RemotePlans' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'MissPlans' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'MaxElapsedTime' => [ - 'title' => '期间最大响应时间', - 'type' => 'number', - 'format' => 'double', - ], - 'TotalWaitTime' => [ - 'title' => '期间总等待时间', - 'type' => 'number', - 'format' => 'double', - ], - 'ExecPs' => [ - 'title' => '期间的平均每秒执行次数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'type' => 'number', - 'format' => 'double', - ], - 'CpuPercentage' => [ - 'title' => 'CPU占比', - 'type' => 'number', - 'format' => 'double', - ], - 'ClientIp' => [ - 'title' => '客户端 IP。', - 'type' => 'string', - ], - 'UserName' => [ - 'title' => '用户名', - 'type' => 'string', - ], - 'DbName' => [ - 'title' => '数据库名', - 'type' => 'string', - ], - 'RetCode4012Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode4013Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5001Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5024Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5167Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5217Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode6002Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'FailPercentage' => [ - 'title' => '期间内的错误百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'SumWaitTime' => [ - 'title' => '期间内的总等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgWaitCount' => [ - 'title' => '期间内的平均等待次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgRpcCount' => [ - 'title' => '期间内的平均发送RPC次数', - 'type' => 'number', - 'format' => 'double', - ], - 'LocalPlanPercentage' => [ - 'title' => '期间内的本地计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'RemotePlanPercentage' => [ - 'title' => '期间内的远程计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'DistPlanPercentage' => [ - 'title' => '期间内的分布式计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'SumElapsedTime' => [ - 'title' => '期间内的总响应时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgNetTime' => [ - 'title' => '期间内的平均网络传输时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExecutorRpcCount' => [ - 'title' => '期间内的平均执行RPC请求次数', - 'type' => 'number', - 'format' => 'double', - ], - 'MissPlanPercentage' => [ - 'title' => '期间内的计划命中率', - 'type' => 'number', - 'format' => 'double', - ], - 'TableScanPercentage' => [ - 'title' => '期间内的表扫描百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'StrongConsistencyPercentage' => [ - 'title' => '期间内的强一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'WeakConsistencyPercentage' => [ - 'title' => '期间内的弱一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxAffectedRows' => [ - 'title' => '期间内的最大影响行数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxReturnRows' => [ - 'title' => '期间内的最大返回行数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxWaitTime' => [ - 'title' => '期间内的最大等待时间（毫秒', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxApplicationWaitTime' => [ - 'title' => '期间内的最大Application事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxConcurrencyWaitTime' => [ - 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxUserIoWaitTime' => [ - 'title' => '期间内的最大UserIO事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxDiskReads' => [ - 'title' => '期间内的最大物理读次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExpectedWorkerCount' => [ - 'title' => '期间内平均并行度', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgUsedWorkerCount' => [ - 'title' => '期间内sql平均使用线程数', - 'type' => 'number', - 'format' => 'double', - ], - 'SumLogicalReads' => [ - 'title' => '期间内 sql 总逻辑读', - 'type' => 'number', - 'format' => 'double', - ], - 'Server' => [ - 'title' => 'SQL执行所在的Server', - 'type' => 'string', - ], - 'ServerIp' => [ - 'title' => 'SQL执行所在的Server的IP', - 'type' => 'string', - ], - 'ServerPort' => [ - 'title' => 'SQL执行所在的Server的Port', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SqlTextShort' => [ - 'title' => 'SQL的文本（前100字符）', - 'type' => 'string', - ], - 'SqlType' => [ - 'title' => 'SQL类型', - 'type' => 'string', - ], - 'SqlId' => [ - 'title' => 'SQL id', - 'type' => 'string', - ], - 'Inner' => [ - 'title' => '是否是内部SQL', - 'type' => 'boolean', - ], - 'WaitEvent' => [ - 'title' => '期间内的最长等待事件', - 'type' => 'string', - ], - 'AvgAffectedRows' => [ - 'title' => '期间内平均更新行数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgReturnRows' => [ - 'title' => '期间内平均返回行数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgPartitionCount' => [ - 'title' => '期间内平均访问分区数', - 'type' => 'number', - 'format' => 'double', - ], - 'FailCount' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'AvgWaitTime' => [ - 'title' => '期间内的平均等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgElapsedTime' => [ - 'title' => '期间内的平均响应时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgCpuTime' => [ - 'title' => '期间内的平均CPU时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgNetWaitTime' => [ - 'title' => '期间内的平均网络入队时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgQueueTime' => [ - 'title' => '期间内的平均排队时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDecodeTime' => [ - 'title' => '期间内的平均语法解析时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgGetPlanTime' => [ - 'title' => '期间内的平均计划生成时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExecuteTime' => [ - 'title' => '期间内的平均计划执行时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgApplicationWaitTime' => [ - 'title' => '期间内的平均Application事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgConcurrencyWaitTime' => [ - 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgUserIoWaitTime' => [ - 'title' => '期间内的平均UserIO事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgScheduleTime' => [ - 'title' => '期间内的平均Schedule事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgRowCacheHit' => [ - 'title' => '期间内的平均RowCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBloomFilterCacheHit' => [ - 'title' => '期间内的平均BloomFilterCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBlockCacheHit' => [ - 'title' => '期间内的平均BlockCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBlockIndexCacheHit' => [ - 'title' => '期间内的平均BlockIndexCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDiskReads' => [ - 'title' => '期间内的平均物理读次数', - 'type' => 'number', - 'format' => 'double', - ], - 'RetryCount' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'AvgMemstoreReadRows' => [ - 'title' => '期间内的强一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgSsstoreReadRows' => [ - 'title' => '期间内的弱一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgLogicalReads' => [ - 'title' => '期间内 sql 平均逻辑读', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDbTime' => [ - 'type' => 'number', - 'format' => 'double', + 'title' => '', + 'example' => '', + ], + 'SessionStatistics' => [ + 'description' => 'The session data in different dimensions.', + 'type' => 'object', + 'properties' => [ + 'UserStatistics' => [ + 'description' => 'The session data in the user dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'ActiveCount' => ['description' => 'The number of active sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Type' => ['description' => 'The dimension. This value is fixed to user.', 'type' => 'string', 'example' => 'user', 'title' => ''], ], - 'SumDbTime' => [ - 'type' => 'number', - 'format' => 'double', + 'description' => 'The session data in the user dimension.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SourceStatistics' => [ + 'description' => 'The session data in the client dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''], + 'ActiveCount' => ['description' => 'The number of active sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Type' => ['description' => 'The dimension. This value is fixed to client.', 'type' => 'string', 'example' => 'client', 'title' => ''], ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', + 'description' => 'The session data in the client dimension.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DataBaseStatistics' => [ + 'description' => 'The session data in the database dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'test_database', 'title' => ''], + 'ActiveCount' => ['description' => 'The number of active sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Type' => ['description' => 'The dimension. This value is fixed to database.', 'type' => 'string', 'example' => 'database', 'title' => ''], ], + 'description' => 'The session data in the database dimension.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'LastFailCode' => [ - 'title' => '期间最后一次执行出错的错误码', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AvgDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'SumDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'CustomColumns' => [ - 'title' => '自定义列', - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'title' => '自定义列的表达式', - 'type' => 'string', - ], - 'Value' => [ - 'title' => '根据表达式计算的值', - 'type' => 'string', - ], - ], - ], - 'ObDbId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', - ], + 'title' => '', + 'example' => '', ], + 'ObVersion' => ['title' => '', 'description' => 'The version of OceanBase Database.', 'type' => 'string', 'example' => '3.2.4'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"i-bp1db****38uemejio\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 0,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"LastFailCode\\": -4012,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"CustomColumns\\": {\\n \\"Expression\\": \\"@failCount/@executions\\",\\n \\"Value\\": \\"0.0\\"\\n },\\n \\"ObDbId\\": 0,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeOasTopSQLList', - ], - 'DescribeOasSlowSQLList' => [ - 'summary' => 'You can call this API to view a list of slow queries.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"TotalSessionCount\\": 100,\\n \\"ActiveSessionCount\\": 60,\\n \\"IdleSessionCount\\": 30,\\n \\"AllProcessList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c1\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlLists\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c2\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c3\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\\\n\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false\\n }\\n ]\\n }\\n ],\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\"\\n }\\n ],\\n \\"SessionStatistics\\": {\\n \\"UserStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_user\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"user\\"\\n }\\n ],\\n \\"SourceStatistics\\": [\\n {\\n \\"MetricValue\\": \\"xx.xx.xx.xx\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"client\\"\\n }\\n ],\\n \\"DataBaseStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_database\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"database\\"\\n }\\n ]\\n },\\n \\"ObVersion\\": \\"3.2.4\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query session information', + 'changeSet' => [ + ['createdAt' => '2025-07-11T06:41:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-08T12:08:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-22T14:06:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-05-27T11:46:29.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProcessStatsComposition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'DescribeProject' => [ + 'summary' => 'This API retrieves the details of a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of querying slow SQL historical parameters. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of querying slow SQL historical parameters. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', - ], - ], - [ - 'name' => 'SearchParam', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', - ], - ], - [ - 'name' => 'SearchRule', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search rule. ', - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - ], - [ - 'name' => 'SearchValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The search value. ', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', - ], - ], - [ - 'name' => 'SqlId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'SQL ID, the unique identifier of the SQL.', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - ], - [ - 'name' => 'NodeIp', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IP of the database node.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp18qljorblo8es*****', - ], - ], - [ - 'name' => 'FilterCondition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', - 'type' => 'string', - 'required' => false, - 'example' => '@avgCpuTime > 20 and @executions > 100', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the response.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], - ], - [ - 'name' => 'SqlTextLength', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Max length of the returned SQL text.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '65535', - ], - ], - [ - 'name' => 'DynamicSql', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否动态SQL', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'MergeDynamicSql', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '返回结果时，是否合并动态 SQL', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '', - 'description' => 'Returned response.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ 'title' => '', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The placeholder values for the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The placeholder values for the Message parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The placeholder values for the MessageMcmsKey parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The placeholder values for the MessageMcmsKey parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details for processing HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code (old).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], 'Data' => [ - 'description' => 'The list of slow queries.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Executions' => [ - 'title' => '', - 'description' => 'Total number of executions during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RpcCount' => [ - 'title' => '期间的RPC次数', - 'description' => 'RPC count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemotePlans' => [ - 'title' => '', - 'description' => 'Remote execution count during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MissPlans' => [ - 'title' => '', - 'description' => 'Missed hit count of the execution plan during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxElapsedTime' => [ - 'title' => '期间最大响应时间', - 'description' => 'Max response time during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '260.044', - ], - 'TotalWaitTime' => [ - 'title' => '期间总等待时间', - 'description' => 'Total wait time during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '10.966', - ], - 'ExecPs' => [ - 'title' => '期间的平均每秒执行次数', - 'description' => 'Average execution count per second during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'description' => 'Max CPU time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '257.967', - ], - 'ClientIp' => [ - 'title' => '客户端 IP。', - 'description' => 'Client IP.', - 'type' => 'string', - 'example' => '1*2.***.1*3.***', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'Username.', - 'type' => 'string', - 'example' => 'test_user', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'test_db', - ], - 'RetCode4012Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 4012 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode4013Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 4013 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5001Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5001 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5024Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5024 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5167Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5167 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode5217Count' => [ - 'title' => '', - 'description' => 'Number of occurrences of code 5217 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetCode6002Count' => [ + 'title' => '', + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'WorkerGradeId' => ['description' => 'The ID of the transmission instance.', 'type' => 'string', 'title' => '', 'example' => 'g_i4wa7***'."\n"], + 'WorkerGradeInfo' => [ + 'description' => 'The details of the transmission instance.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'The ID of the transmission instance.', 'type' => 'string', 'example' => 'g_i4wa7***'."\n"], + 'Name' => ['title' => 'Alias ', 'description' => 'The alias of the transmission instance.', 'type' => 'string', 'example' => 'i5fuij***'], + 'Grade' => ['title' => 'Specification', 'description' => 'The specifications of the transmission instance.', 'type' => 'string', 'example' => 'OMS_G2_MIGRATION_LARGE'], + 'Spec' => ['title' => 'Specification Size', 'description' => 'The size of the transmission instance specifications.', 'type' => 'string', 'example' => 'LARGE'], + 'SpecName' => ['title' => 'Instance Type Size Name ', 'description' => 'The name of the transmission instance specification size.', 'type' => 'string', 'example' => 'LARGE'], + 'SourceType' => ['title' => 'Source Data Source Type', 'description' => 'The type of the source data source.', 'type' => 'string', 'example' => 'OB_MYSQL'], + 'SourceRegion' => ['title' => 'Source Data Source Region ', 'description' => 'The region where the source data source is located.', 'type' => 'string', 'example' => 'ap-southeast-1'], + 'DestType' => ['title' => 'Target Data Source Type ', 'description' => 'The type of the destination data source.', 'type' => 'string', 'example' => 'OB_MYSQL'], + 'DestRegion' => ['title' => 'Target Data Source Region', 'description' => 'The region where the destination data source is located.', 'type' => 'string', 'example' => 'ap-southeast-1'], + 'ChargeType' => ['title' => 'Metering Method', 'description' => 'The billing type of the data migration or data synchronization task.', 'type' => 'string', 'example' => 'POSTPAY'], + 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the instance has expired.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'EndTime' => ['title' => 'Expiration Time, UTC', 'description' => 'The expiration time. The time follows the UTC format YYYY-MM-DDThh:mm:ss.', 'type' => 'string', 'example' => '2024-02-02T16:00:00'], + 'GmtCreate' => ['title' => 'Creation Time, UTC ', 'description' => 'The creation time. The time follows the UTC format YYYY-MM-DDThh:mm:ss.', 'type' => 'string', 'example' => '2024-01-28T14:07:44'], + ], + 'title' => '', + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'np_fe****'], + 'Type' => ['description' => 'The task type. Valid values: `MIGRATION` (data migration task) and `SYNC` (data synchronization task).', 'type' => 'string', 'title' => '', 'example' => 'SYNC'], + 'Name' => ['description' => 'The task name. It cannot contain spaces.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'Labels' => [ + 'title' => '', + 'description' => 'The label collection. A maximum of five labels are supported.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The label ID.', 'type' => 'string', 'title' => '', 'example' => 'l_dr****'], + 'Name' => ['description' => 'The label name.', 'type' => 'string', 'title' => '', 'example' => 'test_tag'], + ], + 'description' => '', 'title' => '', - 'description' => 'Number of occurrences of code 6002 during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'FailPercentage' => [ - 'title' => '期间内的错误百分比', - 'description' => 'Error percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'SumWaitTime' => [ - 'title' => '期间内的总等待时间（毫秒）', - 'description' => 'The total wait time (in milliseconds) during the internal waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9421.73', - ], - 'AvgWaitCount' => [ - 'title' => '期间内的平均等待次数', - 'description' => 'Average number of waits during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgRpcCount' => [ - 'title' => '期间内的平均发送RPC次数', - 'description' => 'Average number of RPC sent during the execution.', - 'type' => 'number', - 'format' => 'double', - 'example' => '8.0', - ], - 'LocalPlanPercentage' => [ - 'title' => '期间内的本地计划百分比', - 'description' => 'Local plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RemotePlanPercentage' => [ - 'title' => '期间内的远程计划百分比', - 'description' => 'Remote plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'DistPlanPercentage' => [ - 'title' => '期间内的分布式计划百分比', - 'description' => 'Distributed plan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'SumElapsedTime' => [ - 'title' => '期间内的总响应时间（毫秒）', - 'description' => 'Total response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '11452126.36', - ], - 'AvgNetTime' => [ - 'title' => '期间内的平均网络传输时间（毫秒）', - 'description' => 'Average network transmission time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExecutorRpcCount' => [ - 'title' => '期间内的平均执行RPC请求次数', - 'description' => 'Average number of RPC requests executed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MissPlanPercentage' => [ - 'title' => '期间内的计划命中率', - 'description' => 'Plan hit rage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'TableScanPercentage' => [ - 'title' => '期间内的表扫描百分比', - 'description' => 'Table scan percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'StrongConsistencyPercentage' => [ - 'title' => '期间内的强一致性事务百分比', - 'description' => 'Strong consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100.0', - ], - 'WeakConsistencyPercentage' => [ - 'title' => '期间内的弱一致性事务百分比', - 'description' => 'Eventually consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxAffectedRows' => [ - 'title' => '期间内的最大影响行数', - 'description' => 'Max affected rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '10000.0', - ], - 'MaxReturnRows' => [ - 'title' => '期间内的最大返回行数', - 'description' => 'Max returned rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxWaitTime' => [ - 'title' => '期间内的最大等待时间（毫秒', - 'description' => 'Max wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3.4', - ], - 'MaxApplicationWaitTime' => [ - 'title' => '期间内的最大Application事件等待时间（毫秒）', - 'description' => 'Max Application event wait time (in milliseconds) during the execution period', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxConcurrencyWaitTime' => [ - 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', - 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxUserIoWaitTime' => [ - 'title' => '期间内的最大UserIO事件等待时间（毫秒）', - 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxDiskReads' => [ - 'title' => '期间内的最大物理读次数', - 'description' => 'Max physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExpectedWorkerCount' => [ - 'title' => '期间内平均并行度', - 'description' => 'Average degree of parallelism during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'AvgUsedWorkerCount' => [ - 'title' => '期间内sql平均使用线程数', - 'description' => 'Average number of threads used of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '3', - ], - 'SumLogicalReads' => [ - 'title' => '期间内 sql 总逻辑读', - 'description' => 'Total logical reads of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Server' => [ - 'title' => 'SQL执行所在的Server', - 'description' => 'The server where the SQL is executed.', - 'type' => 'string', - 'example' => 'i-bp1db1a**s038**mej**', - ], - 'ServerIp' => [ - 'title' => 'SQL执行所在的Server的IP', - 'description' => 'The IP address of the server.', - 'type' => 'string', - 'example' => 'i-bp1db1a**s038**mej**', + 'example' => '', ], - 'ServerPort' => [ - 'title' => 'SQL执行所在的Server的Port', - 'description' => 'The server port where the SQL is executed.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10110', - ], - 'SqlTextShort' => [ - 'title' => 'SQL的文本（前100字符）', - 'description' => 'SQL text (the first 100 characters).', - 'type' => 'string', - 'example' => 'select a from b where', - ], - 'SqlType' => [ - 'title' => 'SQL类型', - 'description' => 'SQL type.', - 'type' => 'string', - 'example' => 'select ', - ], - 'SqlId' => [ - 'title' => 'SQL id', - 'description' => 'SQL ID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'Inner' => [ - 'title' => '是否是内部SQL', - 'description' => 'Whether an internal SQL.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'WaitEvent' => [ - 'title' => '期间内的最长等待事件', - 'description' => 'Longest wait event during the execution period.', - 'type' => 'string', - 'example' => 'none', - ], - 'AvgAffectedRows' => [ - 'title' => '期间内平均更新行数', - 'description' => 'Average updated rows during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '9978.75', - ], - 'AvgReturnRows' => [ - 'title' => '期间内平均返回行数', - 'description' => 'Average number of rows returned during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgPartitionCount' => [ - 'title' => '期间内平均访问分区数', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - ], - 'FailCount' => [ - 'title' => '', - 'description' => 'Average number of partition accessed during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AvgWaitTime' => [ - 'title' => '期间内的平均等待时间（毫秒）', - 'description' => 'Average wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.42', - ], - 'AvgElapsedTime' => [ - 'title' => '期间内的平均响应时间（毫秒）', - 'description' => 'Average response time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1876.78', - ], - 'AvgCpuTime' => [ - 'title' => '期间内的平均CPU时间（毫秒）', - 'description' => 'Average CPU time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1875.34', - ], - 'AvgNetWaitTime' => [ - 'title' => '期间内的平均网络入队时间（毫秒）', - 'description' => 'Average network enqueue time (in milliseconds) during the network waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgQueueTime' => [ - 'title' => '期间内的平均排队时间（毫秒）', - 'description' => 'Average queueing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.01', - ], - 'AvgDecodeTime' => [ - 'title' => '期间内的平均语法解析时间（毫秒）', - 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgGetPlanTime' => [ - 'title' => '期间内的平均计划生成时间（毫秒）', - 'description' => 'Average plan generation time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgExecuteTime' => [ - 'title' => '期间内的平均计划执行时间（毫秒）', - 'description' => 'Average plan execution time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1895.7', - ], - 'AvgApplicationWaitTime' => [ - 'title' => '期间内的平均Application事件等待时间（毫秒）', - 'description' => 'Average Application event wait time (in milliseconds) during the client waiting period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgConcurrencyWaitTime' => [ - 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', - 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgUserIoWaitTime' => [ - 'title' => '期间内的平均UserIO事件等待时间（毫秒）', - 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgScheduleTime' => [ - 'title' => '期间内的平均Schedule事件等待时间（毫秒）', - 'description' => 'Average Schedule event wait time (in milliseconds) during the scheduling period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgRowCacheHit' => [ - 'title' => '期间内的平均RowCache命中次数', - 'description' => 'Average RowCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBloomFilterCacheHit' => [ - 'title' => '期间内的平均BloomFilterCache命中次数', - 'description' => 'Average BloomFilterCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBlockCacheHit' => [ - 'title' => '期间内的平均BlockCache命中次数', - 'description' => 'Average BlockCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgBlockIndexCacheHit' => [ - 'title' => '期间内的平均BlockIndexCache命中次数', - 'description' => 'Average BlockIndexCache hit count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgDiskReads' => [ - 'title' => '期间内的平均物理读次数', - 'description' => 'Average physical read count during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'RetryCount' => [ - 'title' => '', - 'description' => 'Total number of retries during the execution period.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'AvgMemstoreReadRows' => [ - 'title' => '期间内的强一致性事务百分比', - 'description' => 'Strong consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgSsstoreReadRows' => [ - 'title' => '期间内的弱一致性事务百分比', - 'description' => 'Eventually consistent transaction percentage during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'AvgLogicalReads' => [ - 'title' => '期间内 sql 平均逻辑读', - 'description' => 'Average logical reads of the SQL during the execution period.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'DynamicSql' => [ - 'title' => '是否动态SQL', - 'type' => 'boolean', - ], - 'SqlList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Executions' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RpcCount' => [ - 'title' => '期间的RPC次数', - 'type' => 'number', - 'format' => 'double', - ], - 'RemotePlans' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'MissPlans' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'MaxElapsedTime' => [ - 'title' => '期间最大响应时间', - 'type' => 'number', - 'format' => 'double', - ], - 'TotalWaitTime' => [ - 'title' => '期间总等待时间', - 'type' => 'number', - 'format' => 'double', - ], - 'ExecPs' => [ - 'title' => '期间的平均每秒执行次数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'type' => 'number', - 'format' => 'double', - ], - 'ClientIp' => [ - 'title' => '客户端 IP。', - 'type' => 'string', - ], - 'UserName' => [ - 'title' => '用户名', - 'type' => 'string', - ], - 'DbName' => [ - 'title' => '数据库名', - 'type' => 'string', - ], - 'RetCode4012Count' => [ - 'title' => '期间内结果码4012的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode4013Count' => [ - 'title' => '期间内结果码4013的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5001Count' => [ - 'title' => '期间内结果码5001的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5024Count' => [ - 'title' => '期间内结果码5024的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5167Count' => [ - 'title' => '期间内结果码5167的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode5217Count' => [ - 'title' => '期间内结果码5217的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RetCode6002Count' => [ - 'title' => '期间内结果码6002的发生次数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'FailPercentage' => [ - 'title' => '期间内的错误百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'SumWaitTime' => [ - 'title' => '期间内的总等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgWaitCount' => [ - 'title' => '期间内的平均等待次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgRpcCount' => [ - 'title' => '期间内的平均发送RPC次数', - 'type' => 'number', - 'format' => 'double', - ], - 'LocalPlanPercentage' => [ - 'title' => '期间内的本地计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'RemotePlanPercentage' => [ - 'title' => '期间内的远程计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'DistPlanPercentage' => [ - 'title' => '期间内的分布式计划百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'SumElapsedTime' => [ - 'title' => '期间内的总响应时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgNetTime' => [ - 'title' => '期间内的平均网络传输时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExecutorRpcCount' => [ - 'title' => '期间内的平均执行RPC请求次数', - 'type' => 'number', - 'format' => 'double', - ], - 'MissPlanPercentage' => [ - 'title' => '期间内的计划命中率', - 'type' => 'number', - 'format' => 'double', - ], - 'TableScanPercentage' => [ - 'title' => '期间内的表扫描百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'StrongConsistencyPercentage' => [ - 'title' => '期间内的强一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'WeakConsistencyPercentage' => [ - 'title' => '期间内的弱一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxAffectedRows' => [ - 'title' => '期间内的最大影响行数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxReturnRows' => [ - 'title' => '期间内的最大返回行数', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxWaitTime' => [ - 'title' => '期间内的最大等待时间（毫秒', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxApplicationWaitTime' => [ - 'title' => '期间内的最大Application事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxConcurrencyWaitTime' => [ - 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxUserIoWaitTime' => [ - 'title' => '期间内的最大UserIO事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'MaxDiskReads' => [ - 'title' => '期间内的最大物理读次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExpectedWorkerCount' => [ - 'title' => '期间内平均并行度', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgUsedWorkerCount' => [ - 'title' => '期间内sql平均使用线程数', - 'type' => 'number', - 'format' => 'double', - ], - 'SumLogicalReads' => [ - 'title' => '期间内 sql 总逻辑读', - 'type' => 'number', - 'format' => 'double', - ], - 'Server' => [ - 'title' => 'SQL执行所在的Server', - 'type' => 'string', - ], - 'ServerIp' => [ - 'title' => 'SQL执行所在的Server的IP', - 'type' => 'string', - ], - 'ServerPort' => [ - 'title' => 'SQL执行所在的Server的Port', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SqlTextShort' => [ - 'title' => 'SQL的文本（前100字符）', - 'type' => 'string', - ], - 'SqlType' => [ - 'title' => 'SQL类型', - 'type' => 'string', - ], - 'SqlId' => [ - 'title' => 'SQL id', - 'type' => 'string', - ], - 'Inner' => [ - 'title' => '是否是内部SQL', - 'type' => 'boolean', - ], - 'WaitEvent' => [ - 'title' => '期间内的最长等待事件', - 'type' => 'string', - ], - 'AvgAffectedRows' => [ - 'title' => '期间内平均更新行数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgReturnRows' => [ - 'title' => '期间内平均返回行数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgPartitionCount' => [ - 'title' => '期间内平均访问分区数', - 'type' => 'number', - 'format' => 'double', - ], - 'FailCount' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'AvgWaitTime' => [ - 'title' => '期间内的平均等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgElapsedTime' => [ - 'title' => '期间内的平均响应时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgCpuTime' => [ - 'title' => '期间内的平均CPU时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgNetWaitTime' => [ - 'title' => '期间内的平均网络入队时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgQueueTime' => [ - 'title' => '期间内的平均排队时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDecodeTime' => [ - 'title' => '期间内的平均语法解析时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgGetPlanTime' => [ - 'title' => '期间内的平均计划生成时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgExecuteTime' => [ - 'title' => '期间内的平均计划执行时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgApplicationWaitTime' => [ - 'title' => '期间内的平均Application事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgConcurrencyWaitTime' => [ - 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgUserIoWaitTime' => [ - 'title' => '期间内的平均UserIO事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgScheduleTime' => [ - 'title' => '期间内的平均Schedule事件等待时间（毫秒）', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgRowCacheHit' => [ - 'title' => '期间内的平均RowCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBloomFilterCacheHit' => [ - 'title' => '期间内的平均BloomFilterCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBlockCacheHit' => [ - 'title' => '期间内的平均BlockCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgBlockIndexCacheHit' => [ - 'title' => '期间内的平均BlockIndexCache命中次数', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDiskReads' => [ - 'title' => '期间内的平均物理读次数', - 'type' => 'number', - 'format' => 'double', - ], - 'RetryCount' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'AvgMemstoreReadRows' => [ - 'title' => '期间内的强一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgSsstoreReadRows' => [ - 'title' => '期间内的弱一致性事务百分比', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgLogicalReads' => [ - 'title' => '期间内 sql 平均逻辑读', - 'type' => 'number', - 'format' => 'double', - ], - 'AvgDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'SumDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', - ], - ], - ], - ], - 'AvgDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'SumDbTime' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'FormatSqlId' => [ - 'title' => 'FormatSqlId', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"TotalWaitTime\\": 10.966,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerIp\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerPort\\": 10110,\\n \\"SqlTextShort\\": \\"select a from b where\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 5,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"127.0.0.1\\",\\n \\"UserName\\": \\"admin\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 0,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"10.**.**.6\\",\\n \\"ServerIp\\": \\"11.***.**.69\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"SqlType\\": \\"SELECT\\",\\n \\"SqlId\\": \\"4CE89****8536A03374DD2****E76DE5\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 22,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 0,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeOasSlowSQLList', - ], - 'DescribeOutlineBinding' => [ - 'summary' => 'You can call this operation to query the outline binding information or throttling information of an SQL statement in the database based on an SQLID. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'formData', - 'schema' => [ - 'title' => '表名称。', - 'description' => 'The name of the tenant. '."\n" - .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to SYS. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_online', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb', - ], - ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - ], - [ - 'name' => 'IsConcurrentLimit', - 'in' => 'formData', - 'schema' => [ - 'title' => '当值为True时，查询SQLID在数据库中的限流信息', - 'description' => '- When the value is set to True, the throttling information in the database is queried based on the SQL ID. '."\n" - .'- When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID. ', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'DynamicSql', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否模版sql', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'FormatSqlId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'format sqlId', - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'OutlineBinding' => [ - 'title' => '绑定信息', - 'description' => 'The binding information. ', - 'type' => 'object', - 'properties' => [ - 'BindPlan' => [ - 'title' => '绑定计划', - 'description' => 'The bound plan. ', - 'type' => 'string', - 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', - ], - 'OutlineId' => [ - 'title' => 'OutlineID', - 'description' => 'OutlineID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'BindIndex' => [ - 'title' => '绑定索引', - 'description' => 'The bound index. ', - 'type' => 'string', - 'example' => 'PRIMARY', - ], - 'MaxConcurrent' => [ - 'title' => '最大并发', - 'description' => 'The maximum number of concurrent tasks. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'example' => '', ], - 'TableName' => [ - 'title' => '表名称', - 'description' => 'The name of the tenant. The tenant name must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys.', + 'Owner' => ['description' => 'The task owner.', 'type' => 'string', 'title' => '', 'example' => 'omsefry***'], + 'Importance' => ['description' => 'The alert level of the task. Valid values: HIGH (high protection status), MEDIUM (medium protection status), LOW (low protection status), and IGNORE (no protection status).', 'type' => 'string', 'title' => '', 'example' => 'HIGH'], + 'Status' => ['description' => 'The status of the data migration or data synchronization task. Valid values: INIT (not started), RUNNING (running), SUSPEND (suspended), FAILED (failed), FINISHED (completed), RELEASING (releasing), RELEASED (released), DELETED (deleted), RUNNING\\_MODIFYING (modifying), and RUNNING\\_MERGING (merging).', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'GmtCreate' => ['description' => 'The task creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T06:26:15'], + 'GmtModified' => ['description' => 'The task update time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T06:26:15'."\n"], + 'GmtStart' => ['description' => 'The task start time.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T07:02:27'], + 'GmtFinish' => ['description' => 'The task end time.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T07:02:27'], + 'DestConnId' => ['description' => 'The ID of the destination connection information.', 'type' => 'string', 'title' => '', 'example' => 'c_deg***'], + 'IsMerging' => ['description' => 'Indicates whether the task is being merged.', 'type' => 'boolean', 'title' => '', 'example' => 'false '], + 'IsModifying' => ['description' => 'Indicates whether the task is being modified.', 'type' => 'boolean', 'title' => '', 'example' => 'false '], + 'IsSubProject' => ['description' => 'Indicates whether the task is a subtask.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'SourceEndpointType' => [ + 'description' => 'The type of the source data source.', + 'enumValueTitles' => ['POLARDB_X_1' => 'POLARDB\\_X\\_1', 'MYSQL' => 'MYSQL', 'TIDB' => 'TIDB', 'OB_ORACLE' => 'OB\\_ORACLE', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'ORACLE', 'POLARDB_X_2' => 'POLARDB\\_X\\_2'], 'type' => 'string', - 'example' => 'cluster_info', + 'title' => '', + 'example' => 'OB_MYSQL', ], - 'SqlText' => [ - 'title' => '限流的文本', + 'SinkEndpointType' => [ + 'description' => 'The type of the destination data source.', + 'enumValueTitles' => ['MYSQL' => 'MYSQL', 'OB_ORACLE' => 'OB\\_ORACLE', 'KAFKA' => 'KAFKA', 'ROCKETMQ' => 'ROCKETMQ', 'DATAHUB' => 'DATAHUB', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'ORACLE', 'ADB' => 'ADB'], 'type' => 'string', + 'title' => '', + 'example' => 'MYSQL', ], - 'SqlTextConcurrentNum' => [ - 'title' => '限流的数值', - 'type' => 'integer', - 'format' => 'int64', - ], - 'ByFormatSqlId' => [ - 'title' => '是否为模糊绑定', - 'type' => 'boolean', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OutlineBinding\\": {\\n \\"BindPlan\\": \\"PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\",\\n \\"OutlineId\\": -1,\\n \\"BindIndex\\": \\"PRIMARY\\",\\n \\"MaxConcurrent\\": 2,\\n \\"TableName\\": \\"cluster_info\\",\\n \\"SqlText\\": \\"\\",\\n \\"SqlTextConcurrentNum\\": 0,\\n \\"ByFormatSqlId\\": true\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\n -1\\n PRIMARY\\n 2\\n \\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', - 'title' => 'DescribeOutlineBinding', - ], - 'DescribeRecommendIndex' => [ - 'summary' => 'You can call this operation to query the index recommended by the diagnostic system based on an SQL ID. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The index recommended for the SQL statement after calculation by the diagnostic system. '."\n" - .'- If the recommended index is the primary key, PRIMARY is returned. '."\n" - .'- If an index created by the user is recommended, the index name is returned. '."\n" - .'The system recommends only one index for an SQL statement. You can call the DescribeIndexes operation to view the indexes of a table. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'You can obtain the SQL ID from the return value of the DescribeSlowSQLList or DescribeTopSQLList operation. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The tenant mode. Valid values: '."\n" - .'Oracle '."\n" - .'MySQL ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'RecommendIndex' => [ - 'title' => '推荐索引信息', - 'description' => 'The information about the recommended index. ', - 'type' => 'object', - 'properties' => [ - 'SuggestIndex' => [ - 'title' => '建议索引，如果是主键，就是 PRIMARY，如果不是主键，以用户取名为准', - 'description' => 'Example 1', - 'type' => 'string', - 'example' => 'PRIMARY', - ], - 'TenantMode' => [ - 'title' => '租户模式', - 'description' => ' ', - 'type' => 'string', - 'example' => 'mysql', - ], - 'TableList' => [ - 'title' => '表信息', - 'description' => ' ', - 'type' => 'string', - 'example' => 'testtable', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"RecommendIndex\\": {\\n \\"SuggestIndex\\": \\"PRIMARY\\",\\n \\"TenantMode\\": \\"mysql\\",\\n \\"TableList\\": \\"testtable\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n PRIMARY\\n mysql\\n testtable\\n \\n","errorExample":""}]', - 'title' => 'DescribeRecommendIndex', - ], - 'DescribeSQLTuningAdvices' => [ - 'summary' => 'You can call this operation to query SQL optimization suggestions for two purposes: creating indexes and binding execution plans.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'obsdf43****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tsdc2s2****', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb', - ], - ], - [ - 'name' => 'SqlId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SqlId', - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'The start time.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T04:38:38Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-12T05:38:38Z', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The supported language. Valid values: '."\n" - .'* zh-CN '."\n" - .'* en-US', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the execution plans of the SQL statement.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The optimization type.', - 'type' => 'string', - 'example' => 'PLAN_BINDING/INDEX_CREATION', - ], - 'ColumnNames' => [ - 'description' => 'The sequence of index columns.', - 'type' => 'string', - 'example' => 'c1;c2;c3', - ], - 'LocalityType' => [ - 'title' => '索引类型', - 'description' => 'The type of the index.', - 'type' => 'string', - 'example' => 'Local/Global', - ], - 'Columns' => [ - 'title' => '索引列', - 'description' => 'The list of index columns.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about index columns.', - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'description' => 'The name of the column.', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Ndv' => [ - 'title' => 'NDV', - 'description' => 'The NDV of the column.', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'MinValue' => [ - 'title' => '最小值', - 'description' => 'The minimum value of the column.', - 'type' => 'string', - 'example' => '1', - ], - 'MaxValue' => [ - 'title' => '最大值', - 'description' => 'The maximum value of the column.', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - 'DbName' => [ - 'title' => '数据库名称', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Table' => [ - 'title' => '表名', - 'description' => 'The name of the table.', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Plan' => [ - 'description' => 'The execution plan.', - 'type' => 'object', - 'properties' => [ - 'Executions' => [ - 'description' => 'The total number of executions within the specified period of time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2062', - ], - 'AvgCpuTime' => [ - 'description' => 'The average CPU time within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.36', - ], - 'PlanHash' => [ - 'description' => 'The unique identifier of the execution plan in the diagnostic system.', - 'type' => 'string', - 'example' => '-86290582****886880', - ], - 'TimeoutPercentage' => [ - 'description' => 'The percentage of executions with a timeout error.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AvgConcurrencyWaitTime' => [ - 'description' => 'The average amount of time spent on a Concurrency wait event within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'FirstLoadTimeUs' => [ - 'description' => 'The time when the execution plan was loaded for the first time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672367130576163', - ], - 'AvgDiskWrites' => [ - 'description' => 'The average number of physical writes within the specified period of time.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AvgUserIoWaitTime' => [ - 'description' => 'The average amount of time spent on a UserIo wait event within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PlanSize' => [ - 'description' => 'The size of the execution plan.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49216', - ], - 'ServerSn' => [ - 'description' => 'The ID of the node.', - 'type' => 'string', - 'example' => 'i-bp1*****sw64dhb*****', - ], - 'OutlineData' => [ - 'description' => 'The outline_data field of the execution plan.', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'PlanType' => [ - 'description' => 'The type of the execution plan. Valid values: LOCAL, REMOTE, and DIST.', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'ObDbId' => [ - 'description' => 'The ID of the database.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1108307720799259', - ], - 'HitPercentage' => [ - 'description' => 'The hit rate.', - 'type' => 'number', - 'format' => 'float', - 'example' => '66.8', - ], - 'AvgBufferGets' => [ - 'description' => 'The average number of cache reads within the specified period of time.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ExecPs' => [ - 'description' => 'The average number of executions per second within the specified period of time.', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.45', - ], - 'DelayedLargeQueryPercentage' => [ - 'description' => 'The percentage of delayed long-running queries.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TableScan' => [ - 'description' => 'Indicates whether full table scan is performed.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'LargeQueryPercentage' => [ - 'description' => 'The percentage of completed long-running queries.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SchemaVersion' => [ - 'description' => 'The version of the schema.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672367130529680', - ], - 'PlanId' => [ - 'description' => 'The ID of the execution plan.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '818', - ], - 'FirstLoadTime' => [ - 'description' => 'The time when the execution plan was loaded for the first time.', - 'type' => 'string', - 'example' => '2022-12-30T02:25:30.576Z', - ], - 'AvgRowProcessed' => [ - 'description' => 'The average wait time of row processing within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'MergedVersion' => [ - 'description' => 'The version of the major compaction.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'HitDiagnosis' => [ - 'description' => 'Indicates whether the diagnosis is hit.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Uid' => [ - 'description' => 'The unique identifier of the execution plan.', - 'type' => 'string', - 'example' => 'AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj', - ], - 'AvgApplicationWaitTime' => [ - 'description' => 'The average amount of time spent on an Application wait event within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CollectTimeUs' => [ - 'description' => 'The period of time during which data is collected.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672358400000000', - ], - 'AvgElapsedTime' => [ - 'description' => 'The average interval wait time within the specified period of time, in milliseconds.', - 'type' => 'number', - 'format' => 'float', - 'example' => '713.62', - ], - 'ObServerId' => [ - 'description' => 'The ID of the server.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutlineId' => [ - 'description' => 'The ID of the outline.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AvgDiskReads' => [ - 'description' => 'The average number of physical reads within the specified period of time.', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": \\"PLAN_BINDING/INDEX_CREATION\\",\\n \\"ColumnNames\\": \\"c1;c2;c3\\",\\n \\"LocalityType\\": \\"Local/Global\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"xxxx\\",\\n \\"Ndv\\": 100,\\n \\"MinValue\\": \\"1\\",\\n \\"MaxValue\\": \\"100\\"\\n }\\n ],\\n \\"DbName\\": \\"test_db\\",\\n \\"Table\\": \\"test_table\\",\\n \\"Plan\\": {\\n \\"Executions\\": 2062,\\n \\"AvgCpuTime\\": 100.36,\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"TimeoutPercentage\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"FirstLoadTimeUs\\": 1672367130576163,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"PlanSize\\": 49216,\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\",\\n \\"OutlineData\\": \\"xxxxx\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"ObDbId\\": 1108307720799259,\\n \\"HitPercentage\\": 66.8,\\n \\"AvgBufferGets\\": 0,\\n \\"ExecPs\\": 1.45,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"LargeQueryPercentage\\": 0,\\n \\"SchemaVersion\\": 1672367130529680,\\n \\"PlanId\\": 818,\\n \\"FirstLoadTime\\": \\"2022-12-30T02:25:30.576Z\\",\\n \\"AvgRowProcessed\\": 1,\\n \\"MergedVersion\\": 3,\\n \\"HitDiagnosis\\": false,\\n \\"Uid\\": \\"AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj\\",\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"CollectTimeUs\\": 1672358400000000,\\n \\"AvgElapsedTime\\": 713.62,\\n \\"ObServerId\\": 1,\\n \\"OutlineId\\": 1,\\n \\"AvgDiskReads\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeSQLTuningAdvices', - ], - 'DescribeSqlAuditStat' => [ - 'summary' => 'You can call this operation to collect the execution statistics of an SQL statement by client IP address, user, and SQL statement ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群实例Id', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户Id', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => false, - 'example' => 't33h8y08k****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间 yyyy-MM-dd\'T\'HH:mm:ss\'Z\'', - 'description' => 'The start time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\'.', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-14T02:34:49Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间yyyy-MM-dd\'T\'HH:mm:ss\'Z\' (时间跨度过大会导致数据不精准，6小时内最佳，跟单位时间内的数据量有关)', - 'description' => 'The end time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\' . The time range cannot exceed 6 hours.', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-14T03:34:49Z', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of rows to return on each page.'."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'The number of the page to return.'."\n" - .'- Pages start from page 1.'."\n" - .'- Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'OperatorType', - 'in' => 'formData', - 'schema' => [ - 'title' => '操作类型', - 'description' => 'The type of the operation.', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - ], - ], - ], - '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' => ' '."\n" - .'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'."\n", - ], - 'Data' => [ - 'title' => '数据集合', - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '集群实例Id', - 'description' => 'The ID of the cluster instance.', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TenantId' => [ - 'title' => '租户Id', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 't33h8y08k****', - ], - 'UserClientIp' => [ - 'title' => '客户端IP', - 'description' => 'The IP address of the client.', - 'type' => 'string', - 'example' => 'xx.xx.xx.xx'."\n", - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The username.', - 'type' => 'string', - 'example' => 'test_mysql ', - ], - 'DatabaseName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database', - 'type' => 'string', - 'example' => 'test_database_1', - ], - 'SqlId' => [ - 'title' => 'SqlID', - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'TotalSucceed' => [ - 'title' => '总成功条数', - 'description' => 'The total number of successful executions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalFailed' => [ - 'title' => '总失败条数', - 'description' => 'The total number of failed executions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAffectRows' => [ - 'title' => '总影响行数', - 'description' => 'The total number of affected rows.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalScanRows' => [ - 'title' => '总扫描行数', - 'description' => 'The total number of scanned rows.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalReturnRows' => [ - 'title' => '总返回行数', - 'description' => 'The total number of returned rows.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AffectRows' => [ - 'title' => '平均影响行数（0的数据不计算在内）四舍五入', - 'description' => 'The average number of affected rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'ScanRows' => [ - 'title' => '平均扫描行数0的数据不计算在内）四舍五入', - 'description' => 'The average number of scanned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'ReturnRows' => [ - 'title' => '平均返回行数（0的数据不计算在内）四舍五入', - 'description' => 'The average number of returned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'ExecuteTime' => [ - 'title' => '平均执行耗时 单位ms', - 'description' => 'The average execution time, in ms.', - 'type' => 'number', - 'format' => 'double', - 'example' => '142', - ], - 'SqlStatement' => [ - 'title' => 'SQL模板', - 'description' => 'The SQL template.', - 'type' => 'string', - 'example' => 'UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?', - ], - 'OperatorType' => [ - 'title' => '操作类型', - 'description' => 'The type of the operation.', - 'type' => 'string', - 'example' => 'UPDATE', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '总数', - 'description' => 'The total count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\\\t\\\\nEE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UserClientIp\\": \\"xx.xx.xx.xx\\\\n\\",\\n \\"UserName\\": \\"test_mysql \\",\\n \\"DatabaseName\\": \\"test_database_1\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"TotalSucceed\\": 1,\\n \\"TotalFailed\\": 0,\\n \\"TotalAffectRows\\": 1,\\n \\"TotalScanRows\\": 10,\\n \\"TotalReturnRows\\": 1,\\n \\"AffectRows\\": 1,\\n \\"ScanRows\\": 1,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 142,\\n \\"SqlStatement\\": \\"UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?\\",\\n \\"OperatorType\\": \\"UPDATE\\"\\n }\\n ],\\n \\"TotalCount\\": 9\\n}","type":"json"}]', - 'title' => 'DescribeSqlAuditStat', - ], - 'CreateOasOutlineTask' => [ - 'summary' => 'You can call this operation to initiate outline binding tasks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '实例Id', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'SqlText', - 'in' => 'formData', - 'schema' => [ - 'title' => 'sql文本', - 'description' => 'The SQL text.', - 'type' => 'string', - 'required' => true, - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], - ], - [ - 'name' => 'DatabaseName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => true, - 'example' => 'test_data', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'formData', - 'schema' => [ - 'title' => '表名', - 'description' => 'The name of the table.', - 'type' => 'string', - 'required' => false, - 'example' => 'test_1', - ], - ], - [ - 'name' => 'SqlId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'sqlId', - 'description' => 'The ID of the SQL statement.', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - ], - [ - 'name' => 'IsConcurrentLimit', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否为限流', - 'description' => '- When the value is set to True, the throttling information in the database is queried based on the SQL ID. '."\n" - .'- When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID. ', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DynamicSql', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否为动态SQL', - 'description' => 'Specifies whether the specified SQL statements are dynamic SQL statements.'."\n" - .'> This parameter specifies whether the values of the `SqlId` parameter are the IDs of dynamic SQL statements.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'UId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The user identifier (UID) of the OceanBase database.', - 'type' => 'string', - 'required' => false, - 'example' => '139*************', - ], - ], - [ - 'name' => 'PlanData', - 'in' => 'formData', - 'schema' => [ - 'title' => '执行计划', - 'description' => 'The execution plan.', - 'type' => 'string', - 'required' => false, - 'example' => '********', - ], - ], - [ - 'name' => 'IndexName', - 'in' => 'formData', - 'schema' => [ - 'title' => '索引名', - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'idx_a', - ], - ], - [ - 'name' => 'MaxConcurrent', - 'in' => 'formData', - 'schema' => [ - 'title' => '限流数值', - 'description' => 'The maximum number of outline binding tasks that can be initiated at a time.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'The start time of querying the TOPSQL parameter. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => false, - 'example' => '2025-05-13T15:40:43Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time of querying the SQL execution plan. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => false, - 'example' => '2025-05-13T16:40:43Z', - ], - ], - [ - 'name' => 'StatementId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'sql模版id'."\n", - 'description' => 'The ID of the SQL template.', - 'type' => 'string', - 'required' => false, - 'example' => '********', - ], - ], - [ - 'name' => 'BySqlId', - 'in' => 'formData', - 'schema' => [ - 'title' => '用来判断是通过sqlId/sqlText绑定，默认为true', - 'description' => 'Specifies whether to bind by SQLID/SQLText. Default value: true.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Success' => [ - 'title' => '提交成功/失败', - 'description' => 'Indicates whether the call is successful. ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '信息', - 'description' => 'The error description.', - 'type' => 'string', - 'example' => 'successful', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', - 'title' => 'CreateOasOutlineTask', - ], - 'ModifyInstanceSSL' => [ - 'summary' => 'You can call this operation to modify the Secure Sockets Layer (SSL) setting for an OceanBase cluster instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'EnableSSL', - 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The operation to modify the SSL status. Valid values:'."\n" - ."\n" - .'- open: Enable SSL encryption.'."\n" - ."\n" - .'- update: Update the CA certificate.'."\n" - ."\n" - .'- close: Disable SSL encryption.', - 'type' => 'string', - 'required' => true, - 'example' => 'open', - 'enum' => [], - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'InstanceSSL' => [ - 'title' => 'job', - 'description' => 'The SSL setting of the OceanBase cluster instance.', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'EnableSSL' => [ - 'description' => 'The operation to modify the SSL status. Valid values:'."\n" - ."\n" - .'- open: Enable SSL encryption.'."\n" - ."\n" - .'- update: Update the CA certificate.'."\n" - ."\n" - .'- close: Disable SSL encryption.', - 'type' => 'string', - 'example' => 'open', - ], - 'TenantId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"open\\",\\n \\"TenantId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'ModifyInstanceSSL', - 'description' => 'There is currently no authorization information disclosed in the API.', - ], - 'DescribeInstanceSSL' => [ - 'summary' => '查询集群SSL配置', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'OceanBase租户ID', - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C', - ], - 'InstanceSSL' => [ - 'description' => 'The SSL setting of the OceanBase cluster instance.', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'EnableSSL' => [ - 'description' => 'The operation to modify the SSL status. Valid values:'."\n" - ."\n" - .'- open: Enable SSL encryption.'."\n" - ."\n" - .'- update: Update the CA certificate.'."\n" - ."\n" - .'- close: Disable SSL encryption.', - 'type' => 'string', - 'example' => 'OPEN', - ], - 'ValidPeriod' => [ - 'description' => 'The validity period of the SSL certificate.', - 'type' => 'string', - 'example' => '2024-09-20 07:55:03.0', - ], - 'CaUrl' => [ - 'description' => 'The URL of the certificate authority (CA) node.', - 'type' => 'string', - 'example' => 'https://xxxx', - ], - 'Status' => [ - 'description' => 'The SSL status of the cluster.', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ForceSSLSupport' => [ - 'title' => '是否支持强制开启SSL', - 'description' => 'Indicates whether SSL can be forcibly enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ForceSSL' => [ - 'title' => '强制开启状态', - 'description' => 'The forced enabling status of SSL.', - 'type' => 'string', - 'example' => 'CLOSE', - 'enum' => [ - 'CLOSE', - 'OPEN', - ], - ], - 'AutoUpdate' => [ - 'description' => 'The status of automatic update of SSL certificates. Valid values: '."\n" - .'* CLOSE: The automatic update of SSL certificates is disabled. '."\n" - .'* OPEN: The automatic update of SSL certificates is enabled.', - 'type' => 'string', - 'enumValueTitles' => [ - 'CLOSE' => 'CLOSE', - 'OPEN' => 'OPEN', - ], - 'example' => 'OPEN', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'CertValid' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"OPEN\\",\\n \\"ValidPeriod\\": \\"2024-09-20 07:55:03.0\\",\\n \\"CaUrl\\": \\"https://xxxx\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ForceSSLSupport\\": false,\\n \\"ForceSSL\\": \\"CLOSE\\",\\n \\"AutoUpdate\\": \\"OPEN\\",\\n \\"TenantId\\": \\"\\",\\n \\"CertValid\\": true\\n }\\n}","type":"json"}]', - 'title' => 'DescribeInstanceSSL', - ], - 'CreateSecurityIpGroup' => [ - 'summary' => 'You can call this operation to create an IP address whitelist group. ', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'SecurityIps', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', - 'description' => 'The return result of the request. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"192.168.1.1","192.168.0.0.1/8"}', - ], - ], - [ - 'name' => 'SecurityIpGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The name of the whitelist group. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pay_online', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The ID of the region. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The IP addresses or CIDR blocks in the IP address whitelist group. '."\n" - .'The return values of SecurityIps are strings that are separated with commas (,). ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => '白名单分组信息。', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **CreateSecurityIpGroup**. ', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=CreateSecurityIpGroup'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&SecurityIps=192.168.1.1,192.168.0.0.1/8'."\n" - .'&SecurityIpGroupName=pay_online'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'SecurityIpGroupName' => [ - 'title' => '白名单分组名称。', - 'description' => 'You can call this operation to create an IP address whitelist group. ', - 'type' => 'string', - 'example' => 'pay_online', - ], - 'SecurityIps' => [ - 'title' => 'IP白名单分组中的IP地址或地址段。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', - 'description' => '', - 'type' => 'string', - 'example' => '192.168.1.1,192.168.0.0.1/8', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"pay_online\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n ob317v4uif****\\n pay_online\\n 192.168.1.1,192.168.0.0.1/8\\n \\n","errorExample":""}]', - 'title' => 'CreateSecurityIpGroup', - ], - 'DescribeSecurityIpGroups' => [ - 'summary' => 'You can call this operation to view the list of IP address whitelist groups. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-bp67acfmxazb4p****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" - .'It is a JSON array. Each object in the array is an IP address or CIDR block. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TotalCount' => [ - 'title' => '查询到的白名单分组个数。', - 'description' => 'Example 1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'SecurityIpGroups' => [ - 'title' => 'IP白名单分组信息。', - 'description' => ' ', - 'type' => 'array', - 'items' => [ - 'description' => 'You can call this operation to view the list of IP address whitelist groups. ', - 'type' => 'object', - 'properties' => [ - 'SecurityIps' => [ - 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', - 'description' => '', - 'type' => 'string', - 'example' => '121.41.106.33,100.104.7.0/26', - ], - 'SecurityIpGroupName' => [ - 'title' => '安全组名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'online_paycore', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIps\\": \\"127.*.*.1\\",\\n \\"SecurityIpGroupName\\": \\"default\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n 2\\n \\n 121.41.106.33,100.104.7.0/26\\n online_paycore\\n \\n","errorExample":""}]', - 'title' => 'DescribeSecurityIpGroups', - ], - 'DescribeTenantSecurityConfigs' => [ - 'summary' => 'You can call this operation to query security check items of an OceanBase Database tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户Id', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'CheckId', - 'in' => 'formData', - 'schema' => [ - 'title' => '安全检测的唯一标识', - 'description' => 'The unique identifier of the security check.', - 'type' => 'string', - 'required' => false, - 'example' => '****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '523E7183-****-590D-****-12DFD316614B', - ], - 'Configs' => [ - 'description' => 'The list of parameters.', - 'type' => 'object', - 'properties' => [ - 'TotalCheckCount' => [ - 'title' => '安全配置总体检测项目', - 'description' => 'The total number of security check items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'TotalRiskCount' => [ - 'title' => '检测出来的总体风险项目', - 'description' => 'The total number of detected security risks.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TenantSecurityConfigs' => [ - 'title' => '检测结果', - 'description' => 'The check result.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the tenant.', - 'type' => 'object', - 'properties' => [ - 'TenantId' => [ - 'title' => '租户Id', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'TenantName' => [ - 'title' => '租户名称', - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'RiskCount' => [ - 'title' => '租户的风险条目', - 'description' => 'The number of detected tenant security risks.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SecurityConfigs' => [ - 'title' => '风险列表', - 'description' => 'The list of risks.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of risks.', - 'type' => 'object', - 'properties' => [ - 'ConfigGroup' => [ - 'title' => '风险分组', - 'description' => 'The group of the risk.', - 'type' => 'string', - 'example' => 'WHITELIST', - ], - 'ConfigName' => [ - 'title' => '风险项目名称', - 'description' => 'The name of the risk.', - 'type' => 'string', - 'example' => 'WHITELIST_RANGE_LARGE', - ], - 'Risk' => [ - 'title' => '是否有风险', - 'description' => 'Indicates whether the risk causes security issues.', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'false', - ], - 'RiskDescription' => [ - 'title' => '风险描述', - 'description' => 'The description of the risk.', - 'type' => 'string', - 'example' => 'The scope of the allowlist is too big.', - ], - 'ConfigDescription' => [ - 'title' => '检测项名称', - 'description' => 'The name of the check item.', - 'type' => 'string', - 'example' => 'Check whether the scope of the cluster allowlist is too big', - ], - ], - ], - ], - ], - ], - ], - 'CheckId' => [ - 'title' => '检测的唯一标识', - 'description' => 'The unique identifier of the check.', - 'type' => 'string', - 'example' => ' xxx', - ], - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'CheckTime' => [ - 'title' => '检测时间', - 'description' => 'The time when the check was performed.', - 'type' => 'string', - 'example' => '2023-08-07 15:30:00', - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"523E7183-1490-590D-BA03-12DFD316614B\\",\\n \\"Configs\\": {\\n \\"TotalCheckCount\\": 4,\\n \\"TotalRiskCount\\": 0,\\n \\"TenantSecurityConfigs\\": [\\n {\\n \\"TenantId\\": \\"xxx\\",\\n \\"TenantName\\": \\"xxx\\",\\n \\"RiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigName\\": \\"WHITELIST_RANGE_LARGE\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"白名单开放过大，建议按需设置\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ]\\n }\\n ],\\n \\"CheckId\\": \\" xxx\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeTenantSecurityConfigs', - ], - 'DescribeTenantEncryption' => [ - 'summary' => 'You can call this operation to query the encryption information of a tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => false, - 'example' => 't4louaeei****', - ], - ], - [ - 'name' => 'TenantName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the tenant. '."\n" - .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', - 'type' => 'string', - 'required' => false, - 'example' => 'forMySQLTenant', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - .'- Pages start from page 1.'."\n" - .'- Default value: 1.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned. This parameter takes effect in a pagination query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'TenantEncryptions' => [ - 'description' => 'The scenarios supporting encryption.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about scenarios supporting encryption.', - 'type' => 'object', - 'properties' => [ - 'TenantId' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 't4louaeei****', - ], - 'TenantMode' => [ - 'description' => 'The compatible mode of the tenant. Valid values: '."\n" - .'* Oracle '."\n" - .'* MySQL', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'TenantName' => [ - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'forMySQLTenant', - ], - 'EnableEncryption' => [ - 'description' => 'Indicates whether encryption is enabled. Valid values: '."\n" - .'* true '."\n" - .'* false', - 'type' => 'boolean', - 'example' => 'false', - ], - 'TenantStatus' => [ - 'description' => 'The status of the tenant.', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'Status' => [ - 'description' => 'The status of tenant encryption enablement.', - 'type' => 'string', - 'example' => 'OPEN', - ], - 'EncryptionType' => [ - 'title' => '加密的类型', - 'description' => 'The encryption type.', - 'type' => 'string', - 'example' => 'INTERNAL', - ], - 'EncryptionKeyId' => [ - 'title' => 'xxx', - 'description' => 'The ID of the encryption key created by Key Management Service (KMS).', - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 8,\\n \\"TenantEncryptions\\": [\\n {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"EnableEncryption\\": false,\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"Status\\": \\"OPEN\\",\\n \\"EncryptionType\\": \\"INTERNAL\\",\\n \\"EncryptionKeyId\\": \\"xxx\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeTenantEncryption', - ], - 'DescribeInstanceSecurityConfigs' => [ - 'summary' => 'You can call this operation to query security check items of an OceanBase cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'CheckId', - 'in' => 'formData', - 'schema' => [ - 'title' => '检测的唯一标识', - 'description' => 'The unique identifier of the check.', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'InstanceSecurityConfigs' => [ - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'TotalCheckCount' => [ - 'title' => '集群安全项检测总数', - 'description' => 'The total number of security check items for the cluster.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TotalRiskCount' => [ - 'title' => '集群安全项风险总数', - 'description' => 'The total number of detected cluster security risks.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SecurityConfigs' => [ - 'title' => '检测项目列表', - 'description' => 'The list of check items.', - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the specific check item.', - 'type' => 'object', - 'properties' => [ - 'ConfigName' => [ - 'title' => '具体检测项名称', - 'description' => 'The name of the specific check item.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'Risk' => [ - 'title' => '是否存在风险', - 'description' => 'Specifies whether a risk is detected.', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RiskDescription' => [ - 'title' => '安全建议', - 'description' => 'Security recommendations.', - 'type' => 'string', - 'example' => 'xxx', - ], - 'ConfigGroup' => [ - 'title' => '检测分组', - 'description' => 'The group of the check.', - 'type' => 'string', - 'example' => 'WHITELIST', - ], - 'ConfigDescription' => [ - 'title' => '检测项名称', - 'description' => 'The name of the check item.', - 'type' => 'string', - 'example' => 'Check whether the scope of the cluster allowlist is too big', - ], - ], - ], - ], - 'CheckTime' => [ - 'title' => '2023-08-07 15:30:00', - 'description' => 'The time when the check was performed.', - 'type' => 'string', - 'example' => '2023-08-07 15:30:00', - ], - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'CheckId' => [ - 'title' => '检测的唯一标识', - 'description' => 'The unique identifier of the check.', - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSecurityConfigs\\": {\\n \\"TotalCheckCount\\": 5,\\n \\"TotalRiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigName\\": \\"xxx\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"xxx\\",\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ],\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckId\\": \\"xxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeInstanceSecurityConfigs', - ], - 'ModifySecurityIps' => [ - 'summary' => 'You can call this operation to modify the IP address list in a group. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'SecurityIps', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', - 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" - .'It is a JSON array. Each object in the array is an IP address or CIDR block. You can specify at most 40 IP addresses or CIDR blocks. ', - 'type' => 'string', - 'required' => false, - 'example' => '["192.168.0.0/20","192.169.1.1"]', - ], - ], - [ - 'name' => 'SecurityIpGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The information of the IP address whitelist group. ', - 'type' => 'string', - 'required' => false, - 'example' => 'paytest', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The name of the security group. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => 'IP白名单分组信息。', - 'description' => 'Example 1', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'SecurityIpGroupName' => [ - 'title' => '安全组名称。', - 'description' => ' ', - 'type' => 'string', - 'example' => 'online_paycore', - ], - 'SecurityIps' => [ - 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', - 'description' => '', - 'type' => 'string', - 'example' => '121.41.106.33,100.104.7.0/26', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"online_paycore\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.2\\\\\\",\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n ob317v4uif****\\n online_paycore\\n 121.41.106.33,100.104.7.0/26\\n \\n","errorExample":""}]', - 'title' => 'ModifySecurityIps', - ], - 'ModifyTenantEncryption' => [ - 'summary' => 'You can call this operation to enable transparent encryption for a tenant.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob2mr3oae0****', - ], - ], - [ - 'name' => 'EncryptionType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The encryption type. Valid values: '."\n" - .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" - .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" - .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'INTERNAL' => 'INTERNAL', - 'USER_KMS' => 'USER_KMS', - ], - 'example' => 'INTERNAL', - ], - ], - [ - 'name' => 'EncryptionKeyId', - 'in' => 'formData', - 'schema' => [ - 'title' => '加密使用的key', - 'description' => 'The ID of the key.', - 'type' => 'string', - 'required' => false, - 'example' => 'key-shh322****470h8v0-g2ll85****', - ], - ], - ], - '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' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'TenantEncryption' => [ - 'title' => 'job', - 'description' => 'job', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 'ob2mr3oae0****', - ], - 'EncryptionType' => [ - 'description' => 'The encryption type. Valid values: '."\n" - .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" - .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" - .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', - 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNAL' => 'INTERNAL', - 'USER_KMS' => 'USER_KMS', - ], - 'example' => 'INTERNAL', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantEncryption\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"ob2mr3oae0****\\",\\n \\"EncryptionType\\": \\"INTERNAL\\"\\n }\\n}","type":"json"}]', - 'title' => 'ModifyTenantEncryption', - ], - 'DeleteSecurityIpGroup' => [ - 'summary' => 'You can call this operation to delete an IP address whitelist group of an OceanBase cluster. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The name of the IP address whitelist group. '."\n" - .'It must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters, digits, and underscores (_). ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'SecurityIpGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', - 'description' => 'The information of the deleted IP whitelist group. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'paytest', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果。', - 'description' => 'The request ID. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'Example 1', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'SecurityIpGroup' => [ - 'title' => '删除的IP白名单分组信息。', - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'SecurityIpGroupName' => [ - 'title' => '删除的IP安全白名单组的组名。', - 'description' => '', - 'type' => 'string', - 'example' => 'paytest', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n ob317v4uif****\\n paytest\\n \\n","errorExample":""}]', - 'title' => ' DeleteSecurityIpGroup', - ], - 'DescribeBackupEncryptedString' => [ - 'summary' => 'DescribeBackupEncryptedString', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob4wib********', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户id', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'example' => 'txxxxxxx', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The return data of the request.', - 'type' => 'object', - 'properties' => [ - 'BackupInfoJson' => [ - 'description' => 'Information about the overall encrypted backup data.', - 'type' => 'string', - 'example' => 'xxxxxxxx (encrypted string)', - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"BackupInfoJson\\": \\"xxxxxxxx（加密串）\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeBackupEncryptedString', - ], - 'DescribeMetricsDataV2' => [ - 'summary' => 'You can call this operation to return metric data.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群实例Id', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'Metrics', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控指标名称', - 'description' => 'The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt...".', - 'type' => 'string', - 'required' => true, - 'example' => 'sql_all_rt', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间 YYYY-MM-DDThh:mm:ssZ', - 'description' => 'The start time, in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-12T04:38:38Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间 YYYY-MM-DDThh:mm:ssZ', - 'description' => 'The end time, in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-12T05:38:38Z', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据查询条件标签', - 'description' => 'A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\\:). Multiple values of a key are separated with semicolons (\\;). Example: "clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*;t\\*\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j". The string can contain only the following fixed keys: '."\n" - .'* clusterId: the ID of the OceanBase cluster. '."\n" - .'* tenantId: the ID of the OceanBase Database tenant. '."\n" - .'* zoneId: the ID of the zone.'."\n" - .' * serverId: the ID of the OBServer node.', - 'type' => 'string', - 'required' => true, - 'example' => 'clusterId:ob***', - ], - ], - [ - 'name' => 'GroupByLabels', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据分组标签', - 'description' => 'The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "clusterId,tenantId".', - 'type' => 'string', - 'required' => true, - 'example' => 'clusterId', - ], - ], - [ - 'name' => 'SortMetricKey', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SortMetricKey', - 'description' => 'The sort column.', - 'type' => 'string', - 'required' => false, - 'example' => 'tps', - ], - ], - [ - 'name' => 'SortOrder', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序顺序', - 'description' => 'The sorting rule. Valid values: '."\n" - .'* ASC: in ascending order '."\n" - .'* DESC: in descending order', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'Limit', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序后返回的 Data 数组长度', - 'description' => 'The length of the data array returned after sorting.', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'ReplicaType', - 'in' => 'formData', - 'schema' => [ - 'title' => '副本类型', - 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" - .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" - .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried.'."\n" - .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'FULL', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'title' => '数据集合', - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'Labels' => [ - 'title' => '数据标签', - 'description' => 'The data label.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'clusterId:ob********', - 'description' => 'The details of the label.', - ], - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.', - 'type' => 'object', - 'properties' => [ - 'MetricValue' => [ - 'title' => '监控指标数据', - 'description' => 'The metric data.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '\'load1\': 1.29', - 'description' => 'The metric data.', - ], - ], - 'Timestamp' => [ - 'title' => '时间戳', - 'description' => 'The timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1702434300', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Labels\\": {\\n \\"key\\": \\"clusterId:ob********\\"\\n },\\n \\"Data\\": [\\n {\\n \\"MetricValue\\": {\\n \\"key\\": \\"\'load1\': 1.29\\"\\n },\\n \\"Timestamp\\": 1702434300\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeMetricsDataV2', - ], - 'DescribeMetricsData' => [ - 'summary' => 'You can call this operation to query single-dimensional or multi-dimensional metric data of an OceanBase cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '集群 id', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询监控指标数据的起始时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => 'The start time for querying metric data. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2021-06-13T15:40:43Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询监控指标数据的结束时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => 'The end time for querying metric data. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2021-06-13T15:40:43Z', - ], - ], - [ - 'name' => 'Metrics', - 'in' => 'query', - 'schema' => [ - 'title' => '监控指标', - 'description' => 'The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt...".', - 'type' => 'string', - 'required' => true, - 'example' => 'tps', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => 'A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\\:). Example: "app:OB,clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j". The string can contain only the following fixed keys: * app: the application type. At present, only OceanBase Database is supported. * clusterId: the ID of the OceanBase cluster. * tenantId: the ID of the OceanBase Database tenant. * zoneId: the ID of the zone. * serverId: the ID of the OBServer node. | app:OB,clusterId:ob\\*\\*\\*', - 'type' => 'string', - 'required' => true, - 'example' => 'app:OB,clusterId:ob***', - ], - ], - [ - 'name' => 'GroupByLabels', - 'in' => 'query', - 'schema' => [ - 'description' => 'The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "app,clusterId,tenantId".', - 'type' => 'string', - 'required' => true, - 'example' => 'app,clusterId', - ], - ], - [ - 'name' => 'SortMetricKey', - 'in' => 'query', - 'schema' => [ - 'title' => '排序列', - 'description' => 'The sort column.', - 'type' => 'string', - 'required' => false, - 'example' => 'tps', - ], - ], - [ - 'name' => 'SortOrder', - 'in' => 'query', - 'schema' => [ - 'title' => '排序规则', - 'description' => 'The sorting rule. Valid values: '."\n" - .'* ASC: in ascending order '."\n" - .'* DESC: in descending order', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'Limit', - 'in' => 'query', - 'schema' => [ - 'title' => '排序后返回的Data 数组长度', - 'description' => 'The length of the data array returned after sorting.', - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], - ], - [ - 'name' => 'ReplicaType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" - .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" - .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried. '."\n" - .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'FULL', - 'enum' => [ - 'FULL', - 'READONLY', - ], - ], - ], - [ - 'name' => 'MetricScope', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The dimensions of the performance metric.', - 'example' => 'cluster', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]', - ], - 'example' => '['."\n" - .' {'."\n" - .' "sql_select_count":75.****15****1515,'."\n" - .' "timestamp":165079****'."\n" - .' },'."\n" - .' ......'."\n" - .' ]', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n \\"[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]\\"\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeMetricsData', - ], - 'DescribeNodeMetrics' => [ - 'summary' => 'You can call this operation to query the detailed metrics information of an OceanBase Database node. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The list of nodes. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The ID of the tenant. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => '$.parameters[6].schema.description', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。', - 'description' => '$.parameters[6].schema.enumValueTitles', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'tfafd34fs****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => '$.parameters[9].schema.example', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据的结束时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => '$.parameters[7].schema.description', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13T15:40:43Z', - ], - ], - [ - 'name' => 'Metrics', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控指标项。当前可支持的指标及说明可参考：https://help.aliyun.com/document_detail/212099.html。', - 'description' => '$.parameters[7].schema.enumValueTitles', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tps', - ], - ], - [ - 'name' => 'NodeName', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点名称', - 'description' => '$.parameters[8].schema.example', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp16niirq4zdmgvm****', - ], - ], - [ - 'name' => 'NodeIdList', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点列表', - 'description' => '$.parameters[10].schema.description', - 'type' => 'string', - 'required' => false, - 'example' => '[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '$.parameters[10].schema.enumValueTitles', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => '总数量', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeNodeMetrics'."\n" - .'&InstanceId=ob317v4uif****'."\n" - .'&PageSize=10'."\n" - .'&PageNumber=1'."\n" - .'&TenantId=ob2mr3oae0****'."\n" - .'&StartTime=2021-06-13 15:40:43'."\n" - .'&EndTime=2021-09-13 15:40:43'."\n" - .'&Metrics=tps'."\n" - .'&NodeName=i-bp16niirq4zdmgvm****'."\n" - .'&NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"]'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'You can call this operation to query the detailed metrics information of an OceanBase Database node. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'NodeMetrics' => [ - 'title' => '节点指标信息', - 'description' => '', - 'type' => 'string', - 'example' => '-', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"NodeMetrics\\": \\"-\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n -\\n","errorExample":""}]', - 'title' => 'DescribeNodeMetrics', - ], - 'DescribeTenantMetrics' => [ - 'summary' => 'You can call this operation to query the metrics of a specified OceanBase Database tenant. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => '2021-06-13T15:40:43Z', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'tfafd34fs****', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'TenantName', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。TenantName、TenantId、TenantList至少填一项', - 'description' => '2021-06-13T15:45:43Z', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'pay_online', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => 'Example 1', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据的结束时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', - 'description' => ' ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:45:43Z', - ], - ], - [ - 'name' => 'Metrics', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控指标。当前可支持的指标及说明参考：https://help.aliyun.com/document_detail/212125.html', - 'description' => '{"name":"DescribeTenantMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeTenantMetrics\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"ob317v4uif****\\"},{\\"name\\":\\"PageSize\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"10\\"},{\\"name\\":\\"PageNumber\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"1\\"},{\\"name\\":\\"TenantName\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"pay_online\\"},{\\"name\\":\\"StartTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:40:43Z\\"},{\\"name\\":\\"EndTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:45:43Z\\"},{\\"name\\":\\"Metrics\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tps\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tfafd34fs****\\"},{\\"name\\":\\"TenantIdList\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"[tdak3nac****,tdakc42df****]\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"TotalCount\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"9\\"},{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"TenantMetrics\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tps', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID。TenantName、TenantId、TenantList至少填一项', - 'description' => '', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'tfafd34fs****', - ], - ], - [ - 'name' => 'TenantIdList', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户 ID 列表，入参为JSONArray格式，需要使用双引号和方括号。'."\n" - .'TenantName、TenantId、TenantList至少填一项，', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[tdak3nac****,tdakc42df****]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => '总数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'TenantMetrics' => [ - 'title' => '租户指标信息。', - 'description' => '', - 'type' => 'string', - 'example' => '"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantMetrics\\": \\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n -\\n","errorExample":""}]', - 'title' => 'DescribeTenantMetrics', - ], - 'CreateProject' => [ - 'summary' => '创建项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'UseOss', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否使用OSS方式创建', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'OssKey', - 'in' => 'formData', - 'schema' => [ - 'title' => '通过 GetUploadOssUrl 获取的 Osskey', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'open_api_create_project/oacp_xxx', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目 ID', - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '任务名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '任务类型（MIGRATION 迁移任务、SYNC 同步任务）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MIGRATION', - 'enum' => [ - 'MIGRATION', - 'SYNC', - ], - ], - ], - [ - 'name' => 'LabelIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID。最多支持5个', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'I_dfe****', - ], - 'required' => false, - ], - ], - [ - 'name' => 'WorkerGradeId', - 'in' => 'formData', - 'schema' => [ - 'title' => '传输实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'g_abcdefj***', - ], - ], - [ - 'name' => 'SourceEndpointId', - 'in' => 'formData', - 'schema' => [ - 'title' => '源端数据源ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e_4j0c12z****', - ], - ], - [ - 'name' => 'SinkEndpointId', - 'in' => 'formData', - 'schema' => [ - 'title' => '目标端数据源ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e_4j0cz****', - ], - ], - [ - 'name' => 'TransferMapping', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '传输对象映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SPCEIFIC', - 'enum' => [ - 'SPECIFIC', - 'WILDCARD', - ], - ], - 'Databases' => [ - 'title' => '数据库信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '库ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gez3***', - ], - 'Name' => [ - 'title' => '数据库名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db_name', - ], - 'MappedName' => [ - 'title' => '数据库映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_db', - ], - 'ClusterName' => [ - 'title' => '映射对象集群（已废弃）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster_name', - ], - 'TenantName' => [ - 'title' => '映射对象租户（已废弃）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tenant_name', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_4l085bu7***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id > 1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk_col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - 'ObkvPartitionConfig' => [ - 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', - 'type' => 'object', - 'properties' => [ - 'PartitionType' => [ - 'type' => 'string', - 'enum' => [ - 'KEY', - 'RANGE', - 'NONE', - ], - ], - 'VirtualColumn' => [ - 'type' => 'string', - ], - 'PartitionSize' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1024', - 'minimum' => '1', - ], - ], - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_name', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_4himpq4z***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id>1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk_col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_4azdil4lu7***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<5', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk_col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_name', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_3wsmjv49a***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<5', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk_col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'DatabasesBlack' => [ - 'title' => '匹配规则模式：数据库对象黑名单', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_3y6v5v1x94f4', - ], - 'Name' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db_name', - ], - 'MappedName' => [ - 'title' => '映射库名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_db', - ], - 'ClusterName' => [ - 'title' => '映射对象集群（已废弃）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster_name', - ], - 'TenantName' => [ - 'title' => '映射对象租户（已废弃）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tenant_name', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_474hmh5iqo***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_name', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_view', - ], - 'Id' => [ - 'title' => '视图ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_4azdil4lu7mo', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<5', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk_col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'Id' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_4himpq4zf***', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'title' => '视图ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e_474hmh5iqo***', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TableAndViewWhiteList' => [ - 'title' => '匹配规则模式：表、视图的通配白名单', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'required' => false, - ], - 'TableAndViewBlackList' => [ - 'title' => '匹配规则模式：表、视图的通配黑名单', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'CommonTransferConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '通用传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableCategory' => [ - 'title' => '支持的表类型（ALL 所有表、WITH_UNIQUE_ROW_ID 有唯一行标识的表、WITHOUT_UNIQUE_ROW_ID 没有唯一行标识的表），默认 ALL', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - 'default' => 'ALL', - 'enum' => [ - 'ALL', - 'WITHOUT_UNIQUE_ROW_ID', - 'WITH_UNIQUE_ROW_ID', - ], - ], - 'ActiveActive' => [ - 'title' => '是否双活容灾场景', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'MqSerializerType' => [ - 'title' => '投递到消息队列时，数据 json 序列化类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - 'MqPartitionMode' => [ - 'title' => '投递到消息队列时，分区路由方式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ONE', - ], - 'MqPartition' => [ - 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'DatahubTopicType' => [ - 'title' => '投递到消息队列（DATAHUB）时，指定 topic 的类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'BLOB' => 'BLOB', - 'TUPLE' => 'TUPLE', - ], - 'example' => 'TUPLE', - ], - 'RocketMqProducerGroup' => [ - 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OMS', - ], - 'RocketMqMsgTags' => [ - 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default_tag', - ], - 'RocketMqEnableMsgTrace' => [ - 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'RocketMqSendMsgTimeout' => [ - 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'null', - ], - 'DataWorksBusinessName' => [ - 'title' => '业务系统标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'SyncSchema' => [ - 'title' => '是否同步源端数据所在的 schema 到目标端（预期目标端表上会创建一个附加字段，用来接收 schema 名称，该字段见 syncSchemaColumnName 参数）', - 'type' => 'boolean', - ], - 'SyncSchemaColumnName' => [ - 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', - 'type' => 'string', - ], - 'CustomColumns' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名称', - 'type' => 'string', - ], - 'Expression' => [ - 'title' => '列值表达式', - 'type' => 'string', - ], - ], - ], - ], - 'SinkStoreFormat' => [ - 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', - 'type' => 'string', - ], - 'SourceStoreFormat' => [ - 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', - 'type' => 'string', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableStructTransfer', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否允许结构传输', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'StructTransferConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '结构传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ByteCharConvertStrategy' => [ - 'title' => 'byte/char 转换方案，默认 DO_NOTHING_IF_BYTE_USED', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DO_NOTHING_IF_BYTE_USED', - 'default' => 'DO_NOTHING_IF_BYTE_USED', - 'enum' => [ - 'IGNORE_BYTE_IF_BYTE_USED', - 'FORCE_CHAR_IF_BYTE_USED', - 'EXPAND_LEN_IF_BYTE_USED', - 'DO_NOTHING_IF_BYTE_USED', - ], - ], - 'DeferIndexCreation' => [ - 'title' => '是否允许索引后置', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableFullTransfer', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否允许全量传输', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableFullVerify', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否允许全量校验', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'FullTransferConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '全量传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NonePkUkTruncateDstTable' => [ - 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true。'."\n" - .'目前场景：PolarDB-X 1.0 多链路无主键表汇聚到同一目标端表，避免前若干条链路前有部分数据后，另一链路刚启动就清空了历史的迁移数据', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AllowDestTableNotEmpty' => [ - 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开。'."\n" - .'注意：只有在没有选中"全量校验"的情况下，才允许打开此开关。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'FullTransferSpeedMode' => [ - 'title' => '全量传输速度', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - 'default' => 'NORMAL', - 'enum' => [ - 'STEADY', - 'NORMAL', - 'FAST', - ], - ], - 'FullVerifySpeedMode' => [ - 'title' => '全量校验速度', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - 'default' => 'NORMAL', - 'enum' => [ - 'STEADY', - 'NORMAL', - 'FAST', - ], - ], - 'WriteWorkerNum' => [ - 'title' => '写入并发数 null 未配置', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ReadWorkerNum' => [ - 'title' => '读取并发数 null 未配置', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'HbaseObjCheckMode' => [ - 'title' => 'hbase 对象校验模式: NEWEST, ALL', - 'type' => 'string', - 'enum' => [ - 'ALL', - 'NEWEST', - ], - ], - 'HbaseObjMigMode' => [ - 'title' => 'hbase 对象迁移模式: NEWEST, ALL', - 'type' => 'string', - 'enum' => [ - 'ALL', - 'NEWEST', - ], - ], - 'IndexDDLConcurrencyLimit' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'MaxConcurrentIndexDDLs' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableIncrTransfer', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否允许增量传输', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableReverseIncrTransfer', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否允许反向增量', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IncrTransferConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '增量传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartTimestamp' => [ - 'title' => '增量同步位点', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1689201369', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - 'enum' => [ - 'HEARTBEAT', - 'INSERT', - 'UPDATE', - 'DELETE', - 'BEGIN', - 'COMMIT', - 'ROLLBACK', - 'DDL', - 'ROW', - ], - ], - 'required' => false, - ], - 'StoreLogKeptHour' => [ - 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'EnableSequencingWithinTxn' => [ - 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IncrSyncConcurrency' => [ - 'title' => '增量同步线程数，默认64', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1024', - 'minimum' => '1', - 'example' => '64', - 'default' => '64', - ], - 'EnableIncrSyncStatistics' => [ - 'title' => '是否开启增量记录(dml、ddl)统计', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SupportDDLTypes' => [ - 'title' => '支持DDL类型', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'CREATE_TABLE', - 'enum' => [ - 'CREATE_TABLE', - 'ALTER_TABLE', - 'DROP_TABLE', - 'RENAME_TABLE', - 'TRUNCATE_TABLE', - 'CREATE_INDEX', - 'DROP_INDEX', - ], - ], - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'ReverseIncrTransferConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '反向增量传输配置', - 'type' => 'object', - 'properties' => [ - 'StartTimestamp' => [ - 'title' => '反向增量同步位点', - 'type' => 'string', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有反向增量同步阶段时，同步的增量数据类型', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'INSERT', - 'enum' => [ - 'HEARTBEAT', - 'INSERT', - 'UPDATE', - 'DELETE', - 'BEGIN', - 'COMMIT', - 'ROLLBACK', - 'DDL', - 'ROW', - 'PUT', - ], - ], - ], - 'StoreLogKeptHour' => [ - 'title' => '有反向增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', - 'type' => 'integer', - 'format' => 'int32', - ], - 'EnableSequencingWithinTxn' => [ - 'title' => '有反向增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', - 'type' => 'boolean', - ], - 'IncrSyncConcurrency' => [ - 'title' => '反向增量同步线程数，默认64', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1024', - 'minimum' => '1', - 'default' => '64', - ], - 'EnableIncrSyncStatistics' => [ - 'title' => '是否开启反向增量记录(dml、ddl)统计', - 'type' => 'boolean', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SupportDDLTypes' => [ - 'title' => '支持DDL类型', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'CREATE_TABLE', - 'enum' => [ - 'CREATE_TABLE', - 'ALTER_TABLE', - 'DROP_TABLE', - 'RENAME_TABLE', - 'TRUNCATE_TABLE', - 'CREATE_INDEX', - 'DROP_INDEX', - ], - ], - ], - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'XCVSADG****DSGDS', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '27', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'string', - 'example' => 'np_****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27\\",\\n \\"Data\\": \\"np_****\\"\\n}","type":"json"}]', - ], - 'StartProject' => [ - 'summary' => '启动项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'XCVSADG****DSGDS'."\n", - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100'."\n", - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\\\n\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'StopProject' => [ - 'summary' => '暂停项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => '473469**-AA6F-4D**-B3DB-A***********', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '27 ms', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27 ms\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'ResumeProject' => [ - 'summary' => '恢复项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'ReleaseProject' => [ - 'summary' => '释放项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.'."\n", - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\\\n\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'DeleteProject' => [ - 'summary' => '删除项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-XXXX-XXX-B3DB-A3DC0DE', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXX-B3DB-A3DC0DE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'ListProjects' => [ - 'summary' => '查询项目列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'SearchKey', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目名称或项目ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'np_4w****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目类型（MIGRATION,SYNC）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MIGRATION', - 'enum' => [ - 'MIGRATION', - 'SYNC', - ], - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '项目状态（INIT,RUNNING,SUSPEND,FAILED,FINISHED,RELEASING,RELEASED,DELETED,RUNNING_MODIFYING,RUNNING_MERGING,RUNNING_ALARMING,UNCONFIGURED）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - 'enum' => [ - 'INIT', - 'RUNNING', - 'SUSPEND', - 'FAILED', - 'FINISHED', - 'RELEASING', - 'RELEASED', - 'DELETED', - 'RUNNING_MODIFYING', - 'RUNNING_MERGING', - 'RUNNING_ALARMING', - ], - ], - 'required' => false, - 'enumValueTitles' => [], - ], - ], - [ - 'name' => 'LabelIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '标签ID集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'l_dfe****'."\n", - ], - 'required' => false, - ], - ], - [ - 'name' => 'SourceEndpointTypes', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '源端数据源类型（MYSQL,MARIADB,OB_MYSQL,OB_MYSQL_CE,OB_ORACLE,ORACLE,DB2_LUW,KAFKA,ROCKETMQ,DATAHUB,ADB,DBP_OP_ROUTE,DMS,IDB,TIDB,POSTGRESQL,POLARDB_X_1,POLARDB_X_2）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'POLARDB_X_1' => 'POLARDB_X_1', - 'MYSQL' => 'MYSQL', - 'TIDB' => 'TIDB', - 'OB_ORACLE' => 'OB_ORACLE', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'POLARDB_X_2' => 'POLARDB_X_2', - ], - 'example' => 'MYSQL', - 'enum' => [ - 'MYSQL', - 'MARIADB', - 'OB_MYSQL', - 'OB_MYSQL_CE', - 'OB_ORACLE', - 'ORACLE', - 'DB2_LUW', - 'KAFKA', - 'ROCKETMQ', - 'DATAHUB', - 'ADB', - 'DBP_OP_ROUTE', - 'DMS', - 'IDB', - 'TIDB', - 'POSTGRESQL', - 'POLARDB_X_1', - 'POLARDB_X_2', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'SinkEndpointTypes', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '目标端数据源类型（MYSQL,MARIADB,OB_MYSQL,OB_MYSQL_CE,OB_ORACLE,ORACLE,DB2_LUW,KAFKA,ROCKETMQ,DATAHUB,ADB,DBP_OP_ROUTE,DMS,IDB,TIDB,POSTGRESQL,POLARDB_X_1,POLARDB_X_2）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MYSQL' => 'MYSQL', - 'OB_ORACLE' => 'OB_ORACLE', - 'KAFKA' => 'KAFKA', - 'ROCKETMQ' => 'ROCKETMQ', - 'DATAHUB' => 'DATAHUB', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'ADB' => 'ADB', - ], - 'example' => 'MYSQL', - 'enum' => [ - 'MYSQL', - 'MARIADB', - 'OB_MYSQL', - 'OB_MYSQL_CE', - 'OB_ORACLE', - 'ORACLE', - 'DB2_LUW', - 'KAFKA', - 'ROCKETMQ', - 'DATAHUB', - 'ADB', - 'DBP_OP_ROUTE', - 'DMS', - 'IDB', - 'TIDB', - 'POSTGRESQL', - 'POLARDB_X_1', - 'POLARDB_X_2', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'VisibleSubProject', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否展示子项目，默认不展示 ', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'SortField', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序字段（gmtCreate、gmtModified）,默认 gmtCreate', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gmtCreate', - ], - ], - [ - 'name' => 'Order', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序顺序（asc：升序 descend:降序），默认降序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'descend', - 'default' => 'descend', - 'enum' => [ - 'asc', - 'descend', - ], - ], - ], - [ - 'name' => 'NeedRelatedInfo', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否需要查询项目关联信息，默认true（数据源连接信息、传输实例信息、项目步骤信息等）', - 'type' => 'boolean', - 'default' => 'true', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页参数，当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '每页个数,默认10，最大150', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '150', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'WorkerGradeId' => [ - 'title' => '实例规格 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'g_i4wa7XXX', - ], - 'WorkerGradeInfo' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'type' => 'string', - ], - 'Name' => [ - 'title' => '别名', - 'type' => 'string', - ], - 'Grade' => [ - 'title' => '规格', - 'type' => 'string', - ], - 'Spec' => [ - 'title' => '规格大小', - 'type' => 'string', - ], - 'SpecName' => [ - 'title' => '规格大小名称', - 'type' => 'string', - ], - 'SourceType' => [ - 'title' => '源端数据源类型', - 'type' => 'string', - ], - 'SourceRegion' => [ - 'title' => '源端数据源地域', - 'type' => 'string', - ], - 'DestType' => [ - 'title' => '目标端数据源类型', - 'type' => 'string', - ], - 'DestRegion' => [ - 'title' => '目标端数据源地域', - 'type' => 'string', - ], - 'ChargeType' => [ - 'title' => '计费类型', - 'type' => 'string', - ], - 'AutoRenewal' => [ - 'type' => 'boolean', - ], - 'Expired' => [ - 'type' => 'boolean', - ], - 'EndTime' => [ - 'title' => '到期时间，UTC时间', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'title' => '创建时间，UTC时间', - 'type' => 'string', - ], - ], - ], - 'Id' => [ - 'title' => '项目 id', - 'description' => '', - 'type' => 'string', - 'example' => 'np_4w****'."\n", - ], - 'Type' => [ - 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'MIGRATION' => 'MIGRATION', - 'SYNC' => 'SYNC', - ], - 'example' => 'MIGRATION', - ], - 'Name' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'project_name', - ], - 'Labels' => [ - 'title' => '标签id集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '标签id', - 'description' => '', - 'type' => 'string', - 'example' => 'l_dfe****'."\n", - ], - 'Name' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => 'label_name', - ], - 'Creator' => [ - 'title' => '创建人(只有在管理员视角下才进行返回)', - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'Type' => [ - 'title' => '1 用户标签，0 运维标签', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Count' => [ - 'title' => '使用此标签的项目数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - ], - 'Owner' => [ - 'title' => '项目owner', - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'Importance' => [ - 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'IGNORE' => 'IGNORE', - ], - 'example' => 'MEDIUM', - ], - 'Status' => [ - 'title' => '项目状态 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'GmtCreate' => [ - 'title' => '项目创建时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T06:26:15', - ], - 'GmtModified' => [ - 'title' => '项目更新时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T07:01:27', - ], - 'GmtStart' => [ - 'title' => '项目开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T07:02:27', - ], - 'GmtFinish' => [ - 'title' => '项目结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T08:01:27', - ], - 'DestConnId' => [ - 'title' => '目的连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'IsMerging' => [ - 'title' => '是否处于合并中', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsModifying' => [ - 'title' => '是否处于修改中', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsSubProject' => [ - 'title' => '是否子项目', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SourceEndpointType' => [ - 'title' => '源端数据源类型 (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'POLARDB_X_1' => 'POLARDB_X_1', - 'MYSQL' => 'MYSQL', - 'TIDB' => 'TIDB', - 'OB_ORACLE' => 'OB_ORACLE', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'POLARDB_X_2' => 'POLARDB_X_2', - ], - 'example' => 'MYSQL', - ], - 'SinkEndpointType' => [ - 'title' => '目的端数据源 id (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'MYSQL' => 'MYSQL', - 'OB_ORACLE' => 'OB_ORACLE', - 'KAFKA' => 'KAFKA', - 'ROCKETMQ' => 'ROCKETMQ', - 'DATAHUB' => 'DATAHUB', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'ADB' => 'ADB', - ], - 'example' => 'OB_MYSQL', - ], - 'TransferMapping' => [ - 'title' => '传输对象和映射关系', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '传输对象映射模式 (SPECIFIC, WILDCARD)', - 'description' => '', - 'type' => 'string', - 'example' => 'SPECIFIC', - ], - ], - ], - 'CommonTransferConfig' => [ - 'title' => '公共传输配置（所有步骤）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableCategory' => [ - 'title' => '传输的表类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ALL', - ], - 'ActiveActive' => [ - 'title' => '是否双活场景', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'MqSerializerType' => [ - 'title' => '投递到消息队列时，数据 json 序列化类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'MqPartitionMode' => [ - 'title' => '投递到消息队列时，分区路由方式', - 'description' => '', - 'type' => 'string', - 'example' => 'ONE', - ], - 'MqPartition' => [ - 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DatahubTopicType' => [ - 'title' => '投递到消息队列时，指定 topic 的类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'BLOB' => 'BLOB', - 'TUPLE' => 'TUPLE', - ], - 'example' => 'TUPLE', - ], - 'RocketMqProducerGroup' => [ - 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', - 'description' => '', - 'type' => 'string', - 'example' => 'OMS', - ], - 'RocketMqMsgTags' => [ - 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', - 'description' => '', - 'type' => 'string', - 'example' => 'default_tag', - ], - 'RocketMqEnableMsgTrace' => [ - 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RocketMqSendMsgTimeout' => [ - 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'DataWorksBusinessName' => [ - 'title' => '业务系统标识(可选)', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - 'EnableStructTransfer' => [ - 'title' => '是否启用结构传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StructTransferConfig' => [ - 'title' => '结构传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ByteCharConvertStrategy' => [ - 'title' => 'byte/char 转换方案', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'IGNORE_BYTE_IF_BYTE_USED' => 'IGNORE_BYTE_IF_BYTE_USED', - 'FORCE_CHAR_IF_BYTE_USED' => 'FORCE_CHAR_IF_BYTE_USED', - 'DO_NOTHING_IF_BYTE_USED' => 'DO_NOTHING_IF_BYTE_USED', - 'EXPAND_LEN_IF_BYTE_USED' => 'EXPAND_LEN_IF_BYTE_USED', - ], - 'example' => 'DO_NOTHING_IF_BYTE_USED', - ], - 'DeferIndexCreation' => [ - 'title' => '是否允许索引后置（默认不允许）', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'EnableFullTransfer' => [ - 'title' => '是否启用全量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableFullVerify' => [ - 'title' => '是否启用全量校验', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FullTransferConfig' => [ - 'title' => '全量传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NonePkUkTruncateDstTable' => [ - 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AllowDestTableNotEmpty' => [ - 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'FullTransferSpeedMode' => [ - 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FullVerifySpeedMode' => [ - 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - ], - ], - 'EnableIncrTransfer' => [ - 'title' => '是否启用增量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableIncrVerify' => [ - 'title' => '是否启用增量校验', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableReverseIncrTransfer' => [ - 'title' => '是否启用反向增量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IncrTransferConfig' => [ - 'title' => '增量配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartTimestamp' => [ - 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1681004708', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'DELETE' => 'DELETE', - 'COMMIT' => 'COMMIT', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', - 'BEGIN' => 'BEGIN', - 'ROW' => 'ROW', - 'HEARTBEAT' => 'HEARTBEAT', - 'DDL' => 'DDL', - 'ROLLBACK' => 'ROLLBACK', - ], - 'example' => 'INSERT', - ], - ], - 'StoreLogKeptHour' => [ - 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'EnableSequencingWithinTxn' => [ - 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IncrSyncConcurrency' => [ - 'title' => '增量同步线程数，默认64', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'EnableIncrSyncStatistics' => [ - 'title' => '是否开启增量记录(dml\\ddl)统计', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'SourceConnectInfo' => [ - 'title' => '源端节点连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c_4w3aq****', - ], - 'EndpointName' => [ - 'title' => '终端节点名', - 'description' => '', - 'type' => 'string', - 'example' => 'ration12****0obmysql4116892***', - ], - 'EndpointId' => [ - 'title' => '终端节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'e_4w3al***', - ], - 'EndpointSide' => [ - 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', - 'description' => '', - 'type' => 'string', - 'example' => 'source', - ], - 'DbEngine' => [ - 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', - 'description' => '', - 'type' => 'string', - 'example' => 'OB_MYSQL_PUBLIC', - ], - 'ConnectionInfo' => [ - 'title' => '终端节点连接信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Username' => [ - 'title' => '连接用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'oms931mys**', - ], - 'Version' => [ - 'title' => '数据库版本', - 'description' => '', - 'type' => 'string', - 'example' => '5.7.27', - ], - 'Timezone' => [ - 'title' => '数据库时区', - 'description' => '', - 'type' => 'string', - 'example' => 'UTC', - ], - 'Charset' => [ - 'title' => '编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'NlsLengthSemantics' => [ - 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OperatingSystem' => [ - 'title' => '操作系统(OB 没有)。', - 'description' => '', - 'type' => 'string', - 'example' => 'Linux', - ], - 'Region' => [ - 'title' => '地域属性', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'OcpName' => [ - 'title' => 'ocp name 属性，记录 ocp。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ConnExtraAttributes' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - 'Owner' => [ - 'title' => 'owner', - 'description' => 'Owner。', - 'type' => 'string', - 'example' => 'admin', - ], - 'ResourceOwner' => [ - 'title' => '资源所有者uid', - 'description' => '', - 'type' => 'string', - 'example' => '1325847***', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1'."\n", - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - ], - ], - 'SinkConnectInfo' => [ - 'title' => '目的端节点连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c_4w3akx***', - ], - 'EndpointName' => [ - 'title' => '终端节点名', - 'description' => '', - 'type' => 'string', - 'example' => 'ation129***9apimysql5616****', - ], - 'EndpointId' => [ - 'title' => '终端节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'e_4w3aic***', - ], - 'EndpointSide' => [ - 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', - 'description' => '', - 'type' => 'string', - 'example' => 'sink', - ], - 'DbEngine' => [ - 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', - 'description' => '', - 'type' => 'string', - 'example' => 'MYSQL_PUBLIC', - ], - 'ConnectionInfo' => [ - 'title' => '终端节点连接信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Username' => [ - 'title' => '连接用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'oms**obmys**', - ], - 'Version' => [ - 'title' => '数据库版本', - 'description' => '', - 'type' => 'string', - 'example' => '2.2.77', - ], - 'Timezone' => [ - 'title' => '数据库时区', - 'description' => '', - 'type' => 'string', - 'example' => '+08:00', - ], - 'Charset' => [ - 'title' => '编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'NlsLengthSemantics' => [ - 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OperatingSystem' => [ - 'title' => '操作系统(OB 没有)。', - 'description' => '', - 'type' => 'string', - 'example' => 'Linux', - ], - 'Region' => [ - 'title' => '地域属性', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'OcpName' => [ - 'title' => 'ocp name 属性，记录 ocp。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ConnExtraAttributes' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - 'Owner' => [ - 'title' => 'owner', - 'description' => 'Owner。', - 'type' => 'string', - 'example' => 'admin', - ], - 'ResourceOwner' => [ - 'title' => '资源所有者uid', - 'description' => '', - 'type' => 'string', - 'example' => '1325847***', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - ], - ], - 'Steps' => [ - 'title' => '步骤列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Order' => [ - 'title' => '步骤顺序', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'TRANSFER_PRECHECK', - ], - 'Description' => [ - 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ExtraInfo' => [ - 'title' => '补充信息（json）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ErrorDetails' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'ErrorCode' => [ - 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'ErrorMsg' => [ - 'title' => '错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ErrorParam' => [ - 'title' => '错误相关参数', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'FailedTime' => [ - 'title' => '错误时间', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - 'StartTime' => [ - 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'FinishTime' => [ - 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:05:18', - ], - 'Progress' => [ - 'title' => '步骤进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'StepInfo' => [ - 'title' => '步骤详情,全量传输/增量传输/正向切换', - 'description' => '', - 'type' => 'object', - 'example' => 'null', - ], - ], - ], - ], - 'ExtraInfo' => [ - 'title' => '错误信息等补充信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RunningStep' => [ - 'title' => '正在处于 running step (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'TRANSFER_PRECHECK', - ], - 'RunningProgress' => [ - 'title' => 'running step 进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'MonitoringIncr' => [ - 'title' => '是否开始监控增量', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Subtopics' => [ - 'title' => '任务关联 store 的 subtopics', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'ReverseSubtopics' => [ - 'title' => '任务关联反向 store 的 subtopics', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'LogServiceStartCheckpoint' => [ - 'title' => '起始位点，对于', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689214358', - ], - 'SourceStoreKeptHour' => [ - 'title' => '日志保存时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'SyncDelay' => [ - 'title' => '增量同步延时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'SyncDelaySampleTimestamp' => [ - 'title' => '同步延迟的采集时间戳，秒级别', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689214358', - ], - 'AccessObSource' => [ - 'title' => '是否能够直连OB源端，不能的话Store Source会变为LogProxy Source', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OverwriteConfig' => [ - 'title' => '是否允许完全覆盖更新配置', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IgnoreUnsupportDdl' => [ - 'title' => '对于connector，是否忽略不支持的ddl', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SubDbs' => [ - 'title' => '记录不同下游消费方的表配置，用于同步任务复用时的配置合并', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ClusterName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'cluster_name', - ], - 'TenantName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'tenant_name', - ], - 'DatabaseId' => [ - 'title' => '目前只有逻辑库才会具有 id，可能存在在一个 Endpoint 中库名相同，但是 id 不同，表示的是不同的 id 情况', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'DatabaseName' => [ - 'title' => '数据库名称', - 'type' => 'string', - 'description' => '', - 'example' => 'db_name', - ], - 'MappingDatabaseName' => [ - 'title' => '数据库映射名', - 'type' => 'string', - 'example' => 'mapped_db', - 'description' => '', - ], - 'SourceClientId' => [ - 'title' => '用于标识是哪个 source client 来处理该 databaseName', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'Tables' => [ - 'title' => '表名称', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TableId' => [ - 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'Database' => [ - 'title' => '库名称', - 'type' => 'string', - 'description' => '', - 'example' => 'db_name', - ], - 'TableName' => [ - 'title' => '表名', - 'type' => 'string', - 'description' => '', - 'example' => 'table_name', - ], - 'MappingTableName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'mapped_name', - ], - 'Instance' => [ - 'title' => '逻辑表返回的 instance，只有逻辑表会存在, @link PhysicalTableDTO#url', - 'type' => 'string', - 'description' => '', - 'example' => 'g_i4kat***', - ], - 'Columns' => [ - 'title' => '表列信息，如果是逻辑表可能放在外层', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'type' => 'string', - 'example' => 'column_name', - 'description' => '', - ], - 'Position' => [ - 'title' => '字段位置', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNSUPPORTED_TYPE)', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'Nullable' => [ - 'title' => '是否可为空', - 'type' => 'boolean', - 'description' => '', - 'example' => 'false', - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'DataLength' => [ - 'title' => '字段长度', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - 'description' => '', - ], - 'DataPrecision' => [ - 'title' => '精度', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '64', - ], - 'DataScale' => [ - 'title' => '小数点', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - 'description' => '', - ], - 'Encoding' => [ - 'title' => '字符编码', - 'type' => 'string', - 'description' => '', - 'example' => 'utf8', - ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'type' => 'string', - 'example' => 'comments', - 'description' => '', - ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'type' => 'boolean', - 'example' => 'false', - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SubConds' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TenantName' => [ - 'title' => '源端租户名称', - 'type' => 'string', - 'example' => 'tenant_name', - 'description' => '', - ], - 'Database' => [ - 'title' => '源端数据库名', - 'type' => 'string', - 'example' => 'db_name', - 'description' => '', - ], - 'DestDatabase' => [ - 'title' => '目标数据库名', - 'type' => 'string', - 'example' => 'dest_db', - 'description' => '', - ], - 'TableName' => [ - 'title' => '源端表名', - 'type' => 'string', - 'description' => '', - 'example' => 'table_name', - ], - 'DestName' => [ - 'title' => '目标端表名/Topic名', - 'type' => 'string', - 'example' => 'dest_name', - 'description' => '', - ], - 'WhereClause' => [ - 'title' => 'sql 语法', - 'type' => 'string', - 'example' => 'id>1', - 'description' => '', - ], - 'FilterColumns' => [ - 'title' => '过滤列，如果该集合空表示都需要，如果该集合有值表示保留值', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'col', - ], - 'description' => '', - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'col', - ], - 'description' => '', - ], - 'LogicTableId' => [ - 'title' => '针对逻辑表下，逻辑表 tableId', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'SourceEndpointId' => [ - 'title' => '针对物理表下传递 endpointId', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'SourceClientId' => [ - 'title' => 'connector client id', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SubIds' => [ - 'title' => '取代', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'MaxConnectorCount' => [ - 'title' => 'connector 最大数量，-1 表示不限制', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'StoreIncr' => [ - 'title' => '是否保存增量', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IncrSyncTimestamp' => [ - 'title' => '增量当前位点 秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689244596', - ], - ], - ], - 'AlarmStats' => [ - 'title' => '告警统计信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '被告警目标（项目、host）', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Alarming' => [ - 'title' => '是否正在告警', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RecentlyTriggerCount' => [ - 'title' => '最近告警消息总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RuleToRecentlyTriggerCount' => [ - 'title' => '分规则最近告警消息数', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'description' => '', - ], - ], - 'AlarmContent' => [ - 'title' => '最近告警内容', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OpenMonitor' => [ - 'title' => '公有云下，是否开启监控告警开关', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\",\\n \\"Name\\": \\"i5fu***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-01-28T15:07:44\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_4w****\\\\n\\",\\n \\"Type\\": \\"MIGRATION\\",\\n \\"Name\\": \\"project_name\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dfe****\\\\n\\",\\n \\"Name\\": \\"label_name\\",\\n \\"Creator\\": \\"admin\\",\\n \\"Type\\": 1,\\n \\"Count\\": 2\\n }\\n ],\\n \\"Owner\\": \\"admin\\",\\n \\"Importance\\": \\"MEDIUM\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T07:01:27\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T08:01:27\\",\\n \\"DestConnId\\": \\"null\\",\\n \\"IsMerging\\": false,\\n \\"IsModifying\\": false,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"MYSQL\\",\\n \\"SinkEndpointType\\": \\"OB_MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\"\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": false,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": false,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": false\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": false,\\n \\"FullTransferSpeedMode\\": \\"NORMAL\\",\\n \\"FullVerifySpeedMode\\": \\"NORMAL\\"\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1681004708,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_4w3aq****\\",\\n \\"EndpointName\\": \\"ration12****0obmysql4116892***\\",\\n \\"EndpointId\\": \\"e_4w3al***\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms931mys**\\",\\n \\"Version\\": \\"5.7.27\\",\\n \\"Timezone\\": \\"UTC\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"c_4w3akx***\\",\\n \\"EndpointName\\": \\"ation129***9apimysql5616****\\",\\n \\"EndpointId\\": \\"e_4w3aic***\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms**obmys**\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"TRANSFER_PRECHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:05:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"TRANSFER_PRECHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": true,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"null\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_name\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"column_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n ]\\n}","type":"json"}]', - ], - 'DescribeProject' => [ - 'summary' => '查询项目详情', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_fe****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'WorkerGradeId' => [ - 'title' => '实例规格 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'g_i4wa7XXX'."\n", - ], - 'WorkerGradeInfo' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'type' => 'string', - ], - 'Name' => [ - 'title' => '别名', - 'type' => 'string', - ], - 'Grade' => [ - 'title' => '规格', - 'type' => 'string', - ], - 'Spec' => [ - 'title' => '规格大小', - 'type' => 'string', - ], - 'SpecName' => [ - 'title' => '规格大小名称', - 'type' => 'string', - ], - 'SourceType' => [ - 'title' => '源端数据源类型', - 'type' => 'string', - ], - 'SourceRegion' => [ - 'title' => '源端数据源地域', - 'type' => 'string', - ], - 'DestType' => [ - 'title' => '目标端数据源类型', - 'type' => 'string', - ], - 'DestRegion' => [ - 'title' => '目标端数据源地域', - 'type' => 'string', - ], - 'ChargeType' => [ - 'title' => '计费方式', - 'type' => 'string', - ], - 'AutoRenewal' => [ - 'type' => 'boolean', - ], - 'Expired' => [ - 'type' => 'boolean', - ], - 'EndTime' => [ - 'title' => '到期时间，UTC时间', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'title' => '创建时间，UTC时间', - 'type' => 'string', - ], - ], - ], - 'Id' => [ - 'title' => '项目 id', - 'description' => '', - 'type' => 'string', - 'example' => 'np_fe****', - ], - 'Type' => [ - 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', - 'description' => '', - 'type' => 'string', - 'example' => 'SYNC', - ], - 'Name' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Labels' => [ - 'title' => '标签id集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '标签id', - 'description' => '', - 'type' => 'string', - 'example' => 'l_dr****', - ], - 'Name' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test_tag', - ], - ], - ], - ], - 'Owner' => [ - 'title' => '项目owner', - 'description' => '', - 'type' => 'string', - 'example' => 'omsefry***', - ], - 'Importance' => [ - 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', - 'description' => '', - 'type' => 'string', - 'example' => 'HIGH', - ], - 'Status' => [ - 'title' => '项目状态 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'GmtCreate' => [ - 'title' => '项目创建时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T06:26:15', - ], - 'GmtModified' => [ - 'title' => '项目更新时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T06:26:15'."\n", - ], - 'GmtStart' => [ - 'title' => '项目开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T07:02:27', - ], - 'GmtFinish' => [ - 'title' => '项目结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T07:02:27', - ], - 'DestConnId' => [ - 'title' => '目的连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c_deg***', - ], - 'IsMerging' => [ - 'title' => '是否处于合并中', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false ', - ], - 'IsModifying' => [ - 'title' => '是否处于修改中', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false ', - ], - 'IsSubProject' => [ - 'title' => '是否子项目', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SourceEndpointType' => [ - 'title' => '源端数据源类型 (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'POLARDB_X_1' => 'POLARDB_X_1', - 'MYSQL' => 'MYSQL', - 'TIDB' => 'TIDB', - 'OB_ORACLE' => 'OB_ORACLE', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'POLARDB_X_2' => 'POLARDB_X_2', - ], - 'example' => 'OB_MYSQL', - ], - 'SinkEndpointType' => [ - 'title' => '目的端数据源 id (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'MYSQL' => 'MYSQL', - 'OB_ORACLE' => 'OB_ORACLE', - 'KAFKA' => 'KAFKA', - 'ROCKETMQ' => 'ROCKETMQ', - 'DATAHUB' => 'DATAHUB', - 'OB_MYSQL' => 'OB_MYSQL', - 'ORACLE' => 'ORACLE', - 'ADB' => 'ADB', - ], - 'example' => 'MYSQL', - ], - 'TransferMapping' => [ - 'title' => '传输对象和映射关系', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '传输对象映射模式 (SPECIFIC, WILDCARD)', - 'description' => '', - 'type' => 'string', - 'example' => 'SPECIFIC', - ], - 'Databases' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MYSQL', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'db_id', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'db_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_db', - ], - 'TenantName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant_name', - ], - 'Tables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id > 1', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'Views' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fexdg***', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id < 1', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'SpecificTables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id>1', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'SpecificViews' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id<3', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'DatabasesBlack' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DATABASE', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'db_id', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'db_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_db', - ], - 'TenantName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_tenant', - ], - 'Tables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id>1', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'Views' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id>2', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'SpecificTables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id<3', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'SpecificViews' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], - 'MappedName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'view_id', - ], - 'WhereClause' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id>2', - ], - 'FilterColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'AdbTableSchema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')'."\n", - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'TableAndViewWhiteList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'TableAndViewBlackList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - 'CommonTransferConfig' => [ - 'title' => '公共传输配置（所有步骤）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableCategory' => [ - 'title' => '传输的表类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ALL', - ], - 'ActiveActive' => [ - 'title' => '是否双活场景', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MqSerializerType' => [ - 'title' => '投递到消息队列时，数据 json 序列化类型', - 'description' => '', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'MqPartitionMode' => [ - 'title' => '投递到消息队列时，分区路由方式', - 'description' => '', - 'type' => 'string', - 'example' => 'ONE', - ], - 'MqPartition' => [ - 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DatahubTopicType' => [ - 'title' => '投递到消息队列时，指定 topic 的类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'BLOB' => 'BLOB', - 'TUPLE' => 'TUPLE', - ], - 'example' => 'TUPLE', - ], - 'RocketMqProducerGroup' => [ - 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', - 'description' => '', - 'type' => 'string', - 'example' => 'OMS', - ], - 'RocketMqMsgTags' => [ - 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', - 'description' => '', - 'type' => 'string', - 'example' => 'default_tag', - ], - 'RocketMqEnableMsgTrace' => [ - 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RocketMqSendMsgTimeout' => [ - 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'DataWorksBusinessName' => [ - 'title' => '业务系统标识(可选)', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'SinkStoreFormat' => [ - 'title' => '业务系统标识(可选)', - 'type' => 'string', - ], - 'SourceStoreFormat' => [ - 'title' => '业务系统标识(可选)', - 'type' => 'string', - ], - ], - ], - 'EnableStructTransfer' => [ - 'title' => '是否启用结构传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StructTransferConfig' => [ - 'title' => '结构传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ByteCharConvertStrategy' => [ - 'title' => 'byte/char 转换方案', - 'description' => '', - 'type' => 'string', - 'example' => 'DO_NOTHING_IF_BYTE_USED', - ], - 'DeferIndexCreation' => [ - 'title' => '是否允许索引后置（默认不允许）', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'EnableFullTransfer' => [ - 'title' => '是否启用全量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableFullVerify' => [ - 'title' => '是否启用全量校验', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FullTransferConfig' => [ - 'title' => '全量传输配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NonePkUkTruncateDstTable' => [ - 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AllowDestTableNotEmpty' => [ - 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FullTransferSpeedMode' => [ - 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', - 'description' => '', - 'type' => 'string', - 'example' => 'FAST', - ], - 'FullVerifySpeedMode' => [ - 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', - 'description' => '', - 'type' => 'string', - 'example' => 'FAST', - ], - 'WriteWorkerNum' => [ - 'title' => '写入并发数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ReadWorkerNum' => [ - 'title' => '读取并发数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'EnableIncrTransfer' => [ - 'title' => '是否启用增量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableIncrVerify' => [ - 'title' => '是否启用增量校验', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableReverseIncrTransfer' => [ - 'title' => '是否启用反向增量传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IncrTransferConfig' => [ - 'title' => '增量配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartTimestamp' => [ - 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1667286900', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'DELETE' => 'DELETE', - 'COMMIT' => 'COMMIT', - 'INSERT' => 'INSERT', - 'UPDATE' => 'UPDATE', - 'BEGIN' => 'BEGIN', - 'ROW' => 'ROW', - 'HEARTBEAT' => 'HEARTBEAT', - 'DDL' => 'DDL', - 'ROLLBACK' => 'ROLLBACK', - ], - 'example' => 'INSERT', - ], - ], - 'StoreLogKeptHour' => [ - 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'EnableSequencingWithinTxn' => [ - 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IncrSyncConcurrency' => [ - 'title' => '增量同步线程数，默认64', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'EnableIncrSyncStatistics' => [ - 'title' => '是否开启增量记录(dml\\ddl)统计', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SupportDDLTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - 'ReverseIncrTransferConfig' => [ - 'title' => '反向增量配置', - 'type' => 'object', - 'properties' => [ - 'StartTimestamp' => [ - 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'StoreLogKeptHour' => [ - 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', - 'type' => 'integer', - 'format' => 'int32', - ], - 'EnableSequencingWithinTxn' => [ - 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', - 'type' => 'boolean', - ], - 'IncrSyncConcurrency' => [ - 'title' => '增量同步线程数，默认64', - 'type' => 'integer', - 'format' => 'int32', - ], - 'EnableIncrSyncStatistics' => [ - 'title' => '是否开启增量记录(dml\\ddl)统计', - 'type' => 'boolean', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SupportDDLTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - 'SourceConnectInfo' => [ - 'title' => '源端节点连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c_feg****', - ], - 'EndpointName' => [ - 'title' => '终端节点名', - 'description' => '', - 'type' => 'string', - 'example' => 'migon****', - ], - 'EndpointId' => [ - 'title' => '终端节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'e_3kx5i***1s', - ], - 'EndpointSide' => [ - 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', - 'description' => '', - 'type' => 'string', - 'example' => 'source', - ], - 'DbEngine' => [ - 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', - 'description' => '', - 'type' => 'string', - 'example' => 'OB_MYSQL_PUBLIC', - ], - 'ConnectionInfo' => [ - 'title' => '终端节点连接信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Username' => [ - 'title' => '连接用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'oms2027obmysql@oms_***', - ], - 'Version' => [ - 'title' => '数据库版本', - 'description' => '', - 'type' => 'string', - 'example' => '2.2.77', - ], - 'Timezone' => [ - 'title' => '数据库时区', - 'description' => '', - 'type' => 'string', - 'example' => '+08:00', - ], - 'Charset' => [ - 'title' => '编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'NlsLengthSemantics' => [ - 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', - 'description' => '', - 'type' => 'string', - 'example' => 'null'."\n", - ], - 'OperatingSystem' => [ - 'title' => '操作系统(OB 没有)。', - 'description' => '', - 'type' => 'string', - 'example' => 'Linux', - ], - 'Region' => [ - 'title' => '地域属性', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'OcpName' => [ - 'title' => 'ocp name 属性，记录 ocp。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ConnExtraAttributes' => [ - 'title' => '', - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - 'Owner' => [ - 'title' => 'owner', - 'description' => 'Owner。', - 'type' => 'string', - 'example' => 'oms_test', - ], - 'ResourceOwner' => [ - 'title' => '资源所有者uid', - 'description' => '', - 'type' => 'string', - 'example' => '1325847***'."\n", - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - ], - ], - 'SinkConnectInfo' => [ - 'title' => '目的端节点连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '连接信息ID', - 'description' => '', - 'type' => 'string', - 'example' => 'e_4lgzuzi9znr4', - ], - 'EndpointName' => [ - 'title' => '终端节点名', - 'description' => '', - 'type' => 'string', - 'example' => 'RATION12948*****', - ], - 'EndpointId' => [ - 'title' => '终端节点id', - 'description' => '', - 'type' => 'string', - 'example' => 'e_4w1q****', - ], - 'EndpointSide' => [ - 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', - 'description' => '', - 'type' => 'string', - 'example' => 'sink', - ], - 'DbEngine' => [ - 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', - 'description' => '', - 'type' => 'string', - 'example' => 'MYSQL_PUBLIC', - ], - 'ConnectionInfo' => [ - 'title' => '终端节点连接信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Username' => [ - 'title' => '连接用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'oms2027obmysql@oms_***'."\n", - ], - 'Version' => [ - 'title' => '数据库版本', - 'description' => '', - 'type' => 'string', - 'example' => '2.2.77', - ], - 'Timezone' => [ - 'title' => '数据库时区', - 'description' => '', - 'type' => 'string', - 'example' => '+08:00', - ], - 'Charset' => [ - 'title' => '编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'NlsLengthSemantics' => [ - 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OperatingSystem' => [ - 'title' => '操作系统(OB 没有)。', - 'description' => '', - 'type' => 'string', - 'example' => 'Linux', - ], - 'Region' => [ - 'title' => '地域属性', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'OcpName' => [ - 'title' => 'ocp name 属性，记录 ocp。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ConnExtraAttributes' => [ - 'title' => '', - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - 'Owner' => [ - 'title' => 'owner', - 'description' => 'Owner。', - 'type' => 'string', - 'example' => 'oms_test', - ], - 'ResourceOwner' => [ - 'title' => '资源所有者uid', - 'description' => '', - 'type' => 'string', - 'example' => '1325847***'."\n", - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1'."\n", - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - ], - ], - 'Steps' => [ - 'title' => '步骤列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Order' => [ - 'title' => '步骤顺序', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRE_CHECK', - ], - 'Description' => [ - 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ExtraInfo' => [ - 'title' => '补充信息（json）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ErrorDetails' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' '."\n" - .'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => 'FATAL, ERROR, WARNING, CRITICAL', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. '."\n" - ."\n", - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'ErrorCode' => [ - 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'ErrorMsg' => [ - 'title' => '错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ErrorParam' => [ - 'title' => '错误相关参数', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'FailedTime' => [ - 'title' => '错误时间', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - 'StartTime' => [ - 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'FinishTime' => [ - 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'Progress' => [ - 'title' => '步骤进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'StepInfo' => [ - 'title' => '步骤详情,全量传输/增量传输/正向切换', - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - ], - ], - ], - 'ExtraInfo' => [ - 'title' => '错误信息等补充信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RunningStep' => [ - 'title' => '正在处于 running step (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRE-CHECK', - ], - 'RunningProgress' => [ - 'title' => 'running step 进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'MonitoringIncr' => [ - 'title' => '是否开始监控增量', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Subtopics' => [ - 'title' => '任务关联 store 的 subtopics', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'ReverseSubtopics' => [ - 'title' => '任务关联反向 store 的 subtopics', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'LogServiceStartCheckpoint' => [ - 'title' => '起始位点，对于', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689214358', - ], - 'SourceStoreKeptHour' => [ - 'title' => '日志保存时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'SyncDelay' => [ - 'title' => '增量同步延时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'SyncDelaySampleTimestamp' => [ - 'title' => '同步延迟的采集时间戳，秒级别', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689214358', - ], - 'AccessObSource' => [ - 'title' => '是否能够直连OB源端，不能的话Store Source会变为LogProxy Source', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OverwriteConfig' => [ - 'title' => '是否允许完全覆盖更新配置', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IgnoreUnsupportDdl' => [ - 'title' => '对于connector，是否忽略不支持的ddl', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SubDbs' => [ - 'title' => '记录不同下游消费方的表配置，用于同步任务复用时的配置合并', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ClusterName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'cluster_name', - ], - 'TenantName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'tenant_name', - ], - 'DatabaseId' => [ - 'title' => '目前只有逻辑库才会具有 id，可能存在在一个 Endpoint 中库名相同，但是 id 不同，表示的是不同的 id 情况', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'DatabaseName' => [ - 'title' => '数据库名称', - 'type' => 'string', - 'example' => 'db_name', - 'description' => '', - ], - 'MappingDatabaseName' => [ - 'title' => '数据库映射名', - 'type' => 'string', - 'description' => '', - 'example' => 'mapped_db', - ], - 'SourceClientId' => [ - 'title' => '用于标识是哪个 source client 来处理该 databaseName', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'Tables' => [ - 'title' => '表名称', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TableId' => [ - 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', - 'type' => 'string', - 'description' => '', - 'example' => 'fexg***', - ], - 'Database' => [ - 'title' => '库名称', - 'type' => 'string', - 'example' => 'db_name', - 'description' => '', - ], - 'TableName' => [ - 'title' => '表名', - 'type' => 'string', - 'description' => '', - 'example' => 'table_name', - ], - 'MappingTableName' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'mapped_table', - ], - 'Instance' => [ - 'title' => '逻辑表返回的 instance，只有逻辑表会存在, @link PhysicalTableDTO#url', - 'type' => 'string', - 'description' => '', - 'example' => 'g_i4kat***', - ], - 'Columns' => [ - 'title' => '表列信息，如果是逻辑表可能放在外层', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'Position' => [ - 'title' => '字段位置', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNSUPPORTED_TYPE)', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'Nullable' => [ - 'title' => '是否可为空', - 'type' => 'boolean', - 'example' => 'true', - 'description' => '', - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'DataLength' => [ - 'title' => '字段长度', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - 'description' => '', - ], - 'DataPrecision' => [ - 'title' => '精度', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '64', - ], - 'DataScale' => [ - 'title' => '小数点', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - 'description' => '', - ], - 'Encoding' => [ - 'title' => '字符编码', - 'type' => 'string', - 'description' => '', - 'example' => 'utf8', - ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'type' => 'string', - 'description' => '', - 'example' => 'comments', - ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'type' => 'boolean', - 'description' => '', - 'example' => 'false', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SubConds' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TenantName' => [ - 'title' => '源端租户名称', - 'type' => 'string', - 'description' => '', - 'example' => 'tenant_name', - ], - 'Database' => [ - 'title' => '源端数据库名', - 'type' => 'string', - 'example' => 'db_name', - 'description' => '', - ], - 'DestDatabase' => [ - 'title' => '目标数据库名', - 'type' => 'string', - 'example' => 'dest_db', - 'description' => '', - ], - 'TableName' => [ - 'title' => '源端表名', - 'type' => 'string', - 'example' => 'table_name', - 'description' => '', - ], - 'DestName' => [ - 'title' => '目标端表名/Topic名', - 'type' => 'string', - 'example' => 'dest_name', - 'description' => '', - ], - 'WhereClause' => [ - 'title' => 'sql 语法', - 'type' => 'string', - 'example' => 'id>1', - 'description' => '', - ], - 'FilterColumns' => [ - 'title' => '过滤列，如果该集合空表示都需要，如果该集合有值表示保留值', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'col', - 'description' => '', - ], - 'description' => '', - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'col', - ], - 'description' => '', - ], - 'LogicTableId' => [ - 'title' => '针对逻辑表下，逻辑表 tableId', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - 'SourceEndpointId' => [ - 'title' => '针对物理表下传递 endpointId', - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - 'SourceClientId' => [ - 'title' => 'connector client id', - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SubIds' => [ - 'title' => '取代', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'MaxConnectorCount' => [ - 'title' => 'connector 最大数量，-1 表示不限制', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'StoreIncr' => [ - 'title' => '是否保存增量', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IncrSyncTimestamp' => [ - 'title' => '增量当前位点 秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689244596', - ], - ], - ], - 'AlarmStats' => [ - 'title' => '告警统计信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '被告警目标（项目、host）', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Alarming' => [ - 'title' => '是否正在告警', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RecentlyTriggerCount' => [ - 'title' => '最近告警消息总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RuleToRecentlyTriggerCount' => [ - 'title' => '分规则最近告警消息数', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '0', - ], - ], - 'AlarmContent' => [ - 'title' => '最近告警内容', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OpenMonitor' => [ - 'title' => '公有云下，是否开启监控告警开关', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\\\n\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\\\n\\",\\n \\"Name\\": \\"i5fuij***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-02-02T16:00:00\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_fe****\\",\\n \\"Type\\": \\"SYNC\\",\\n \\"Name\\": \\"test\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dr****\\",\\n \\"Name\\": \\"test_tag\\"\\n }\\n ],\\n \\"Owner\\": \\"omsefry***\\",\\n \\"Importance\\": \\"HIGH\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\\\n\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T07:02:27\\",\\n \\"DestConnId\\": \\"c_deg***\\",\\n \\"IsMerging\\": true,\\n \\"IsModifying\\": true,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"OB_MYSQL\\",\\n \\"SinkEndpointType\\": \\"MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\",\\n \\"Databases\\": [\\n {\\n \\"Type\\": \\"MYSQL\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id > 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"fexdg***\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"col\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"DatabasesBlack\\": [\\n {\\n \\"Type\\": \\"DATABASE\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"mapped_tenant\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"TableAndViewWhiteList\\": [\\n \\"null\\"\\n ],\\n \\"TableAndViewBlackList\\": [\\n \\"null\\"\\n ]\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": true,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": true,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\",\\n \\"SinkStoreFormat\\": \\"null\\",\\n \\"SourceStoreFormat\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": true\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": true,\\n \\"FullTransferSpeedMode\\": \\"FAST\\",\\n \\"FullVerifySpeedMode\\": \\"FAST\\",\\n \\"WriteWorkerNum\\": 64,\\n \\"ReadWorkerNum\\": 64,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1667286900,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": false,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"ReverseIncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1687363200,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_feg****\\",\\n \\"EndpointName\\": \\"migon****\\",\\n \\"EndpointId\\": \\"e_3kx5i***1s\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\\\n\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"e_4lgzuzi9znr4\\",\\n \\"EndpointName\\": \\"RATION12948*****\\",\\n \\"EndpointId\\": \\"e_4w1q****\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\\\n\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\\\n\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 90,\\n \\"StepInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"PRE-CHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": false,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"fexg***\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_table\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"null\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n}","type":"json"}]', - ], - 'DescribeProjectSteps' => [ - 'summary' => '查询项目步骤', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Order' => [ - 'title' => '步骤顺序', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRE_CHECK', - ], - 'Description' => [ - 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ExtraInfo' => [ - 'title' => '补充信息（json）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ErrorDetails' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'ErrorCode' => [ - 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'ErrorMsg' => [ - 'title' => '错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'The ResourceDirectoryId is invalid.', - ], - 'ErrorParam' => [ - 'title' => '错误相关参数', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'FailedTime' => [ - 'title' => '错误时间', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - 'StartTime' => [ - 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'FinishTime' => [ - 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'Progress' => [ - 'title' => '步骤进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'StepInfo' => [ - 'title' => '步骤详情,全量传输/增量传输/正向切换', - 'description' => '', - 'type' => 'object', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"The ResourceDirectoryId is invalid.\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ]\\n}","type":"json"}]', - ], - 'DescribeProjectStepMetric' => [ - 'summary' => '查询项目步骤指标', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_dr****', - ], - ], - [ - 'name' => 'StepName', - 'in' => 'formData', - 'schema' => [ - 'title' => '步骤名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FULL_TRANSFER', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'formData', - 'schema' => [ - 'title' => '指标类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RPS', - ], - ], - [ - 'name' => 'Aggregator', - 'in' => 'formData', - 'schema' => [ - 'title' => '聚合算子 AVG-取平均值（平均数据折线图），NONE-取中位（瞬时数据折线图），默认 NONE', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AVG', - 'enum' => [ - 'AVG', - 'NONE', - ], - ], - ], - [ - 'name' => 'BeginTimestamp', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间（秒级时间戳）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1689244696', - ], - ], - [ - 'name' => 'EndTimestamp', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间（秒级时间戳）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1689254646', - ], - ], - [ - 'name' => 'MaxPointNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '最大查询点数（取值范围5~7*24*60, 建议值：时间段（单位分钟）/maxPointNum > 5）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '5', - 'example' => '6', - 'default' => '6', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReferenceValue' => [ - 'title' => '基准值。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'Metrics' => [ - 'title' => '数据折线图。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'metric name', - 'description' => '', - 'type' => 'string', - 'example' => 'metric_name', - ], - 'Tags' => [ - 'title' => 'metrics tags', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'metric_tag', - ], - ], - 'DataPoints' => [ - 'title' => 'data point list', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'title' => '毫秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689244696', - ], - 'Value' => [ - 'title' => '时间对应的值', - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - 'Aggregator' => [ - 'title' => 'AVG(平均)，NONE(瞬时) (AVG: 取平均值, NONE: 取中位)', - 'description' => '', - 'type' => 'string', - 'example' => 'AVG', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ReferenceValue\\": 0,\\n \\"Metrics\\": [\\n {\\n \\"Name\\": \\"metric_name\\",\\n \\"Tags\\": {\\n \\"key\\": \\"metric_tag\\"\\n },\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1689244696,\\n \\"Value\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Aggregator\\": \\"AVG\\"\\n }\\n}","type":"json"}]', - ], - 'DescribeProjectProgress' => [ - 'summary' => '获取迁移/同步项目 Progress 信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => 'np_fe****', - ], - 'Status' => [ - 'title' => '通用的项目状态枚举 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'AlarmLevel' => [ - 'title' => '告警保障等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', - 'description' => '', - 'type' => 'string', - 'example' => 'MEDIUM', - ], - 'EnableIncrSync' => [ - 'title' => '是否有正向增量同步', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CurrentStep' => [ - 'title' => '当前进行到哪一步 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRE_CHECK', - ], - 'IncrSyncCheckpoint' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689248064', - ], - 'EnableStructTransfer' => [ - 'title' => '是否有结构传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableFullTransfer' => [ - 'title' => '是否有全量数据传输', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StructTransferProgress' => [ - 'title' => '结构传输进度百分比，0~100', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FullTransferProgress' => [ - 'title' => '全量传输进度百分比，0~100', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'EnableReverseIncrTransfer' => [ - 'title' => '是否有反向增量同步', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ReverseIncrTransferCheckpoint' => [ - 'title' => '反向增量同步位点，unix timestamp，单位秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689248075', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ProjectId\\": \\"np_fe****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"AlarmLevel\\": \\"MEDIUM\\",\\n \\"EnableIncrSync\\": true,\\n \\"CurrentStep\\": \\"PRE_CHECK\\",\\n \\"IncrSyncCheckpoint\\": 1689248064,\\n \\"EnableStructTransfer\\": true,\\n \\"EnableFullTransfer\\": true,\\n \\"StructTransferProgress\\": 100,\\n \\"FullTransferProgress\\": 100,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"ReverseIncrTransferCheckpoint\\": 1689248075\\n }\\n}","type":"json"}]', - ], - 'DescribeProjectComponents' => [ - 'summary' => '获取项目的组件信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w3a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '48', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StoreList' => [ - 'title' => '增量拉取组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97', - ], - 'Ip' => [ - 'title' => 'IP', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Topic' => [ - 'title' => 'Topic', - 'description' => 'Topic。', - 'type' => 'string', - 'example' => 'OB_ORACLE_np_4w3r29c_4w3****', - ], - 'Subtopic' => [ - 'title' => 'SubTopic', - 'description' => 'SubTopic。', - 'type' => 'string', - 'example' => 'OB_ORACLE_np_4w3***c_4w3**-0', - ], - 'Tps' => [ - 'title' => 'Tps', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Delay' => [ - 'title' => 'delay', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Gmt' => [ - 'title' => '位点采集时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250049', - ], - 'Conn' => [ - 'title' => '连接数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Status' => [ - 'title' => '状态 (EXCEPTION: Store 运行异常。, ACTIVE: Store 正常运行中。, STOP: Store 人为操作停止。, UNEXPECTED_EXIT: Store reader 非预期退出。, CHANGE_SOURCE: 按目前的实现来看，Ghana 中不会出现 CHANGE_SOURCE)', - 'description' => '', - 'type' => 'string', - 'example' => 'EXCEPTION', - ], - 'ErrorDetails' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'ToSwitch' => [ - 'title' => '是否需要主备切换，供 HA 判断', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Port' => [ - 'title' => '对外服务端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - 'StorePort' => [ - 'title' => 'store 端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2882', - ], - 'BeginCheckpoint' => [ - 'title' => '开始安全位点 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'EndCheckpoint' => [ - 'title' => '结束安全位点 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'ErrMsg' => [ - 'title' => '当前错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'GmtCreate' => [ - 'title' => '创建时间（UTC 格式时间）', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T17:29:54', - ], - 'GmtModified' => [ - 'title' => '更新时间（UTC 格式时间）', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T17:29:54', - ], - 'LatelyHeartbeatTimeSec' => [ - 'title' => '最近一次心跳时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250071', - ], - ], - ], - ], - 'ReverseStoreList' => [ - 'title' => '反向增量拉取组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277', - ], - 'Ip' => [ - 'title' => 'IP', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'Topic' => [ - 'title' => 'Topic', - 'description' => 'Topic。', - 'type' => 'string', - 'example' => 'null', - ], - 'Subtopic' => [ - 'title' => 'SubTopic', - 'description' => 'SubTopic。', - 'type' => 'string', - 'example' => 'null', - ], - 'Tps' => [ - 'title' => 'Tps', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Delay' => [ - 'title' => 'delay', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Gmt' => [ - 'title' => '位点采集时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250071', - ], - 'Conn' => [ - 'title' => '连接数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Status' => [ - 'title' => '状态 (EXCEPTION: Store 运行异常, ACTIVE: Store 正常运行中, STOP: Store 人为操作停止, UNEXPECTED_EXIT: Store reader 非预期退出, CHANGE_SOURCE)', - 'description' => '', - 'type' => 'string', - 'example' => 'EXCEPTION', - ], - 'ErrorDetails' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'ToSwitch' => [ - 'title' => '是否需要主备切换，供 HA 判断', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Port' => [ - 'title' => '对外服务端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - 'StorePort' => [ - 'title' => 'store 端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2882', - ], - 'BeginCheckpoint' => [ - 'title' => '开始安全位点 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'EndCheckpoint' => [ - 'title' => '结束安全位点 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'ErrMsg' => [ - 'title' => '当前错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'LatelyHeartbeatTimeSec' => [ - 'title' => '最近一次心跳时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250071', - ], - ], - ], - ], - 'FullVerifyComponents' => [ - 'title' => '全量校验组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-9000:90247:0000000033', - ], - 'InconsistentQuantity' => [ - 'title' => '不一致数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ConsistentQuantity' => [ - 'title' => '一致数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Progress' => [ - 'title' => '表级别进度', - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'RecordProgress' => [ - 'title' => '记录级别的进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Status' => [ - 'title' => 'checker 状态 (INIT, RUNNING, DONE, FAILED, SHUTDOWNED, DELETED)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ErrorDetails' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - 'Ip' => [ - 'title' => 'ip', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'TaskId' => [ - 'title' => 'taskId', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1345***', - ], - ], - ], - ], - 'FullImportComponents' => [ - 'title' => '全量导入组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276', - ], - 'Ip' => [ - 'title' => 'ip', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Identity' => [ - 'title' => '正向：项目id', - 'description' => '', - 'type' => 'string', - 'example' => 'p_4w8v****', - ], - 'Progress' => [ - 'title' => '进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'Status' => [ - 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'GmtModify' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'ErrorDetails' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - 'IncrSyncComponents' => [ - 'title' => '增量同步组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277', - ], - 'Ip' => [ - 'title' => '机器ip', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Identity' => [ - 'title' => '正向：项目id', - 'description' => '', - 'type' => 'string', - 'example' => 'np_4w***', - ], - 'Subtopics' => [ - 'title' => 'subtopic', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'SubTopic。', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'Status' => [ - 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Checkpoint' => [ - 'title' => '当前位点 UTC 时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'Tps' => [ - 'title' => '每秒处理事务数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Delay' => [ - 'title' => '延迟，单位秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CheckpointSampleTimestamp' => [ - 'title' => '位点采集时间。单位秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250071', - ], - 'GmtCreate' => [ - 'title' => '创建时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'GmtModify' => [ - 'title' => '修改时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'ErrorDetails' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - 'ReverseIncrSyncComponents' => [ - 'title' => '反向增量同步组件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '所在地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277', - ], - 'Ip' => [ - 'title' => '机器ip', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Identity' => [ - 'title' => '正向：项目id', - 'description' => '', - 'type' => 'string', - 'example' => 'np_4w8****', - ], - 'Subtopics' => [ - 'title' => 'subtopic', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'Subtopic。', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'Status' => [ - 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Checkpoint' => [ - 'title' => '当前位点 UTC 时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T09:19:53', - ], - 'Tps' => [ - 'title' => '每秒处理事务数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Delay' => [ - 'title' => '延迟，单位秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CheckpointSampleTimestamp' => [ - 'title' => '位点采集时间。单位秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689250049', - ], - 'GmtCreate' => [ - 'title' => '创建时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'GmtModify' => [ - 'title' => '修改时间 UTC时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T18:04:36', - ], - 'ErrorDetails' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 9,\\n \\"Cost\\": \\"48\\",\\n \\"Data\\": {\\n \\"StoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Topic\\": \\"OB_ORACLE_np_4w3r29c_4w3****\\",\\n \\"Subtopic\\": \\"OB_ORACLE_np_4w3***c_4w3**-0\\",\\n \\"Tps\\": 0,\\n \\"Delay\\": 24,\\n \\"Gmt\\": 1689250049,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T17:29:54\\",\\n \\"GmtModified\\": \\"2023-07-13T17:29:54\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"ReverseStoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shenzhen\\",\\n \\"Topic\\": \\"null\\",\\n \\"Subtopic\\": \\"null\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"Gmt\\": 1689250071,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModified\\": \\"2023-07-13T18:04:36\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"FullVerifyComponents\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:90247:0000000033\\",\\n \\"InconsistentQuantity\\": 0,\\n \\"ConsistentQuantity\\": 100,\\n \\"Progress\\": \\"100\\",\\n \\"RecordProgress\\": 100,\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"TaskId\\": 0\\n }\\n ],\\n \\"FullImportComponents\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"p_4w8v****\\",\\n \\"Progress\\": 90,\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"IncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w***\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250071,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"ReverseIncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w8****\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250049,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'ListProjectFullVerifyResult' => [ - 'summary' => '查询项目的全量校验结果', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_4w5abs****', - ], - ], - [ - 'name' => 'SourceSchemas', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '源端数据库名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'source_schema', - ], - 'required' => false, - ], - ], - [ - 'name' => 'DestSchemas', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '目标端数据库名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dest_schema', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FINISHED', - 'enum' => [ - 'RUNNING', - 'ERROR', - 'FINISHED', - 'SUSPEND', - ], - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页参数，当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页参数，每页个数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '150', - 'minimum' => '1', - 'example' => '', - 'default' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DifferentNumber' => [ - 'title' => '不一致数据总条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'FullVerifyTableStatistics' => [ - 'title' => '全量校验列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceTableName' => [ - 'title' => '源端表名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_table', - ], - 'SourceSchemaName' => [ - 'title' => '源端数据库名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_db', - ], - 'DestSchemaName' => [ - 'title' => '目标端数据库名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_db', - ], - 'SourceOnlyCount' => [ - 'title' => '仅源端存在数据条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DestOnlyCount' => [ - 'title' => '仅目的端存在数据条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MismatchedCount' => [ - 'title' => '两端不一致数据条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ConsistentCount' => [ - 'title' => '两端一致数据条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Progress' => [ - 'title' => '校验进度', - 'description' => '', - 'type' => 'string', - 'example' => '80', - ], - 'Message' => [ - 'title' => '相关信息', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Status' => [ - 'title' => '迁移状态 (RUNNING, ERROR, FINISHED, SUSPEND)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ResultType' => [ - 'title' => '校验结果类别 (RUNNING, SCHEMA_MISMATCH, INDEX_CONFLICT, TARGET_TABLE_NOT_EXIST, RUNTIME_EXCEPTION, BOTH_EMPTY, CONSISTENT, INCONSISTENT, SOURCE_EMPTY, TARGET_EMPTY, MISMATCH_LIMIT, MISMATCH_LIMIT_NO_PK, NOT_CATEGORIZED)', - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ResultDesc' => [ - 'title' => '校验结果类别描述', - 'description' => '', - 'type' => 'string', - 'example' => 'desc', - ], - 'ErrorDetails' => [ - 'title' => '表失败信息和原因', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"DifferentNumber\\": 11,\\n \\"FullVerifyTableStatistics\\": [\\n {\\n \\"SourceTableName\\": \\"source_table\\",\\n \\"SourceSchemaName\\": \\"source_db\\",\\n \\"DestSchemaName\\": \\"dest_db\\",\\n \\"SourceOnlyCount\\": 0,\\n \\"DestOnlyCount\\": 0,\\n \\"MismatchedCount\\": 0,\\n \\"ConsistentCount\\": 200,\\n \\"Progress\\": \\"80\\",\\n \\"Message\\": \\"null\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ResultType\\": \\"RUNNING\\",\\n \\"ResultDesc\\": \\"desc\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'StartProjectsByLabel' => [ - 'summary' => '启动该label下的所有未启动项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '标签ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'l_****'."\n", - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '执行的总项目数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'SucceedProjectIds' => [ - 'title' => '执行成功的项目id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'np_4w****'."\n", - ], - ], - 'FailedProjectIds' => [ - 'title' => '执行失败的项目id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'np_3w****'."\n", - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 79,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 20,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\\\n\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'StopProjectsByLabel' => [ - 'summary' => '暂停该label下的所有运行中项目', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '标签ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'l_****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'A595F34C-XXXX-5D0C-8DA8-B3ED76', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '140', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '执行的总项目数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'SucceedProjectIds' => [ - 'title' => '执行成功的项目id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'np_4w****', - ], - ], - 'FailedProjectIds' => [ - 'title' => '执行失败的项目id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'np_3w****', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"A595F34C-XXXX-5D0C-8DA8-B3ED76\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 140,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 16,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'GetUploadOssUrl' => [ - 'summary' => '公有云上传OSS 获取一个临时上传url', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '作用类型（CREATE_PROJECT）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CREATE_PROJECT', - ], - ], - [ - 'name' => 'EffectiveTimeMinutes', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' '."\n" - .'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '278', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OssUrl' => [ - 'title' => '上传文件的临时url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp_4x****pvk?Expires=169031&OSSAccessKeyId=LTAI5tMN52D***TBf&Signature=XdDFPz%2BXKC***%2B', - ], - 'OssKey' => [ - 'title' => 'ossKey', - 'description' => '', - 'type' => 'string', - 'example' => 'open_api_create_project/oacp_4xd****vk', - ], - 'ExpectedExpirationTime' => [ - 'title' => 'ossUrl 的预计失效时间 UTC 时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-26T06:33:11.175'."\n", - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"Cost\\": \\"278\\",\\n \\"Data\\": {\\n \\"OssUrl\\": \\"https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************\\",\\n \\"OssKey\\": \\"open_api_create_project/oacp_4xd****\\",\\n \\"ExpectedExpirationTime\\": \\"2023-07-26T06:33:11.175\\\\n\\"\\n }\\n}","type":"json"}]', - ], - 'ListWorkerInstances' => [ - 'summary' => '查询传输实例列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'Specs', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '实例规格', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'oms.g2m.small' => 'oms.g2m.small', - 'oms.g2m.medium' => 'oms.g2m.medium', - 'oms.g2m.large' => 'oms.g2m.large', - 'oms.g2m.xlarge' => 'oms.g2m.xlarge', - ], - 'example' => 'oms.g2m.small', - 'enum' => [], - ], - 'required' => false, - ], - ], - [ - 'name' => 'InstanceName', - 'in' => 'formData', - 'schema' => [ - 'title' => '传输实例名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i4katz****', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'formData', - 'schema' => [ - 'title' => '源端类型（OCEANBASE,TIDB,KAFKA,ROCKETMQ,POLARDB_X_1,POLARDB_X_2）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OCEANBASE', - 'enum' => [ - 'OCEANBASE', - 'KAFKA', - 'ROCKETMQ', - 'POLARDB_X_1', - 'TIDB', - 'POLARDB_X_2', - ], - ], - ], - [ - 'name' => 'DestType', - 'in' => 'formData', - 'schema' => [ - 'title' => '目标端类型（OCEANBASE,TIDB,KAFKA,ROCKETMQ,POLARDB_X_1,POLARDB_X_2）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'KAFKA', - 'enum' => [ - 'OCEANBASE', - 'KAFKA', - 'ROCKETMQ', - 'POLARDB_X_1', - 'POLARDB_X_2', - 'TIDB', - ], - ], - ], - [ - 'name' => 'OnlyBindable', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否只查询可绑定的实例(默认 true)', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'FATAL', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null'."\n", - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '237', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '71', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '传输实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'g_i4katzv***', - ], - 'Spec' => [ - 'title' => '传输实例规格', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'oms.g2m.small' => 'oms.g2m.small', - 'oms.g2m.medium' => 'oms.g2m.medium', - 'oms.g2m.large' => 'oms.g2m.large', - 'oms.g2m.xlarge' => 'oms.g2m.xlarge', - ], - 'example' => 'oms.g2m.small', - ], - 'Name' => [ - 'title' => '传输实例名称', - 'description' => '', - 'type' => 'string', - 'example' => 'i4wa71k****', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'Region' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => 'np_4kb18w****', - ], - 'ProjectName' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => 'j_migration_cloud-kafkavpc-ob', - ], - 'ProjectType' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => 'MIGRATION', - ], - 'GmtCreate' => [ - 'title' => '创建时间 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-14T20:49:53'."\n", - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Level\\": \\"FATAL\\",\\n \\"Message\\": \\"successful\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Advice\\": \\"null\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 237,\\n \\"Cost\\": \\"71\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"g_i4katzv***\\",\\n \\"Spec\\": \\"oms.g2m.small\\",\\n \\"Name\\": \\"i4wa71k****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"Region\\": \\"null\\",\\n \\"ProjectId\\": \\"np_4kb18w****\\",\\n \\"ProjectName\\": \\"j_migration_cloud-kafkavpc-ob\\",\\n \\"ProjectType\\": \\"MIGRATION\\",\\n \\"GmtCreate\\": \\"2023-07-14T20:49:53\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'CreateMySqlDataSource' => [ - 'summary' => '创建 MySQL 数据源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'source_name', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '类型：INTERNET、VPC、RDS、POLARDB、DG', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'VPC', - 'enum' => [ - 'INTERNET', - 'VPC', - 'RDS', - 'DG', - 'POLARDB', - ], - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-t4****', - ], - ], - [ - 'name' => 'DgInstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-x****', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx.xxx.xxx.1', - ], - ], - [ - 'name' => 'Port', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2883', - ], - ], - [ - 'name' => 'Schema', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_name', - ], - ], - [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pass_word', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'UseSsl', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'string', - 'example' => 'e_edz****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', - ], - 'CreateOceanBaseDataSource' => [ - 'summary' => '创建 OceanBase 数据源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'source_name', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'OB_MYSQL_VPC' => 'OB_MYSQL_VPC', - 'OB_ORACLE_VPC' => 'OB_ORACLE_VPC', - 'OB_ORACLE_TENANT' => 'OB_ORACLE_TENANT', - 'OB_ORACLE' => 'OB_ORACLE', - 'OB_MYSQL' => 'OB_MYSQL', - 'OB_MYSQL_TENANT' => 'OB_MYSQL_TENANT', - ], - 'example' => 'OB_MYSQL_VPC', - ], - ], - [ - 'name' => 'Tenant', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tenant_name', - ], - ], - [ - 'name' => 'Cluster', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster_name', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'vpc ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1d2q3mhg9i23ofi****', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx.xxx.xxx.1', - ], - ], - [ - 'name' => 'Port', - 'in' => 'formData', - 'schema' => [ - 'title' => '端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2883', - ], - ], - [ - 'name' => 'LogProxyIp', - 'in' => 'formData', - 'schema' => [ - 'title' => 'LogProxy IP', - 'description' => 'LogProxy IP。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'LogProxyPort', - 'in' => 'formData', - 'schema' => [ - 'title' => 'LogProxy 端口', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库用户名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_name', - ], - ], - [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库用户名密码（Base64编码）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pass_word', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'ConfigUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => 'OB Server 地址', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.xxx.xxx.2:2883/services?Action=ObRootServiceInfo&User_ID=alibaba&UID=ocpmaster&ObRegion=ob_1***29.admin', - ], - ], - [ - 'name' => 'DrcUserName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'sys 租户下用户名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_na***', - ], - ], - [ - 'name' => 'DrcPassword', - 'in' => 'formData', - 'schema' => [ - 'title' => 'sys 租户下用户名密码（Base64编码）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pas***', - ], - ], - [ - 'name' => 'InnerDrcPassword', - 'in' => 'formData', - 'schema' => [ - 'title' => '__oceanbase_inner_drc_user 的密码,使用base64编码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'in***', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'string', - 'example' => 'e_edz****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"null\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', - ], - 'ListDataSource' => [ - 'summary' => '查询数据源列表 (MySql、OB_MYSQL、OB_ORACLE)', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'SearchKey', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源ID或名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GRATI****89278244', - ], - ], - [ - 'name' => 'Types', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '数据源类型（MYSQL_PUBLIC,MYSQL_VPC,MYSQL_DG,OB_MYSQL_CE_PUBLIC,OB_MYSQL,OB_ORACLE,OB_MYSQL_TENANT,OB_ORACLE_TENANT,POSTGRESQL_PUBLIC,OB_MYSQL_VPC,OB_ORACLE_VPC,OB_MYSQL_PUBLIC,OB_ORACLE_PUBLIC,ORACLE_PUBLIC,ORACLE_VPC,ORACLE_DG,RDS_MYSQL,POLAR_MYSQL,ADB_MYSQL,TIDB_PUBLIC,TIDB_VPC,KAFKA_ALIYUN,KAFKA_VPC,KAFKA_PUBLIC,ROCKETMQ_PUBLIC,ROCKETMQ_ALIYUN,ROCKETMQ_VPC,DB2_LUW_PUBLIC,SYBASE_PUBLIC,DATAHUB_PUBLIC,DATAHUB_ALIYUN,DATAHUB_VPC,DBP_OP_ROUTE,DMS,IDB,POLARDB_X_1_ALIYUN,POLARDB_X_2_ALIYUN）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MYSQL_PUBLIC', - 'enum' => [ - 'MYSQL_PUBLIC', - 'MYSQL_VPC', - 'MYSQL_DG', - 'OB_MYSQL_CE_PUBLIC', - 'OB_MYSQL', - 'OB_ORACLE', - 'OB_MYSQL_TENANT', - 'OB_ORACLE_TENANT', - 'POSTGRESQL_PUBLIC', - 'OB_MYSQL_VPC', - 'OB_ORACLE_VPC', - 'OB_MYSQL_PUBLIC', - 'OB_ORACLE_PUBLIC', - 'ORACLE_PUBLIC', - 'ORACLE_VPC', - 'ORACLE_DG', - 'RDS_MYSQL', - 'POLAR_MYSQL', - 'ADB_MYSQL', - 'TIDB_PUBLIC', - 'TIDB_VPC', - 'KAFKA_ALIYUN', - 'KAFKA_VPC', - 'KAFKA_PUBLIC', - 'ROCKETMQ_PUBLIC', - 'ROCKETMQ_ALIYUN', - 'ROCKETMQ_VPC', - 'DB2_LUW_PUBLIC', - 'SYBASE_PUBLIC', - 'DATAHUB_PUBLIC', - 'DATAHUB_ALIYUN', - 'DATAHUB_VPC', - 'DBP_OP_ROUTE', - 'DMS', - 'IDB', - 'POLARDB_X_1_ALIYUN', - 'POLARDB_X_2_ALIYUN', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'SortField', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序字段（gmtCreate 、gmtModified），默认 gmtCreate', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'gmtModified' => 'gmtModified', - 'gmtCreate' => 'gmtCreate', - ], - 'example' => 'gmtCreate', - ], - ], - [ - 'name' => 'Order', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序（降序 descend ， 升序：asc），默认 descend', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'descend', - 'default' => 'descend', - 'enum' => [ - 'descend', - 'asc', - ], - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页参数，当前页', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页参数，每页个数，默认10，最大150', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - 'maxLength' => 150, - 'minLength' => 1, - 'default' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '132', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '28', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '数据源终端标识', - 'description' => '', - 'type' => 'string', - 'example' => 'e_4w****v', - ], - 'Name' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'example' => 'RATION***1DBUTF11', - ], - 'Type' => [ - 'title' => '数据源类型 (MYSQL_PUBLIC,MYSQL_VPC,MYSQL_DG,OB_MYSQL_CE_PUBLIC,OB_MYSQL,OB_ORACLE,OB_MYSQL_TENANT,OB_ORACLE_TENANT,POSTGRESQL_PUBLIC,OB_MYSQL_VPC,OB_ORACLE_VPC,OB_MYSQL_PUBLIC,OB_ORACLE_PUBLIC,ORACLE_PUBLIC,ORACLE_VPC,ORACLE_DG,RDS_MYSQL,POLAR_MYSQL,ADB_MYSQL,TIDB_PUBLIC,TIDB_VPC,KAFKA_ALIYUN,KAFKA_VPC,KAFKA_PUBLIC,ROCKETMQ_PUBLIC,ROCKETMQ_ALIYUN,ROCKETMQ_VPC,DB2_LUW_PUBLIC,SYBASE_PUBLIC,DATAHUB_PUBLIC,DATAHUB_ALIYUN,DATAHUB_VPC,DBP_OP_ROUTE,DMS,IDB,POLARDB_X_1_ALIYUN,POLARDB_X_2_ALIYUN)', - 'description' => '', - 'type' => 'string', - 'example' => 'MYSQL_PUBLIC', - 'enum' => [ - 'MYSQL_PUBLIC', - 'MYSQL_VPC', - 'MYSQL_DG', - 'OB_MYSQL_CE_PUBLIC', - 'OB_MYSQL', - 'OB_ORACLE', - 'OB_MYSQL_TENANT', - 'OB_ORACLE_TENANT', - 'POSTGRESQL_PUBLIC', - 'OB_MYSQL_VPC', - 'OB_ORACLE_VPC', - 'OB_MYSQL_PUBLIC', - 'OB_ORACLE_PUBLIC', - 'ORACLE_PUBLIC', - 'ORACLE_VPC', - 'ORACLE_DG', - 'RDS_MYSQL', - 'POLAR_MYSQL', - 'ADB_MYSQL', - 'TIDB_PUBLIC', - 'TIDB_VPC', - 'KAFKA_ALIYUN', - 'KAFKA_VPC', - 'KAFKA_PUBLIC', - 'ROCKETMQ_PUBLIC', - 'ROCKETMQ_ALIYUN', - 'ROCKETMQ_VPC', - 'DB2_LUW_PUBLIC', - 'SYBASE_PUBLIC', - 'DATAHUB_PUBLIC', - 'DATAHUB_ALIYUN', - 'DATAHUB_VPC', - 'DBP_OP_ROUTE', - 'DMS', - 'IDB', - 'POLARDB_X_1_ALIYUN', - 'POLARDB_X_2_ALIYUN', - ], - ], - 'Role' => [ - 'title' => '数据源角色 (MASTER, SLAVE)', - 'description' => '', - 'type' => 'string', - 'example' => 'MASTER', - 'enum' => [ - 'MASTER', - 'SLAVE', - ], - ], - 'Owner' => [ - 'title' => '数据源Owner', - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'Tenant' => [ - 'title' => '租户名称或ID （专有云、VPC 对应名称）', - 'description' => '', - 'type' => 'string', - 'example' => 'tenant_name', - ], - 'Cluster' => [ - 'title' => '集群名称或ID (专有云、VPC 对应名称)', - 'description' => '', - 'type' => 'string', - 'example' => 'cluster_name', - ], - 'Schema' => [ - 'title' => '数据库名，若填写，后续迁移或者同步操作，只会针对该数据库操作； (专有云参数)', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'VpcId' => [ - 'title' => 'vpc id （公有云参数）', - 'description' => '', - 'type' => 'string', - 'example' => 'vpc_t4***', - ], - 'Ip' => [ - 'title' => 'ip（专有云、VPC）', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.xxx.xxx.1', - ], - 'Port' => [ - 'title' => '端口（专有云、VPC）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2883', - ], - 'UserName' => [ - 'title' => '数据库连接用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'user_name', - ], - 'Region' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'Description' => [ - 'title' => '自定义描述信息,最长 128 个字符', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'OracleSid' => [ - 'title' => 'ORACLE的sid', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OracleNlsLengthSemantics' => [ - 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'OperatingSystem' => [ - 'title' => '操作系统，ob 没有。', - 'description' => '', - 'type' => 'string', - 'example' => 'Linux', - ], - 'Version' => [ - 'title' => '版本', - 'description' => '', - 'type' => 'string', - 'example' => '4.1.0', - ], - 'Timezone' => [ - 'title' => '时区', - 'description' => '', - 'type' => 'string', - 'example' => '+08:00', - ], - 'Charset' => [ - 'title' => '编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'ResourceOwner' => [ - 'title' => '资源所有者', - 'description' => '', - 'type' => 'string', - 'example' => '178641****05809', - ], - 'GmtCreate' => [ - 'title' => '创建时间 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T20:27:28.000+00:00', - ], - 'GmtModified' => [ - 'title' => '修改时间 UTC', - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-13T20:37:28.000+00:00', - ], - 'PartnerId' => [ - 'title' => '对应主备库ID', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ConnExtraAttributes' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 132,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"e_4w****v\\",\\n \\"Name\\": \\"RATION***1DBUTF11\\",\\n \\"Type\\": \\"MYSQL_PUBLIC\\",\\n \\"Role\\": \\"MASTER\\",\\n \\"Owner\\": \\"admin\\",\\n \\"Tenant\\": \\"tenant_name\\",\\n \\"Cluster\\": \\"cluster_name\\",\\n \\"Schema\\": \\"schema_name\\",\\n \\"VpcId\\": \\"vpc_t4***\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883,\\n \\"UserName\\": \\"user_name\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Description\\": \\"test\\",\\n \\"OracleSid\\": \\"null\\",\\n \\"OracleNlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Version\\": \\"4.1.0\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"ResourceOwner\\": \\"178641****05809\\",\\n \\"GmtCreate\\": \\"2023-07-13T20:27:28.000+00:00\\",\\n \\"GmtModified\\": \\"2023-07-13T20:37:28.000+00:00\\",\\n \\"PartnerId\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'CreateLabel' => [ - 'summary' => '创建标签', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'string', - 'example' => 'l_****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"l_****\\"\\n}","type":"json"}]', - ], - 'ListAllLabels' => [ - 'summary' => '查询标签列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null ', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '29', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => '', - 'type' => 'string', - 'example' => 'l_4w6r0***', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null \\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"l_4w6r0***\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'CreateOmsMysqlDataSource' => [ - 'summary' => 'You can call this operation to create a MySQL data source. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源名称。长度为2~128个英文或中文字符。可以包含数字、下划线（_）、半角句号（.）或者短划线（-）。不能包含“/”等非法字符', - 'description' => 'The name of the data source. '."\n" - .'It must be 2 to 128 characters in length and can contain letters, digits, underscores (_), periods (.), and hyphens (-). '."\n" - ."\n" - .'>
Invalid characters, such as slashes (/), are not allowed.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'oms-mysql', - 'enum' => [], - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '所有 mysql 的类型 枚举：'."\n" - .'INTERNET、VPC、RDS、POLARDB、DG', - 'description' => 'The type of the MySQL data source. '."\n" - .'Valid values: INTERNET, VPC, RDS, PolarDB, and DG.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INTERNET', - 'enum' => [], - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源所属VPC ID。若Type为VPC则该字段必填。', - 'description' => 'The ID of the VPC to which the data source belongs. '."\n" - ."\n" - .'>
If Type is set to VPC, this parameter is required. ', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-12345abcde*******', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源云实例ID。若Type为RDS、POLARDB、DG该字段必填。', - 'description' => 'The ID of the ECS instance of the data source. '."\n" - ."\n" - .'>
If Type is set to RDS, PolarDB, or DG, this parameter is required.', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-12ab34cd56******', - 'enum' => [], - ], - ], - [ - 'name' => 'DgDatabaseId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'database gateway，数据库网关实例 id。若Type为 DG，该字段必填。', - 'description' => 'The ID of the database gateway instance. '."\n" - ."\n" - .'>
If Type is set to DG, this parameter is required. ', - 'type' => 'string', - 'required' => false, - 'example' => 'dg-yhss6sdlaff****', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源 ip 地址。若Type为INTERNET、VPC该字段必填。', - 'description' => 'The IP address of the data source. '."\n" - ."\n" - .'>
If Type is set to INTERNET or VPC, this parameter is required. ', - 'type' => 'string', - 'required' => false, - 'example' => '10.0.****', - ], - ], - [ - 'name' => 'Port', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源端口。若Type为INTERNET、VPC该字段必填。', - 'description' => 'The port number of the data source. '."\n" - ."\n" - .'>
If Type is set to INTERNET or VPC, this parameter is required. ', - 'type' => 'string', - 'required' => false, - 'example' => '3306', - ], - ], - [ - 'name' => 'Schema', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名。若填写，后续迁移或者同步操作，只会针对该数据库操作；', - 'description' => 'The name of the database. '."\n" - ."\n" - .'>
If you specify this parameter, subsequent migration or synchronization operations will take effect on this database only. ', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Username', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库连接用户名。', - 'description' => 'The username that is used to access the database. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'omsTestUser', - ], - ], - [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库连接密码，待加密明文（必须经过Base64编码）。', - 'description' => 'The password of the username that is used to access the database. It must be Base64 encoded. '."\n" - .'For example, for the password abcd123@!, the Base64-encoded value is YWJjZDEyM0Ah. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'YWJjZDEyM0Ah', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据源的描述。长度为2~256个英文或中文字符。默认值为空。', - 'description' => 'The description of the data source. '."\n" - ."\n" - .'It must be 2 to 256 characters in length. The default value is null.', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL data source for OMS testing', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Data' => [ - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'EndpointId' => [ - 'description' => 'The ID of the data source record. ', - 'type' => 'string', - 'example' => 'e_1234abcd*****', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": {\\n \\"EndpointId\\": \\"e_1234abcd*****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n e_1234abcd*****\\n \\n","errorExample":""}]', - 'title' => ' ', - 'description' => 'To call this operation, you must add the IP address of the OceanBase Migration Service (OMS) server to the whitelist of the Alibaba Cloud database instance, the security rules of the ECS instance, or the security settings of your self-managed database (usually the firewall of your self-managed database) to ensure that OMS can successfully access your database instance. To obtain the IP address of the OMS server, go to the OMS data source management page in the OMS console.', - ], - 'ReleaseWorkerInstance' => [ - 'summary' => '释放传输实例 （未绑定项目时才可以释放）', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '传输实例 ID （g_xxx）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'g_abcdefj***', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'CancelProjectModifyRecord' => [ - 'summary' => '根据记录id取消修改操作 （仅支持处于 PENDING 状态的修改记录）', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '修改记录 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '344000005', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'RetryProjectModifyRecords' => [ - 'summary' => '根据修改记录 ID 重试修改操作（仅支持处于 FAILED 状态的修改记录）', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '修改记录 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '344000005', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'StopProjectModifyRecords' => [ - 'summary' => '根据修改记录 ID 终止修改操作，不可恢复（仅支持处于 RUNNING / FAILED 状态的修改记录）', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '修改记录 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '344000005', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'ListProjectModifyRecords' => [ - 'summary' => '根据项目 ID 查询项目的修改记录', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_598jmu****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '修改记录 id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '344000005', - ], - 'SubProjectId' => [ - 'title' => '子项目 id（增表时产生）', - 'description' => '', - 'type' => 'string', - 'example' => 'np_598qm***', - ], - 'MergeRequestId' => [ - 'title' => '合并父子项目的工单 id，用于加表场景', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'id', - ], - 'UpdateRequestId' => [ - 'title' => '更新父项目工单 id，用于减表或已有表对象更新场景', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'id', - ], - 'Type' => [ - 'title' => '修改记录任务类型 (INCREASE_OBJECT: 增加对象, DECREASE_OBJECT: 减少对象)', - 'description' => '', - 'type' => 'string', - 'example' => 'INCREASE_OBJECT', - ], - 'Status' => [ - 'title' => '修改记录状态 (PENDING: 待执行, MODIFYING: 修改中（减表修改父项目工单的执行，加表创建子项目）, RUNNING: 运行中（子项目运行中）, MERGING: 合并中（父子项目符合合并条件）, TERMINATED: 已终止, SUCCESS: 成功, FAILED: 失败, CANCEL: 已取消)', - 'description' => '', - 'type' => 'string', - 'example' => 'PENDING', - ], - 'ErrorDetail' => [ - 'title' => '错误详情，修改记录状态处于', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.'."\n", - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', + 'TransferMapping' => [ + 'title' => '', + 'description' => 'The mapping relationships of the transfer objects.', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The object mapping mode. Valid values: `SPECIFIC` (specified objects) and `WILDCARD` (matching rules).', 'type' => 'string', 'title' => '', 'example' => 'SPECIFIC'], + 'Databases' => [ + 'description' => 'The list of database objects.', + 'type' => 'array', + 'items' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Databases' => [ - 'title' => '减少的对象（同步）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MappedName' => [ - 'title' => '映射对象 database', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_db', - ], - 'Name' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'example' => 'db_name', - ], - 'Id' => [ - 'title' => '库 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'db_id', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MappedName' => [ - 'title' => '映射对象 table/topic', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'Id' => [ - 'title' => '表 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤表', - 'description' => '', - 'type' => 'string', - 'example' => 'id < 1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', + 'properties' => [ + 'Type' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'MYSQL', 'title' => ''], + 'Id' => ['description' => 'The database ID.', 'type' => 'string', 'example' => 'db_id', 'title' => ''], + 'Name' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'db_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped database name.', 'type' => 'string', 'example' => 'mapped_db', 'title' => ''], + 'TenantName' => ['description' => 'The tenant of the mapped object. This parameter takes effect when the source is an OceanBase data source.', 'type' => 'string', 'example' => 'tenant_name', 'title' => ''], + 'Tables' => [ + 'description' => 'The configuration of tables to be transferred in the current database. When `Mode` is set to `WILDCARD`, this parameter specifies the configurations of the blacklist or whitelist. Tables and views share the same configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped table name.', 'type' => 'string', 'example' => 'mapped_table', 'title' => ''], + 'Id' => ['description' => 'The table ID.', 'type' => 'string', 'example' => 'table_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id > 1', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'Columns' => [ - 'title' => '列列表', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'description' => '', - 'type' => 'string', - 'example' => 'col_name', - ], - 'MappedName' => [ - 'title' => '列映射名', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_col', - ], - 'Position' => [ - 'title' => '字段位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FLOAT', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', - 'description' => '', - 'type' => 'string', - 'example' => 'INT8', + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRI', + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Views' => [ + 'description' => 'The configuration list of view objects to be transferred in the current database.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The view name.', 'type' => 'string', 'example' => 'view_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped view name.', 'type' => 'string', 'example' => 'mapped_view', 'title' => ''], + 'Id' => ['description' => 'The view ID.', 'type' => 'string', 'example' => 'fexdg***', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id < 1', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Nullable' => [ - 'title' => '是否可为空', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SpecificTables' => [ + 'description' => 'The configuration collection of specific table objects. When `mode` is set to `WILDCARD`, this parameter specifies the renaming and row filtering configurations of specific table objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped table name.', 'type' => 'string', 'example' => 'mapped_table', 'title' => ''], + 'Id' => ['description' => 'The table ID.', 'type' => 'string', 'example' => 'table_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id>1', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DataLength' => [ - 'title' => '字段长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DataPrecision' => [ - 'title' => '精度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SpecificViews' => [ + 'description' => 'The configuration list of specific view objects. When `mode` is set to `WILDCARD`, this parameter specifies the renaming configuration of specific view objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The view name.', 'type' => 'string', 'example' => 'view_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped view name.', 'type' => 'string', 'example' => 'mapped_name', 'title' => ''], + 'Id' => ['description' => 'The view ID.', 'type' => 'string', 'example' => 'view_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id<3', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'DataScale' => [ - 'title' => '小数点', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Encoding' => [ - 'title' => '字符编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf8', + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DatabasesBlack' => [ + 'description' => 'Matching rule mode: the database object blacklist.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Valid values: DATABASE and TABLE.', 'type' => 'string', 'example' => 'DATABASE', 'title' => ''], + 'Id' => ['description' => 'The database object ID.', 'type' => 'string', 'example' => 'db_id', 'title' => ''], + 'Name' => ['description' => 'The database object name.', 'type' => 'string', 'example' => 'db_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped database name.', 'type' => 'string', 'example' => 'mapped_db', 'title' => ''], + 'TenantName' => ['description' => 'The tenant of the mapped object. This parameter takes effect when the source is OceanBase.', 'type' => 'string', 'example' => 'mapped_tenant', 'title' => ''], + 'Tables' => [ + 'description' => 'The configuration of tables to be transferred in the current database. When `Mode` is set to `WILDCARD`, this parameter specifies the configurations of the blacklist or whitelist. Tables and views share the same configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped table name.', 'type' => 'string', 'example' => 'mapped_table', 'title' => ''], + 'Id' => ['description' => 'The table ID.', 'type' => 'string', 'example' => 'table_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id>1', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'description' => '', - 'type' => 'string', - 'example' => 'comments', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Views' => [ + 'description' => 'The configuration list of view objects to be transferred in the current database.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The view name.', 'type' => 'string', 'example' => 'view_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped view name.', 'type' => 'string', 'example' => 'mapped_name', 'title' => ''], + 'Id' => ['description' => 'The view ID.', 'type' => 'string', 'example' => 'view_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id>2', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'title' => 'DATABASE, TABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'DATABASE', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'AdbTableSchema' => [ - 'title' => 'ADB table schema', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SpecificTables' => [ + 'description' => 'The configuration collection of specific table objects. When `mode` is set to `WILDCARD`, this parameter specifies the renaming and row filtering configurations of specific table objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped table name.', 'type' => 'string', 'example' => 'mapped_table', 'title' => ''], + 'Id' => ['description' => 'The table ID.', 'type' => 'string', 'example' => 'table_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id<3', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MappedName' => [ - 'title' => '映射对象 table/topic', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_view', - ], - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'Id' => [ - 'title' => '表 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤表', - 'description' => '', - 'type' => 'string', - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', + 'SpecificViews' => [ + 'description' => 'The configuration list of specific view objects. When `mode` is set to `WILDCARD`, this parameter specifies the renaming configuration of specific view objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The view name.', 'type' => 'string', 'example' => 'view_name', 'title' => ''], + 'MappedName' => ['description' => 'The mapped view name.', 'type' => 'string', 'example' => 'mapped_view', 'title' => ''], + 'Id' => ['description' => 'The view ID.', 'type' => 'string', 'example' => 'view_id', 'title' => ''], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'example' => 'id>2', 'title' => ''], + 'FilterColumns' => [ + 'description' => 'The filter column collection.', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', + 'ShardColumns' => [ + 'description' => 'The sharding key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'Columns' => [ - 'title' => '列列表', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'AdbTableSchema' => [ + 'description' => 'The mapping information of the ADB data source.', 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'description' => '', - 'type' => 'string', - 'example' => 'col_name', - ], - 'MappedName' => [ - 'title' => '列映射名', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Position' => [ - 'title' => '字段位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FLOAT', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', - 'description' => '', - 'type' => 'string', - 'example' => 'INT8', - ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRI', - ], - 'Nullable' => [ - 'title' => '是否可为空', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'DataLength' => [ - 'title' => '字段长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'DataPrecision' => [ - 'title' => '精度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'DataScale' => [ - 'title' => '小数点', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'Encoding' => [ - 'title' => '字符编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf16', - ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'description' => '', - 'type' => 'string', - 'example' => 'comments', - ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'PrimaryKeys' => [ + 'description' => 'The primary key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'title' => 'DATABASE, TABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'DATABASE', + 'DistributedKeys' => [ + 'description' => 'The distribution key column collection.', + 'type' => 'array', + 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')'."\n", 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The table lifecycle.', 'type' => 'string', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TableAndViewWhiteList' => [ + 'description' => 'Matching rule mode: the wildcard whitelist of tables and views.', + 'type' => 'array', + 'items' => ['description' => 'Matching rule mode: the wildcard whitelist of tables and views.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'TableAndViewBlackList' => [ + 'description' => 'Matching rule mode: the wildcard blacklist of tables and views.', + 'type' => 'array', + 'items' => ['description' => 'Matching rule mode: the wildcard blacklist of tables and views.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'CommonTransferConfig' => [ + 'title' => '', + 'description' => 'The common transfer configuration.', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => ['description' => 'The supported table types. Valid values: ALL (all tables), WITH\\_UNIQUE\\_ROW\\_ID (tables with unique row identifiers), and WITHOUT\\_UNIQUE\\_ROW\\_ID (tables without unique row identifiers). Default value: ALL.', 'type' => 'string', 'title' => '', 'example' => 'ALL'], + 'ActiveActive' => ['description' => 'Indicates whether the active-active disaster recovery scenario is used.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'MqSerializerType' => ['description' => 'The JSON serialization type for data delivered to a message queue. Valid values: DEFAULT, CANAL, DATAWORKS\\_V2, SHAREPLEX, DEFAULT\\_WITH\\_SCHEMA, DEBEZIUM, DEBEZIUMFLATTEN, and DEBEZIUMSMT.', 'type' => 'string', 'title' => '', 'example' => 'DEFAULT'], + 'MqPartitionMode' => ['description' => 'The partition routing method for data delivered to a message queue. Valid values: ONE (deliver to a specified partition), HASH (perform hash-based partition delivery based on primary key or sharding column values), and TABLE (perform hash-based partition delivery based on database and table names).', 'type' => 'string', 'title' => '', 'example' => 'ONE'], + 'MqPartition' => ['description' => 'When `partitionMode` is set to `ONE`, this parameter specifies the position of the partition to which data is delivered under the current topic.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'DatahubTopicType' => [ + 'description' => 'The topic type when delivering data to the DataHub message queue.', + 'enumValueTitles' => ['BLOB' => 'BLOB', 'TUPLE' => 'TUPLE'], + 'type' => 'string', + 'title' => '', + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => ['description' => 'The producer group name. This parameter takes effect when the destination is ROCKETMQ. Default value: OMS.', 'type' => 'string', 'title' => '', 'example' => 'OMS'], + 'RocketMqMsgTags' => ['description' => 'The message tag. This parameter takes effect when the destination is ROCKETMQ. Default value: default -> default\\_tag.', 'type' => 'string', 'title' => '', 'example' => 'default_tag'], + 'RocketMqEnableMsgTrace' => ['description' => 'Indicates whether message tracing is enabled. This parameter takes effect when the destination is ROCKETMQ.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RocketMqSendMsgTimeout' => ['description' => 'The message delivery timeout period. This parameter takes effect when the destination is ROCKETMQ.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataWorksBusinessName' => ['description' => 'The business system identifier (optional).', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SinkStoreFormat' => ['title' => 'Operational System identity (optional)', 'description' => 'The business system identifier (optional).', 'type' => 'string', 'example' => 'null'], + 'SourceStoreFormat' => ['title' => 'Operational System identity (optional)', 'description' => 'The business system identifier (optional).', 'type' => 'string', 'example' => 'null'], + ], + 'example' => '', + ], + 'EnableStructTransfer' => ['description' => 'Indicates whether structure transfer is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'StructTransferConfig' => [ + 'title' => '', + 'description' => 'The structure transfer configuration.', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => ['description' => 'The byte/char conversion strategy. Valid values: `IGNORE_BYTE_IF_BYTE_USED`, `FORCE_CHAR_IF_BYTE_USED`, `EXPAND_LEN_IF_BYTE_USED`, and `DO_NOTHING_IF_BYTE_USED` (default).', 'type' => 'string', 'title' => '', 'example' => 'DO_NOTHING_IF_BYTE_USED'], + 'DeferIndexCreation' => ['description' => 'Indicates whether deferred index creation is allowed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + 'EnableFullTransfer' => ['description' => 'Indicates whether full transfer is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableFullVerify' => ['description' => 'Indicates whether full verification is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'FullTransferConfig' => [ + 'title' => '', + 'description' => 'The full transfer configuration.', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => ['description' => 'Indicates whether to truncate the destination table during full migration of source tables that do not have unique indexes.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'AllowDestTableNotEmpty' => ['description' => 'The processing strategy when the destination table contains records. Valid values: **Ignore** and **Stop migration**.'."\n" + ."\n" + .'- Set to true to ignore: If the destination table contains data that conflicts with incoming data, the system logs the conflict and keeps the original data.'."\n" + ."\n\n" + .' >'."\n" + ."\n" + .' If you select Ignore, full verification uses IN mode to pull data. This mode cannot verify extra data in the destination and degrades verification performance.'."\n" + ."\n" + .' >'."\n" + .'- Set to false to stop migration: If the destination table contains data, full migration fails. Clear the destination data before continuing.'."\n" + ."\n\n" + .' >'."\n" + ."\n" + .' If you click Resume after an error, the system ignores this configuration and continues migrating table data. Proceed with caution.'."\n" + ."\n" + .' >', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'FullTransferSpeedMode' => ['description' => 'The concurrency speed for full migration. Valid values: STEADY, NORMAL, and FAST.', 'type' => 'string', 'title' => '', 'example' => 'FAST'], + 'FullVerifySpeedMode' => ['description' => 'The concurrency speed for full verification. Valid values: STEADY, NORMAL, and FAST.', 'type' => 'string', 'title' => '', 'example' => 'FAST'], + 'WriteWorkerNum' => ['title' => 'Write concurrency', 'description' => 'The write concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '64'], + 'ReadWorkerNum' => ['title' => 'Read concurrency '."\n", 'description' => 'The read concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '64'], + 'ThrottleRps' => ['title' => 'RPS limit '."\n", 'description' => 'The maximum transfer rate during full transfer, measured in records per second (RPS). A null value indicates no RPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'ThrottleIOPS' => ['title' => 'Traffic limit, in bytes '."\n", 'description' => 'The maximum transfer throughput during full transfer, measured in bytes per second. A null value indicates no IOPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + ], + 'example' => '', + ], + 'EnableIncrTransfer' => ['description' => 'Indicates whether incremental transfer is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableIncrVerify' => ['description' => 'Indicates whether incremental verification is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableReverseIncrTransfer' => ['description' => 'Indicates whether reverse incremental synchronization is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IncrTransferConfig' => [ + 'title' => '', + 'description' => 'The incremental synchronization configuration.', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => ['description' => 'The start timestamp for incremental synchronization. You can set this parameter only when incremental synchronization is enabled but full transfer is not.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1667286900'], + 'RecordTypeWhiteList' => [ + 'title' => '', + 'description' => 'The types of incremental data to synchronize during incremental synchronization.', + 'type' => 'array', + 'items' => [ + 'description' => 'The types of incremental data to synchronize during incremental synchronization.', + 'enumValueTitles' => ['DELETE' => 'DELETE', 'COMMIT' => 'COMMIT', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE', 'BEGIN' => 'BEGIN', 'ROW' => 'ROW', 'HEARTBEAT' => 'HEARTBEAT', 'DDL' => 'DDL', 'ROLLBACK' => 'ROLLBACK'], + 'type' => 'string', + 'example' => 'INSERT', + 'title' => '', + ], + 'example' => '', + ], + 'StoreLogKeptHour' => ['description' => 'The log retention period in hours when Store is used as the incremental log pull component during incremental synchronization. Default value: 168 hours (7 days). Maximum value: 8760 hours (365 days).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '24'], + 'EnableSequencingWithinTxn' => ['description' => 'Indicates whether to enable sequencing within transactions when Store is used as the incremental log pull component during incremental synchronization.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'IncrSyncConcurrency' => ['description' => 'The number of threads for incremental synchronization. Default value: 64.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'EnableIncrSyncStatistics' => ['description' => 'Indicates whether to enable statistics collection for incremental records (DML and DDL).', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ThrottleRps' => ['title' => 'RPS limit', 'description' => 'The maximum transfer rate during incremental transfer, measured in records per second (RPS). A null value indicates no RPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'ThrottleIOPS' => ['title' => 'Traffic limit in bytes', 'description' => 'The maximum transfer throughput during incremental transfer, measured in bytes per second. A null value indicates no IOPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'SupportDDLTypes' => [ + 'description' => 'The DDL types supported during incremental transfer.', + 'type' => 'array', + 'items' => [ + 'description' => 'The DDL types supported during incremental transfer.', + 'enumValueTitles' => ['DROP_INDEX' => 'DROP\\_INDEX', 'RENAME_TABLE' => 'RENAME\\_TABLE', 'DROP_TABLE' => 'DROP\\_TABLE', 'TRUNCATE_TABLE' => 'TRUNCATE\\_TABLE', 'ALTER_TABLE' => 'ALTER\\_TABLE', 'CREATE_TABLE' => 'CREATE\\_TABLE', 'CREATE_INDEX' => 'CREATE\\_INDEX'], + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'ReverseIncrTransferConfig' => [ + 'description' => 'The reverse incremental configuration.', + 'title' => 'Reverse Incremental Configuration', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => ['title' => 'When incremental synchronization is selected and full synchronization is not selected, you can set the start offset for incremental synchronization as a UNIX timestamp in seconds.', 'description' => 'When incremental synchronization is enabled but full transfer is not, you can set the start timestamp for incremental synchronization as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1687363200'], + 'RecordTypeWhiteList' => [ + 'description' => 'The data types to synchronize during reverse incremental transfer.', + 'title' => 'Incremental data types to synchronize during the incremental synchronization phase', + 'type' => 'array', + 'items' => [ + 'description' => 'The data types to synchronize during reverse incremental transfer.', + 'enumValueTitles' => ['DELETE' => 'DELETE', 'COMMIT' => 'COMMIT', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE', 'BEGIN' => 'BEGIN', 'ROW' => 'ROW', 'HEARTBEAT' => 'HEARTBEAT', 'DDL' => 'DDL', 'ROLLBACK' => 'ROLLBACK'], + 'type' => 'string', + 'example' => 'INSERT', + 'title' => '', + ], + 'example' => '', + ], + 'StoreLogKeptHour' => ['title' => 'Log retention time in hours when incremental synchronization is enabled and the incremental log pull widget is Store. Default is 7 days, maximum is 365 days.', 'description' => 'The log retention period in hours when Store is used as the incremental log pull component during incremental synchronization. Default value: 168 hours (7 days). Maximum value: 8760 hours (365 days).', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], + 'EnableSequencingWithinTxn' => ['title' => 'Indicates whether sequencing within a transaction is enabled when incremental synchronization is enabled and the incremental log pull widget is Store.', 'description' => 'Indicates whether to enable sequencing within transactions when Store is used as the incremental log pull component during incremental synchronization.', 'type' => 'boolean', 'example' => 'true'], + 'IncrSyncConcurrency' => ['title' => 'Number of threads for incremental synchronization, default 64', 'description' => 'The number of threads for incremental synchronization. Default value: 64.', 'type' => 'integer', 'format' => 'int32', 'example' => '64'], + 'EnableIncrSyncStatistics' => ['title' => 'Whether to enable statistics for incremental records (DML, DDL)', 'description' => 'Indicates whether to enable statistics collection for incremental records (DML and DDL).', 'type' => 'boolean', 'example' => 'true'], + 'ThrottleRps' => ['title' => 'Limit on records per second (RPS)', 'description' => 'The maximum transfer rate during reverse incremental transfer, measured in records per second (RPS). A null value indicates no RPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'ThrottleIOPS' => ['title' => 'Traffic limit in bytes per second', 'description' => 'The maximum transfer throughput during reverse incremental transfer, measured in bytes per second. A null value indicates no IOPS limit.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'SupportDDLTypes' => [ + 'description' => 'The DDL types supported during reverse incremental transfer.', + 'type' => 'array', + 'items' => [ + 'description' => 'The DDL types supported during reverse incremental transfer.', + 'enumValueTitles' => ['DROP_INDEX' => 'DROP\\_INDEX', 'RENAME_TABLE' => 'RENAME\\_TABLE', 'DROP_TABLE' => 'DROP\\_TABLE', 'TRUNCATE_TABLE' => 'TRUNCATE\\_TABLE', 'ALTER_TABLE' => 'ALTER\\_TABLE', 'CREATE_TABLE' => 'CREATE\\_TABLE', 'CREATE_INDEX' => 'CREATE\\_INDEX'], + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'SourceConnectInfo' => [ + 'title' => '', + 'description' => 'The connection information of the source node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The connection ID.', 'type' => 'string', 'title' => '', 'example' => 'c_feg****'], + 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'migon****'], + 'EndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'title' => '', 'example' => 'e_3kx5i***1s'], + 'EndpointSide' => ['description' => 'The endpoint type. Valid values: `source` (source) and `dest` (destination).', 'type' => 'string', 'title' => '', 'example' => 'source'], + 'DbEngine' => ['description' => 'The database engine of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'OB_MYSQL_PUBLIC'], + 'ConnectionInfo' => ['description' => 'The connection information of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Username' => ['description' => 'The connection username.', 'type' => 'string', 'title' => '', 'example' => 'oms2027obmysql@oms_***'], + 'Version' => ['description' => 'The database version.', 'type' => 'string', 'title' => '', 'example' => '2.2.77'], + 'Timezone' => ['description' => 'The database timezone.', 'type' => 'string', 'title' => '', 'example' => '+08:00'], + 'Charset' => ['description' => 'The character encoding.', 'type' => 'string', 'title' => '', 'example' => 'utf8mb4'], + 'NlsLengthSemantics' => ['description' => 'The nlsLengthSemantics attribute. This parameter applies only to Oracle databases and OceanBase databases with Oracle tenants.', 'type' => 'string', 'title' => '', 'example' => 'null'."\n"], + 'OperatingSystem' => ['description' => 'The operating system. This parameter does not apply to OceanBase databases.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'OcpName' => ['description' => 'The OCP name.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ConnExtraAttributes' => ['description' => 'The additional connection attributes. For specific fields, see the "Appendix" section.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'Owner' => ['title' => 'owner', 'description' => 'The owner.', 'type' => 'string', 'example' => 'oms_test'], + 'ResourceOwner' => ['description' => 'The UID of the resource owner.', 'type' => 'string', 'title' => '', 'example' => '1325847***'."\n"], + 'Host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1', 'title' => ''], + 'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '2883', 'title' => ''], + ], + 'example' => '', + ], + 'SinkConnectInfo' => [ + 'title' => '', + 'description' => 'The connection information of the destination node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The connection ID.', 'type' => 'string', 'title' => '', 'example' => 'e_4lgzuzi9znr4'], + 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'RATION12948*****'], + 'EndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'title' => '', 'example' => 'e_4w1q****'], + 'EndpointSide' => ['description' => 'The endpoint type. Valid values: `source` (source) and `dest` (destination).', 'type' => 'string', 'title' => '', 'example' => 'sink'], + 'DbEngine' => ['description' => 'The database engine of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'MYSQL_PUBLIC'], + 'ConnectionInfo' => ['description' => 'The connection information of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Username' => ['description' => 'The connection username.', 'type' => 'string', 'title' => '', 'example' => 'oms2027obmysql@oms_***'."\n"], + 'Version' => ['description' => 'The database version.', 'type' => 'string', 'title' => '', 'example' => '2.2.77'], + 'Timezone' => ['description' => 'The database timezone.', 'type' => 'string', 'title' => '', 'example' => '+08:00'], + 'Charset' => ['description' => 'The character encoding.', 'type' => 'string', 'title' => '', 'example' => 'utf8mb4'], + 'NlsLengthSemantics' => ['description' => 'The nlsLengthSemantics attribute. This parameter applies only to Oracle databases and OceanBase databases with Oracle tenants.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OperatingSystem' => ['description' => 'The operating system. This parameter does not apply to OceanBase databases.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'OcpName' => ['description' => 'The OCP name.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ConnExtraAttributes' => ['description' => 'The additional connection attributes. For specific fields, see the "Appendix" section.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'Owner' => ['title' => 'owner', 'description' => 'The owner.', 'type' => 'string', 'example' => 'oms_test'], + 'ResourceOwner' => ['description' => 'The UID of the resource owner.', 'type' => 'string', 'title' => '', 'example' => '1325847***'."\n"], + 'Host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'."\n", 'title' => ''], + 'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '2883', 'title' => ''], + ], + 'example' => '', + ], + 'Steps' => [ + 'title' => '', + 'description' => 'The step list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Order' => ['description' => 'The execution order of the step.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Name' => ['description' => 'The step name.', 'type' => 'string', 'title' => '', 'example' => 'PRE_CHECK'], + 'Description' => ['description' => 'The step description (precheck, schema migration, schema synchronization, full migration, full synchronization, full verification, index migration, incremental log pull, incremental synchronization, incremental verification, or forward switchover).', 'type' => 'string', 'title' => '', 'example' => '预检查'], + 'Status' => ['description' => 'The step status. Valid values: INIT (initializing), RUNNING (running), FAILED (failed), FINISHED (completed), SUSPEND (suspended), and MONITORING (monitoring state for incremental synchronization and incremental verification).', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'Supplementary information (JSON)', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => ' '."\n" + .'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The placeholder values for the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The placeholder values for the Message parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The placeholder values for the MessageMcmsKey parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The placeholder values for the MessageMcmsKey parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'Contact the administrator. '."\n" + ."\n", 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details for processing HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], - 'AdbTableSchema' => [ - 'title' => 'ADB table schema', - 'description' => '', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'INNER_ERROR'], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'ErrorParam' => [ + 'title' => '', + 'description' => 'The error-related parameters.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The error-related parameters.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'FailedTime' => ['description' => 'The error time.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'example' => '', + ], + 'StartTime' => ['description' => 'The start time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:04:18'], + 'FinishTime' => ['description' => 'The end time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:04:18'], + 'Progress' => ['description' => 'The step progress.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], + 'StepInfo' => ['description' => 'The step details. For more information, see StepInfo data structure.', 'type' => 'object', 'title' => '', 'example' => '全量传输'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'Supplementary information such as error messages.', + 'type' => 'object', + 'properties' => [ + 'RunningStep' => ['description' => 'The step in the RUNNING state.', 'type' => 'string', 'title' => '', 'example' => 'PRE-CHECK'], + 'RunningProgress' => ['description' => 'The progress of the step in the RUNNING state.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], + 'MonitoringIncr' => ['description' => 'Indicates whether incremental monitoring has started.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Subtopics' => [ + 'title' => '', + 'description' => 'The subtopics list associated with the task\'s Store.', + 'type' => 'array', + 'items' => ['description' => 'The subtopic associated with the task\'s Store.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'ReverseSubtopics' => [ + 'title' => '', + 'description' => 'The subtopics list associated with the task\'s reverse Store.', + 'type' => 'array', + 'items' => ['description' => 'The subtopic associated with the task\'s reverse Store.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'LogServiceStartCheckpoint' => ['description' => 'The start checkpoint.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689214358'], + 'SourceStoreKeptHour' => ['description' => 'The log retention period.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '24'], + 'SyncDelay' => ['description' => 'The incremental synchronization delay.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'SyncDelaySampleTimestamp' => ['description' => 'The timestamp when the synchronization delay was sampled, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689214358'], + 'AccessObSource' => ['description' => 'Indicates whether direct connection to the source OceanBase database is available.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'OverwriteConfig' => ['description' => 'Indicates whether full overwrite and update of configurations are allowed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IgnoreUnsupportDdl' => ['description' => 'Indicates whether unsupported DDL statements are ignored.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'SubDbs' => [ + 'title' => '', + 'description' => 'Records table configurations for different downstream consumers, used for configuration merging when reusing data synchronization tasks.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster_name', 'title' => ''], + 'TenantName' => ['description' => 'The tenant name.', 'type' => 'string', 'example' => 'tenant_name', 'title' => ''], + 'DatabaseId' => ['description' => 'The database ID. Currently, only logical databases have IDs. In one endpoint, databases may share the same name but have different IDs.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DatabaseName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'MappingDatabaseName' => ['description' => 'The mapped database name.', 'type' => 'string', 'title' => '', 'example' => 'mapped_db'], + 'SourceClientId' => ['description' => 'The connector client ID.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Tables' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', + 'TableId' => ['description' => 'The table ID.', 'type' => 'string', 'title' => '', 'example' => 'fexg***'], + 'Database' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'MappingTableName' => ['description' => 'The mapped table name.', 'type' => 'string', 'example' => 'mapped_table', 'title' => ''], + 'Instance' => ['description' => 'The transmission instance ID.', 'type' => 'string', 'title' => '', 'example' => 'g_i4kat***'], + 'Columns' => [ + 'title' => '', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Position' => ['description' => 'The field position.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'RecordFieldType' => ['description' => 'The extended column type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'RawColumnType' => ['description' => 'The raw string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The index type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The column length.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The column precision.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The decimal places.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The column character encoding.', 'type' => 'string', 'title' => '', 'example' => 'utf8'], + 'ColumnComment' => ['description' => 'The column comment.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is hidden.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], 'description' => '', - 'type' => 'string', - 'example' => 'col2', + 'title' => '', + 'example' => '', ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', + 'description' => 'The list of columns to be transferred.', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of tables to be transferred.', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'Records table configurations for different downstream consumers, used for configuration merging when reusing data synchronization tasks.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'SubConds' => [ + 'description' => 'For DataWorks synchronization scenarios, records table configurations for different downstream consumers, used for configuration merging when reusing synchronization tasks.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TenantName' => ['description' => 'The tenant name.', 'type' => 'string', 'title' => '', 'example' => 'tenant_name'], + 'Database' => ['description' => 'The source database name.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'DestDatabase' => ['description' => 'The destination database name.', 'type' => 'string', 'title' => '', 'example' => 'dest_db'], + 'TableName' => ['description' => 'The source table name.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'DestName' => ['description' => 'The destination table name.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], + 'WhereClause' => ['description' => 'The standard SQL `WHERE` clause used to configure row filtering.', 'type' => 'string', 'title' => '', 'example' => 'id>1'], + 'FilterColumns' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'description' => 'The filter column collection.', + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The sharding key column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'description' => 'The sharding key column collection.', + 'example' => '', + ], + 'LogicTableId' => ['description' => 'The logic table ID for logical tables.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SourceEndpointId' => ['description' => 'The endpoint ID passed for physical tables.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SourceClientId' => ['title' => 'connector client id', 'description' => 'Identifies the Source Client that processes this DatabaseName.', 'type' => 'string', 'example' => 'null'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'For DataWorks synchronization scenarios, records table configurations for different downstream consumers, used for configuration merging when reusing synchronization tasks.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SubIds' => [ + 'title' => '', + 'description' => 'The ID list of configuration objects.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The ID of the configuration object.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'MaxConnectorCount' => ['description' => 'The maximum number of connectors. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '-1'], + 'StoreIncr' => ['description' => 'Indicates whether to save incremental data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IncrSyncTimestamp' => ['description' => 'The current checkpoint for incremental synchronization, in seconds as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689244596'], + ], + 'example' => '', + ], + 'AlarmStats' => [ + 'title' => '', + 'description' => 'Alert statistics.', + 'type' => 'object', + 'properties' => [ + 'Target' => ['description' => 'The alert target.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Alarming' => ['description' => 'Indicates whether an alert is active.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'RecentlyTriggerCount' => ['description' => 'The total number of recent alert messages.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'RuleToRecentlyTriggerCount' => [ + 'title' => '', + 'description' => 'The number of recent alert messages per rule.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The number of recent alert messages per rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'example' => '', + ], + 'AlarmContent' => ['description' => 'The content of the most recent alert message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OpenMonitor' => ['description' => 'Indicates whether the monitoring and alerting switch is enabled in Alibaba Cloud public cloud.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\\\n\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\\\n\\",\\n \\"Name\\": \\"i5fuij***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-02-02T16:00:00\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_fe****\\",\\n \\"Type\\": \\"SYNC\\",\\n \\"Name\\": \\"test\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dr****\\",\\n \\"Name\\": \\"test_tag\\"\\n }\\n ],\\n \\"Owner\\": \\"omsefry***\\",\\n \\"Importance\\": \\"HIGH\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\\\n\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T07:02:27\\",\\n \\"DestConnId\\": \\"c_deg***\\",\\n \\"IsMerging\\": true,\\n \\"IsModifying\\": true,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"OB_MYSQL\\",\\n \\"SinkEndpointType\\": \\"MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\",\\n \\"Databases\\": [\\n {\\n \\"Type\\": \\"MYSQL\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id > 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"fexdg***\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"col\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"DatabasesBlack\\": [\\n {\\n \\"Type\\": \\"DATABASE\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"mapped_tenant\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"TableAndViewWhiteList\\": [\\n \\"null\\"\\n ],\\n \\"TableAndViewBlackList\\": [\\n \\"null\\"\\n ]\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": true,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": true,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\",\\n \\"SinkStoreFormat\\": \\"null\\",\\n \\"SourceStoreFormat\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": true\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": true,\\n \\"FullTransferSpeedMode\\": \\"FAST\\",\\n \\"FullVerifySpeedMode\\": \\"FAST\\",\\n \\"WriteWorkerNum\\": 64,\\n \\"ReadWorkerNum\\": 64,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1667286900,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": false,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"ReverseIncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1687363200,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_feg****\\",\\n \\"EndpointName\\": \\"migon****\\",\\n \\"EndpointId\\": \\"e_3kx5i***1s\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\\\n\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"e_4lgzuzi9znr4\\",\\n \\"EndpointName\\": \\"RATION12948*****\\",\\n \\"EndpointId\\": \\"e_4w1q****\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\\\n\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\\\n\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 90,\\n \\"StepInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"PRE-CHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": false,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"fexg***\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_table\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"null\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query job details', + 'responseParamsDescription' => '## StepInfo data structure'."\n" + ."\n" + .'The `StepInfo` parameter returns different fields for different steps.'."\n" + ."\n" + .'- TRANSFER\\_APP\\_SWITCH (forward switchover)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ------------------------- | ---- | ---------------------------------------------------------------- |'."\n" + .' | checkpointSampleTimestamp | long | The checkpoint sampling time. Format: Unix timestamp in seconds. |'."\n" + ."\n" + .'- INCR\\_TRANSFER (incremental synchronization)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ------------------------- | ------- | ---------------------------------------------------------------- |'."\n" + .' | incrTimestampCheckpoint | long | The checkpoint time. Format: Unix timestamp in seconds. |'."\n" + .' | checkpointSampleTimestamp | long | The checkpoint sampling time. Format: Unix timestamp in seconds. |'."\n" + .' | enableIncrStatistics | boolean | Indicates whether DML/DDL statistics collection is enabled. |'."\n" + ."\n" + .'- FULL\\_VERIFIER (full verification) and FULL\\_TRANSFER (full migration)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ---------------- | ------ | -------------------------------------------------------------------- |'."\n" + .' | processedRecords | long | The number of migrated rows or actual rows processed. |'."\n" + .' | capacity | long | The estimated total number of rows. |'."\n" + .' | srcRps | long | The source read RPS, measured in records per second. |'."\n" + .' | srcRt | string | The source read RT, measured in milliseconds per record. |'."\n" + .' | srcIops | long | The source read throughput, measured in bytes per second. |'."\n" + .' | dstRps | long | The destination read/write RPS, measured in records per second. |'."\n" + .' | dstRt | long | The destination read/write RT, measured in milliseconds per record. |'."\n" + .' | dstIops | long | The destination read/write throughput, measured in bytes per second. |'."\n" + .' | srcRpsRef | long | The baseline value for source read RPS. |'."\n" + .' | dstRpsRef | long | The baseline value for destination read/write RPS. |'."\n" + .' | dstRtRef | long | The baseline value for destination read/write RT. |'."\n" + ."\n" + .'## Appendix'."\n" + ."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------------------------ | ---------------------- | --------------------------------------------------------------------------------------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| username | string | The username. Required when the authentication method is PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. |'."\n" + .'| enableSSL | boolean | Indicates whether SSL authentication is enabled. If enabled, you must upload a trusted certificate. |'."\n" + .'| enableSASL | boolean | Indicates whether SASL authentication is enabled. |'."\n" + .'| saslMechanism | KafkaSaslMechanisnEnum | The encryption method. Valid values: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS. |'."\n" + .'| disableIdentificationAlgorithm | boolean | Indicates whether hostname verification is enabled during SSL encryption. |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | --------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| project | string | The project name. |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | -------------------------- | --------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | The endpoint type. |'."\n" + .'| version | CloudRocketMQInst.Version | The RocketMQ version. |'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| cluster | string | The cluster name. |'."\n" + .'| tenant | string | The tenant name. |'."\n" + .'| isLogicSource | boolean | Indicates whether the data source is logical. |'."\n" + .'| useLogProxy | boolean | Indicates whether LogProxy is used. |'."\n" + .'| drcUser | string | The drc_user configuration. |'."\n" + .'| configUrl | string | Used to obtain the real IP addresses of underlying OceanBase database servers. |'."\n" + .'| logProxyIp | string | The IP address of the LogProxy service. |'."\n" + .'| logProxyPort | integer | The port of the LogProxy service. |'."\n" + .'| noUserAuth | boolean | For DataWorks synchronization interfaces, the data source is automatically generated by OMS. If no username and password are provided, you cannot connect to the user\'s OceanBase database. |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------- | ------ | ---------------------------------------- |'."\n" + .'| kafkaId | string | The ID of the bound Kafka data source. |'."\n" + .'| kafkaTopic | string | The name of the bound Kafka topic. |'."\n" + .'| kafkaName | string | The name of the bound Kafka data source. |', + 'changeSet' => [ + ['createdAt' => '2024-06-26T06:28:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-08T12:02:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-20T02:08:13.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [], + ], + 'DescribeProjectComponents' => [ + 'summary' => 'This API retrieves component information for data migration or data synchronization tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_4w3a****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code (old).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message (old).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggestion (old).', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '48'], + 'Data' => [ + 'title' => '', + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'StoreList' => [ + 'title' => '', + 'description' => 'The list of incremental pull components (Store).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the Store component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97'], + 'Ip' => ['title' => 'IP', 'description' => 'The IP address of the Store component.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'], + 'Region' => ['description' => 'The region where the Store component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'Topic' => ['title' => 'Topic', 'description' => 'The topic.', 'type' => 'string', 'example' => 'OB_ORACLE_np_4w3r29c_4w3****'], + 'Subtopic' => ['title' => 'SubTopic', 'description' => 'The subtopic.', 'type' => 'string', 'example' => 'OB_ORACLE_np_4w3***c_4w3**-0'], + 'Tps' => ['title' => 'Tps', 'description' => 'Transactions per second (TPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Delay' => ['title' => 'delay', 'description' => 'The delay time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Gmt' => ['description' => 'The timestamp when the offset was collected.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250049'], + 'Conn' => ['description' => 'The number of connections.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Status' => ['description' => 'The status. Valid values: EXCEPTION (Store runs abnormally), ACTIVE (Store runs normally), STOP (Store is manually stopped), UNEXPECTED\\_EXIT (Store reader exits unexpectedly), and CHANGE\\_SOURCE.', 'type' => 'string', 'title' => '', 'example' => 'EXCEPTION'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ToSwitch' => ['description' => 'Indicates whether a primary/standby switchover is required for HA judgment.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Port' => ['description' => 'The external service port.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2883'], + 'StorePort' => ['description' => 'The port of the Store component.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2882'], + 'BeginCheckpoint' => ['description' => 'The start safe checkpoint.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'EndCheckpoint' => ['description' => 'The end safe checkpoint.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'ErrMsg' => ['description' => 'The current error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'GmtCreate' => ['description' => 'The creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T17:29:54'], + 'GmtModified' => ['description' => 'The update time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T17:29:54'], + 'LatelyHeartbeatTimeSec' => ['description' => 'The timestamp of the latest heartbeat.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250071'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ReverseStoreList' => [ + 'title' => '', + 'description' => 'The list of reverse incremental pull components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the reverse incremental pull component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277'], + 'Ip' => ['title' => 'IP', 'description' => 'The IP address of the reverse incremental component.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'], + 'Region' => ['description' => 'The region where the reverse incremental component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-shenzhen'], + 'Topic' => ['title' => 'Topic', 'description' => 'The topic.', 'type' => 'string', 'example' => 'null'], + 'Subtopic' => ['title' => 'SubTopic', 'description' => 'The subtopic.', 'type' => 'string', 'example' => 'null'], + 'Tps' => ['title' => 'Tps', 'description' => 'Transactions per second (TPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Delay' => ['title' => 'delay', 'description' => 'The delay time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Gmt' => ['description' => 'The timestamp when the offset was collected.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250071'], + 'Conn' => ['description' => 'The number of connections.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Status' => ['description' => 'The status. Valid values: EXCEPTION (Store runs abnormally), ACTIVE (Store runs normally), STOP (Store is manually stopped), UNEXPECTED\\_EXIT (Store reader exits unexpectedly), and CHANGE\\_SOURCE.', 'type' => 'string', 'title' => '', 'example' => 'EXCEPTION'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ToSwitch' => ['description' => 'Indicates whether a primary/standby switchover is required for HA judgment.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Port' => ['description' => 'The external service port.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2883'], + 'StorePort' => ['description' => 'The port of the Store component.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2882'], + 'BeginCheckpoint' => ['description' => 'The start safe checkpoint.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'EndCheckpoint' => ['description' => 'The end safe checkpoint.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'ErrMsg' => ['description' => 'The current error message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'GmtCreate' => ['description' => 'The creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'GmtModified' => ['description' => 'The update time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'LatelyHeartbeatTimeSec' => ['description' => 'The timestamp of the latest heartbeat.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250071'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'FullVerifyComponents' => [ + 'title' => '', + 'description' => 'The list of full verification components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the full verification component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-beijing'], + 'Name' => ['description' => 'The name of the full verification component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-9000:90247:0000000033'], + 'InconsistentQuantity' => ['description' => 'The number of inconsistent verifications.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], + 'ConsistentQuantity' => ['description' => 'The number of consistent verifications.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'Progress' => ['description' => 'The table-level progress.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'RecordProgress' => ['description' => 'The record-level progress.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Status' => ['description' => 'The status of the full verification component. Valid values: INIT, RUNNING, DONE, FAILED, SHUTDOWNED, and DELETED.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Ip' => ['title' => 'ip', 'description' => 'The IP address of the full verification component.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'], + 'TaskId' => ['title' => 'taskId', 'description' => 'The ID of the full verification component.', 'type' => 'integer', 'format' => 'int64', 'example' => '1345***'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'FullImportComponents' => [ + 'title' => '', + 'description' => 'The list of full import components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the full import component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'Name' => ['description' => 'The name of the full import component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276'], + 'Ip' => ['title' => 'ip', 'description' => 'The IP address of the full import component.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'], + 'Identity' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'p_4w8v****'], + 'Progress' => ['description' => 'The progress of the full import component.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], + 'Status' => ['description' => 'The status of the full import component. Valid values: RUNNING, STOPPED, EXCEPTION, and FINISHED.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'GmtCreate' => ['description' => 'The creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'GmtModify' => ['description' => 'The update time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'SpecificTables' => [ - 'title' => '具体表对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MappedName' => [ - 'title' => '映射对象 table/topic', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'Id' => [ - 'title' => '表 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤表', - 'description' => '', - 'type' => 'string', - 'example' => 'id<3', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'Columns' => [ - 'title' => '列列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'description' => '', - 'type' => 'string', - 'example' => 'col_name', - ], - 'MappedName' => [ - 'title' => '列映射名', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Position' => [ - 'title' => '字段位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FLOAT', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', - 'description' => '', - 'type' => 'string', - 'example' => 'INT8', - ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRI', - ], - 'Nullable' => [ - 'title' => '是否可为空', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'DataLength' => [ - 'title' => '字段长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'DataPrecision' => [ - 'title' => '精度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'DataScale' => [ - 'title' => '小数点', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'Encoding' => [ - 'title' => '字符编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf16', - ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'description' => '', - 'type' => 'string', - 'example' => 'comments', - ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Type' => [ - 'title' => 'DATABASE, TABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'DATABASE', - ], - ], - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB table schema', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'IncrSyncComponents' => [ + 'title' => '', + 'description' => 'The list of incremental synchronization components.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the incremental synchronization component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-zhangjiakou'], + 'Name' => ['description' => 'The name of the incremental synchronization component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277'], + 'Ip' => ['description' => 'The IP address of the incremental synchronization component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1'], + 'Identity' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'np_4w***'], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => 'The set of subtopics.', + 'type' => 'array', + 'items' => ['description' => 'The subtopic.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'Status' => ['description' => 'The status. Valid values: RUNNING, STOPPED, EXCEPTION, and FINISHED.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'Checkpoint' => ['description' => 'The current offset in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'Tps' => ['description' => 'Transactions per second (TPS).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Delay' => ['description' => 'The delay time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'CheckpointSampleTimestamp' => ['description' => 'The timestamp when the offset was collected, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250071'], + 'GmtCreate' => ['description' => 'The creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'GmtModify' => ['description' => 'The modification time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ReverseIncrSyncComponents' => [ + 'title' => '', + 'description' => 'The reverse incremental synchronization component.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the reverse incremental synchronization component is located.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'Name' => ['description' => 'The name of the reverse incremental synchronization component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277'], + 'Ip' => ['description' => 'The IP address of the reverse incremental synchronization component.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1'], + 'Identity' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'np_4w8****'], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => 'The set of subtopics.', + 'type' => 'array', + 'items' => ['description' => 'The subtopic.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'Status' => ['description' => 'The status. Valid values: RUNNING, STOPPED, EXCEPTION, and FINISHED.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'Checkpoint' => ['description' => 'The current offset in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T09:19:53'], + 'Tps' => ['description' => 'Transactions per second (TPS).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Delay' => ['description' => 'The delay time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'CheckpointSampleTimestamp' => ['description' => 'The timestamp when the offset was collected, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689250049'], + 'GmtCreate' => ['description' => 'The creation time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'GmtModify' => ['description' => 'The modification time in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T18:04:36'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 9,\\n \\"Cost\\": \\"48\\",\\n \\"Data\\": {\\n \\"StoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Topic\\": \\"OB_ORACLE_np_4w3r29c_4w3****\\",\\n \\"Subtopic\\": \\"OB_ORACLE_np_4w3***c_4w3**-0\\",\\n \\"Tps\\": 0,\\n \\"Delay\\": 24,\\n \\"Gmt\\": 1689250049,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T17:29:54\\",\\n \\"GmtModified\\": \\"2023-07-13T17:29:54\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"ReverseStoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shenzhen\\",\\n \\"Topic\\": \\"null\\",\\n \\"Subtopic\\": \\"null\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"Gmt\\": 1689250071,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModified\\": \\"2023-07-13T18:04:36\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"FullVerifyComponents\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:90247:0000000033\\",\\n \\"InconsistentQuantity\\": 0,\\n \\"ConsistentQuantity\\": 100,\\n \\"Progress\\": \\"100\\",\\n \\"RecordProgress\\": 100,\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"TaskId\\": 0\\n }\\n ],\\n \\"FullImportComponents\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"p_4w8v****\\",\\n \\"Progress\\": 90,\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"IncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w***\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250071,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"ReverseIncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w8****\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250049,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query component information of a job', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeProjectProgress' => [ + 'summary' => 'This API retrieves the progress details of a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_4w3a****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details of the error. This field is returned only if the API call fails.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values are `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Key-value pairs for the placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the `Message` field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The parameters for the placeholders in the message template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The parameter value for a placeholder in the message template identified by `MessageMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value within the context for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the suggested solution.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value within the context for the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of an error from an upstream service, used for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code. This field is deprecated. Use `ErrorDetail.Code` instead.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message. This field is deprecated. Use `ErrorDetail.Message` instead.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The legacy advice. This field is deprecated. Use `ErrorDetail.Proposal` instead.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This field is returned for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. This field is returned for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count. This field is returned for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Cost' => ['description' => 'The request processing time, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The project progress details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => 'np_fe****'], + 'Status' => ['description' => 'The project status. Valid values are `INIT`, `RUNNING`, `SUSPEND`, `FAILED`, `FINISHED`, `RELEASING`, `RELEASED`, `DELETED`, `RUNNING_MODIFYING`, and `RUNNING_MERGING`.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'AlarmLevel' => ['description' => 'The alarm level. Valid values are `HIGH`, `MEDIUM`, `LOW`, and `IGNORE`.', 'type' => 'string', 'title' => '', 'example' => 'MEDIUM'], + 'EnableIncrSync' => ['description' => 'Specifies whether forward incremental synchronization is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'CurrentStep' => ['description' => 'The current step of the project. Valid values are `PRE_CHECK`, `TRANSFER_PRECHECK`, `PREPARE`, `STRUCT_TRANSFER`, `STRUCT_MIGRATION`, `INDEX_MIGRATION`, `INDEX_TRANSFER`, `STRUCT_SYNC`, `FULL_MIGRATION`, `FULL_TRANSFER`, `APP_SWITCH`, `TRANSFER_APP_SWITCH`, `REVERSE_INCR_SYNC`, `REVERSE_INCR_TRANSFER`, `FULL_VALIDATION`, `FULL_VERIFIER`, `INCR_LOG_PULL`, `TRANSFER_INCR_LOG_PULL`, `INCR_SYNC`, `INCR_TRANSFER`, `INCR_VERIFIER`, `SYNC_PREPARE`, `TRANSFER_PREPARE`, `SYNC_INCR_LOG_PULL`, `CONNECTOR_FULL_SYNC`, and `CONNECTOR_INCR_SYNC`.', 'type' => 'string', 'title' => '', 'example' => 'PRE_CHECK'], + 'IncrSyncCheckpoint' => ['description' => 'The forward incremental checkpoint. If the source is a DB2 LUW, OceanBase, MySQL, or Oracle database, this value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1689248064', 'title' => ''], + 'EnableStructTransfer' => ['description' => 'Specifies whether structure transfer is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableFullTransfer' => ['description' => 'Specifies whether full data transfer is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'StructTransferProgress' => ['description' => 'The structure transfer progress, as a percentage (from 0 to 100).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'FullTransferProgress' => ['description' => 'The full data transfer progress, as a percentage (from 0 to 100).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'EnableReverseIncrTransfer' => ['description' => 'Specifies whether reverse incremental synchronization is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ReverseIncrTransferCheckpoint' => ['description' => 'The reverse incremental checkpoint. The value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689248075'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ProjectId\\": \\"np_fe****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"AlarmLevel\\": \\"MEDIUM\\",\\n \\"EnableIncrSync\\": true,\\n \\"CurrentStep\\": \\"PRE_CHECK\\",\\n \\"IncrSyncCheckpoint\\": 1689248064,\\n \\"EnableStructTransfer\\": true,\\n \\"EnableFullTransfer\\": true,\\n \\"StructTransferProgress\\": 100,\\n \\"FullTransferProgress\\": 100,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"ReverseIncrTransferCheckpoint\\": 1689248075\\n }\\n}","type":"json"}]', + 'title' => 'Query job progress', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeProjectStepMetric' => [ + 'summary' => 'This API retrieves step-level metrics for a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_dr****'], + ], + [ + 'name' => 'StepName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the task step. You can specify one of the following values: `FULL_TRANSFER` for full transfer, `INCR_TRANSFER` for incremental transfer, `FULL_VERIFIER` for full verification, and `REVERSE_INCR_TRANSFER` for reverse incremental transfer.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'FULL_TRANSFER'], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the metric to query for the task step. The available options depend on the value of `StepName`.'."\n" + ."\n" + .'- For the `FULL_TRANSFER` step, valid metrics are RPS, IOPS, SOURCE\\_READ\\_TIME, SOURCE\\_SLICE\\_TIME, and SINK\\_EXECUTE\\_TIME.'."\n" + ."\n" + .'- For the `INCR_TRANSFER` step, valid metrics are DELAY, IOPS, RPS, SINK\\_COMMIT\\_TIME, and SINK\\_EXECUTE\\_TIME.'."\n" + ."\n" + .'- For the `FULL_VERIFIER` step, valid metrics are FULL\\_VERIFY\\_SOURCE\\_RPS, FULL\\_VERIFY\\_SOURCE\\_READ\\_IOPS, FULL\\_VERIFY\\_DEST\\_RPS, and FULL\\_VERIFY\\_DEST\\_READ\\_IOPS.'."\n" + ."\n" + .'- For the `REVERSE_INCR_TRANSFER` step, valid metrics are RPS, IOPS, DELAY, SINK\\_EXECUTE\\_TIME, and SINK\\_COMMIT\\_TIME.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'RPS'], + ], + [ + 'name' => 'Aggregator', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The aggregation method for the metric data. Specify `AVG` to return the average value or `NONE` to return the instantaneous value. The default is `NONE`.', + 'type' => 'string', + 'required' => true, + 'example' => 'AVG', + 'enum' => ['AVG', 'NONE'], + 'title' => '', + ], + ], + [ + 'name' => 'BeginTimestamp', + 'in' => 'formData', + 'schema' => ['description' => 'The start of the query time range, as a Unix timestamp in seconds. The total time range must be at least one hour.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1689244696'], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the query time range, as a Unix timestamp in seconds. This value cannot be in the future.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1689254646'], + ], + [ + 'name' => 'MaxPointNum', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data points to return. The value must be between 5 and 7\\**24*\\*60. For optimal results, the value should meet the following condition: (time range in minutes) / MaxPointNum > 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '5', 'default' => '6', 'title' => '', 'example' => '6'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values include FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The key-value pairs used to populate placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the `Message` parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key used to retrieve a localized error message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The key-value pairs used to populate placeholders in the template retrieved by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template retrieved by `MessageMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key used to retrieve a localized template for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The key-value pairs used to populate placeholders in the template retrieved by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template retrieved by `ReasonMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key used to retrieve a localized template for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The key-value pairs used to populate placeholders in the template retrieved by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template retrieved by `ProposalMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The legacy suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page, returned for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries, returned for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The metric data for the project step.', + 'type' => 'object', + 'properties' => [ + 'ReferenceValue' => ['description' => 'The reference value.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'Metrics' => [ + 'title' => '', + 'description' => 'The time-series data for the metrics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'metric name', 'description' => 'The name of the metric.', 'type' => 'string', 'example' => 'metric_name'], + 'Tags' => [ + 'title' => 'metrics tags', + 'description' => 'The set of tags for the metric.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A tag for the metric.', 'type' => 'string', 'example' => 'metric_tag', 'title' => ''], + 'example' => '', + ], + 'DataPoints' => [ + 'title' => 'data point list', + 'description' => 'A list of data points.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single data point.', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The timestamp of the data point, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689244696'], + 'Value' => ['description' => 'The value of the metric at the specified timestamp.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MappedName' => [ - 'title' => '映射对象 table/topic', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'Id' => [ - 'title' => '表 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤表', - 'description' => '', - 'type' => 'string', - 'example' => 'id < 1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', - ], - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'Columns' => [ - 'title' => '列列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'title' => '列名', - 'description' => '', - 'type' => 'string', - 'example' => 'col_name', - ], - 'MappedName' => [ - 'title' => '列映射名', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_name', - ], - 'Position' => [ - 'title' => '字段位置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ColumnType' => [ - 'title' => '列类型', - 'description' => '', - 'type' => 'string', - 'example' => 'FLOAT', - ], - 'RecordFieldType' => [ - 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', - 'description' => '', - 'type' => 'string', - 'example' => 'INT8', - ], - 'RawColumnType' => [ - 'title' => '数据库记录的列类型原始字符串', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ColumnKey' => [ - 'title' => '索引类型 (PRI, UNI, MUL)', - 'description' => '', - 'type' => 'string', - 'example' => 'PRI', - ], - 'Nullable' => [ - 'title' => '是否可为空', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'DataLength' => [ - 'title' => '字段长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'DataPrecision' => [ - 'title' => '精度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'DataScale' => [ - 'title' => '小数点', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'Encoding' => [ - 'title' => '字符编码', - 'description' => '', - 'type' => 'string', - 'example' => 'utf16', - ], - 'ColumnComment' => [ - 'title' => '字段注释', - 'description' => '', - 'type' => 'string', - 'example' => 'comments', - ], - 'IsGenerateField' => [ - 'title' => '是否是隐藏列', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Type' => [ - 'title' => 'DATABASE, TABLE', - 'description' => '', - 'type' => 'string', - 'example' => 'DATABASE', - ], - ], - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB table schema', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pk', - ], - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col2', - ], - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], + 'example' => '', + ], + ], + 'description' => 'A metric series.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Aggregator' => ['description' => 'The aggregator. Valid values are `AVG` (for average data) and `NONE` (for instantaneous data).', 'type' => 'string', 'title' => '', 'example' => 'AVG'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ReferenceValue\\": 0,\\n \\"Metrics\\": [\\n {\\n \\"Name\\": \\"metric_name\\",\\n \\"Tags\\": {\\n \\"key\\": \\"metric_tag\\"\\n },\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1689244696,\\n \\"Value\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Aggregator\\": \\"AVG\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query metrics for task steps', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProjectStepMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeProjectSteps' => [ + 'summary' => 'This operation returns details about the runtime steps for a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The data migration or data synchronization task ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_4w3a****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in `Message`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggestion template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The error details from an upstream service involved in the HTTP request.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This parameter is deprecated. We recommend that you use the `Code` parameter in `ErrorDetail` instead.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This parameter is deprecated. We recommend that you use the `Message` parameter in `ErrorDetail` instead.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggestion. This parameter is deprecated. We recommend that you use the `Proposal` parameter in `ErrorDetail` instead.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned only for paginated responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. This parameter is returned only for paginated responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count. This parameter is returned only for paginated responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'A list of task steps.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a task step.', + 'type' => 'object', + 'properties' => [ + 'Order' => ['description' => 'The execution order of the step.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Name' => ['description' => 'The name of the step.', 'type' => 'string', 'title' => '', 'example' => 'PRE_CHECK'], + 'Description' => ['description' => 'The description of the step. Possible values include: pre-check, schema migration, schema synchronization, full migration, full synchronization, full verification, index migration, incremental log fetching, incremental synchronization, incremental verification, and forward switchover.', 'type' => 'string', 'title' => '', 'example' => '预检查'], + 'Status' => ['description' => 'The step status. Valid values: `INIT` (initializing), `RUNNING` (running), `FAILED` (failed), `FINISHED` (finished), `SUSPEND` (suspended), and `MONITORING`. The `MONITORING` status indicates a continuous monitoring state for incremental synchronization and incremental verification.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'Additional information.', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in `Message`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'MessageMcmsKey' => ['description' => 'The key for the error message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggestion template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Key-value pairs used to populate placeholders in the template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The error details from an upstream service involved in the HTTP request.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'INNER_ERROR'], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The ResourceDirectoryId is invalid.'], + 'ErrorParam' => [ + 'title' => '', + 'description' => 'The parameters related to the error.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of an error-related parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'FailedTime' => ['description' => 'The time when the error occurred.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'example' => '', + ], + 'StartTime' => ['description' => 'The start time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:04:18'], + 'FinishTime' => ['description' => 'The end time, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:04:18'], + 'Progress' => ['description' => 'The progress of the step, from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'StepInfo' => ['description' => 'The execution details of the step. For more information, see the StepInfo data structure.', 'type' => 'object', 'title' => '', 'example' => 'null'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"The ResourceDirectoryId is invalid.\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the details of a task step', + 'responseParamsDescription' => '## StepInfo data structure'."\n" + ."\n" + .'The fields in the `stepInfo` parameter vary depending on the step.'."\n" + ."\n" + .'- Cutover (TRANSFER\\_APP\\_SWITCH)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ------------------------- | ---- | ------------------------------------------------------------------------------- |'."\n" + .' | checkpointSampleTimestamp | long | The time the checkpoint was collected, provided as a Unix timestamp in seconds. |'."\n" + ."\n" + .'- Incremental synchronization (INCR\\_TRANSFER)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ------------------------- | ------- | ------------------------------------------------------------------------------- |'."\n" + .' | incrTimestampCheckpoint | long | The checkpoint time, provided as a Unix timestamp in seconds. |'."\n" + .' | checkpointSampleTimestamp | long | The time the checkpoint was collected, provided as a Unix timestamp in seconds. |'."\n" + .' | enableIncrStatistics | boolean | Indicates whether DML/DDL statistics are enabled. |'."\n" + ."\n" + .'- Full verification (FULL\\_VERIFIER) and full transfer (FULL\\_TRANSFER)'."\n" + ."\n" + .' | Parameter | Type | Description |'."\n" + .' | ---------------- | ---- | ----------------------------------------------------------------- |'."\n" + .' | processedRecords | long | The number of rows transferred or verified. |'."\n" + .' | capacity | long | The estimated total number of rows. |'."\n" + .' | srcRps | long | Source read RPS (records per second). |'."\n" + .' | srcRt | long | Source read RT (response time), in milliseconds per record. |'."\n" + .' | srcIops | long | Source read throughput, in bytes per second. |'."\n" + .' | dstRps | long | Target read/write RPS (records per second). |'."\n" + .' | dstRt | long | Target read/write RT (response time), in milliseconds per record. |'."\n" + .' | dstIops | long | Target read/write throughput, in bytes per second. |'."\n" + .' | srcRpsRef | long | The baseline for source read RPS. |'."\n" + .' | dstRpsRef | long | The baseline for target read/write RPS. |'."\n" + .' | dstRtRef | long | The baseline for target read/write RT. |', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProjectSteps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeProxyService' => [ + 'summary' => 'You can call this operation to query proxy service information of OceanBase Database.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The data list.', + 'type' => 'object', + 'properties' => [ + 'ProxyClusterId' => ['title' => '', 'description' => 'The ID of the proxy cluster.', 'type' => 'string', 'example' => 'proxy-3t****zrieasg'], + 'ProxyMode' => ['title' => '', 'description' => 'The proxy mode.', 'type' => 'string', 'example' => 'shared'], + 'Zone' => ['title' => '', 'description' => 'The zone.', 'type' => 'string', 'example' => 'cn-shanghai-e,cn-shanghai-f'], + 'UnitSpec' => ['title' => '', 'description' => 'Thsa config.', 'type' => 'string', 'example' => '4C8GB'], + 'UnitNum' => ['title' => '', 'description' => 'The number of resource units in the tenant. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CurrentEndpointNum' => ['title' => '', 'description' => 'The current number of endpoints.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EndpointNumQuota' => ['title' => '', 'description' => 'The endpoint quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the proxy cluster was created.', 'type' => 'string', 'example' => '2023-07-05T08:23:10Z'], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the proxy service.', + 'type' => 'string', + 'example' => 'ONLINE', + 'enum' => ['ONLINE：运行中', 'CREATING：创建中', 'DELETING：关闭中', 'DELETED：已关闭'], + ], + 'ProxyServiceVersion' => ['title' => '', 'description' => 'The version of the proxy service.', 'type' => 'string', 'example' => '1.0'], + 'ExpireTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '2123-07-05T16:00:00'], + 'UnitNumLimit' => ['title' => '', 'description' => 'The maximum number of units.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'ProxyVersion' => ['description' => 'The version of the database proxy.', 'type' => 'string', 'example' => '4.3.1.0-xxxxxxxxx', 'title' => ''], + 'DeployMode' => ['type' => 'string', 'description' => 'Deployment mode.', 'example' => 'share', 'title' => ''], + 'ServerNumLimit' => ['title' => '节点数量上限值', 'description' => 'The maximum number of nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AllowModifyServerNum' => ['title' => 'true：允许修改，且显示当前节点数量'."\n" + .'false：不允许修改，且不显示当前节点数量', 'description' => 'Indicates whether the number of nodes can be changed. Valid values: `true` and `false`. The current number of nodes is displayed if the number of nodes can be changed, and is not displayed if otherwise.', 'type' => 'boolean', 'example' => 'true'], + 'SharedUnitNumLimit' => ['title' => 'K8S 共享模式代理服务的单元数量上限', 'description' => 'The maximum number of units of the proxy service in Kubernetes in shared mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ExclusiveUnitNumLimit' => ['title' => 'K8S 独占模式代理服务的单元数量上限', 'description' => 'The maximum number of units of the proxy service in Kubernetes in exclusive mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"ProxyClusterId\\": \\"proxy-3t****zrieasg\\",\\n \\"ProxyMode\\": \\"shared\\",\\n \\"Zone\\": \\"cn-shanghai-e,cn-shanghai-f\\",\\n \\"UnitSpec\\": \\"4C8GB\\",\\n \\"UnitNum\\": 1,\\n \\"CurrentEndpointNum\\": 1,\\n \\"EndpointNumQuota\\": 3,\\n \\"CreateTime\\": \\"2023-07-05T08:23:10Z\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"ProxyServiceVersion\\": \\"1.0\\",\\n \\"ExpireTime\\": \\"2123-07-05T16:00:00\\",\\n \\"UnitNumLimit\\": 4,\\n \\"ProxyVersion\\": \\"4.3.1.0-xxxxxxxxx\\",\\n \\"DeployMode\\": \\"share\\",\\n \\"ServerNumLimit\\": 0,\\n \\"AllowModifyServerNum\\": true,\\n \\"SharedUnitNumLimit\\": 0,\\n \\"ExclusiveUnitNumLimit\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProxyService', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProxyService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeRecommendIndex' => [ + 'summary' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The index recommended for the SQL statement after calculation by the diagnostic system. '."\n" + .'- If the recommended index is the primary key, PRIMARY is returned. '."\n" + .'- If an index created by the user is recommended, the index name is returned. '."\n" + .'The system recommends only one index for an SQL statement. You can call the DescribeIndexes operation to view the indexes of a table. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The return result of the request. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'SQLID', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The tables. '."\n" + .'The data tables involved in the SQL statement corresponding to the SQL ID are returned. For a single-table query, the data table accessed is returned. For a join query, all data tables accessed by the SQL statement are returned and separated with vertical bars (|), for example, "Table1|Table2". ', + 'description' => 'You can obtain the SQL ID from the return value of the DescribeSlowSQLList or DescribeTopSQLList operation. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The ID of the region. ', 'description' => 'The tenant mode. Valid values: '."\n" + .'Oracle '."\n" + .'MySQL ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'RecommendIndex' => [ + 'title' => 'The request ID. ', + 'description' => 'The information about the recommended index. ', + 'type' => 'object', + 'properties' => [ + 'SuggestIndex' => ['title' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeRecommendIndex**. ', 'description' => 'Example 1', 'type' => 'string', 'example' => 'PRIMARY'], + 'TenantMode' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeRecommendIndex'."\n" + .'&TenantId=t2mr3oae0****'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Returns the tenant mode. Supported modes are: '."\n" + .'- Oracle: Oracle mode. '."\n" + .'- MySQL: MySQL mode.', 'type' => 'string', 'example' => 'mysql'], + 'TableList' => ['title' => 'You can call this operation to query the index recommended by the diagnostic system based on an SQL ID. ', 'description' => 'Table information. '."\n" + .'Returns the data tables involved in the SQL statement corresponding to the SQLID. For a single-table query, it returns the single accessed data table. For a join query, it returns all data tables accessed by the SQL statement, separated by VERTICAL LINE, such as "Table1|Table2".', 'type' => 'string', 'example' => 'testtable'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"RecommendIndex\\": {\\n \\"SuggestIndex\\": \\"PRIMARY\\",\\n \\"TenantMode\\": \\"mysql\\",\\n \\"TableList\\": \\"testtable\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query SQL index recommendation information', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeRecommendIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeRestorableTenants' => [ + 'summary' => 'Queries information about restorable OceanBase Database tenants.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'IsRemote', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'This parameter is provided for compatibility with earlier versions and can be left empty.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SetId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the backup set.', 'type' => 'string', 'required' => false, 'example' => 'bak-xxxxx'], + ], + [ + 'name' => 'RestoreMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The restore method. This parameter is required when `IsRemote` is set to `true`, and is optional otherwise.', + 'type' => 'string', + 'required' => false, + 'example' => 'from_time_point', + 'enum' => ['from_backup_set', 'from_time_point'], + ], + ], + [ + 'name' => 'Method', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The backup method.', + 'type' => 'string', + 'required' => false, + 'example' => 'native_logical', + 'enum' => ['logical', 'physical', 'native_logical'], + ], + ], + [ + 'name' => 'IsOnline', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the target cluster is online. '."\n" + ."\n" + .'**Note** This parameter is used for compatibility with earlier versions and can be left empty. When left empty, it specifies negation for the value of `isRemote`.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'RestoreObjectType', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The type of the restore object.', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant', + 'enum' => ['cluster', 'tenant', 'database', 'table', 'serverless'], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Tenants' => [ + 'description' => 'The information about the tenants.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tenant information.', + 'type' => 'object', + 'properties' => [ + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'sbtest1', 'title' => ''], + 'Method' => [ + 'description' => 'The backup method.', + 'type' => 'string', + 'enumValueTitles' => ['native_logical：库表逻辑备份' => '', 'physical：物理备份' => '', 'logical：逻辑备份（OB2276及以下）' => ''], + 'example' => 'logical', + 'title' => '', + ], + 'TenantId' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 'ob317v4uif****', 'title' => ''], + 'TimeIntervalList' => [ + 'description' => 'The list of restorable periods of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the restorable periods.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of the restorable period.', 'type' => 'string', 'example' => '2023-01-20T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the restorable period.', 'type' => 'string', 'example' => '2023-03-13T02:43:03Z', 'title' => ''], + 'FromArchive' => ['title' => '', 'description' => 'Indicates whether the restore is based on archiving.', 'type' => 'boolean', 'example' => 'true'], + 'StorageType' => [ + 'description' => 'The storage type of backup data.', + 'type' => 'string', + 'enumValueTitles' => ['standard：标准存储' => '', 'archive：归档存储' => ''], + 'example' => 'standard', + 'title' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ClusterId' => ['title' => '', 'description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'objnf3b2****'], + 'ObRpmVersion' => ['title' => '', 'description' => 'The version of the OceanBase Database RPM package.', 'type' => 'string', 'example' => '3.2.3.1-2022080510****'], + 'ObVersion' => ['title' => '', 'description' => 'The major version of OceanBase Database.', 'type' => 'string', 'example' => '3.2.3.1'], + 'SourceRegion' => ['title' => '', 'description' => 'The region of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'TenantAlias' => ['title' => '', 'description' => 'The alias of the tenant.', 'type' => 'string', 'example' => 'aaa'], + 'CpuNum' => ['title' => '', 'description' => 'The number of CPU cores. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MemoryNum' => ['title' => '', 'description' => 'The size of memory for the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'BackupBucketName' => ['title' => '', 'description' => 'The name of the backup directory.', 'type' => 'string', 'example' => 'backup'], + 'ObTenantId' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 'tvd43v****'], + 'ClusterName' => ['title' => '', 'description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'testCluster'], + 'BackupSets' => [ + 'description' => 'The list of backup sets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the backupsets.', + 'type' => 'object', + 'properties' => [ + 'Checkpoint' => ['title' => '', 'description' => 'The checkpoint of the backup set.', 'type' => 'string', 'example' => '2024-01-01\'T\'12:10:10.000\'Z\''], + 'SetId' => ['title' => '', 'description' => 'The ID of the backup set.', 'type' => 'string', 'example' => 'bak-xxxxx'], + 'BackupSetId' => ['description' => 'The ID of the full backup set used for restore.', 'type' => 'string', 'example' => 'bak-4n****gacpa8', 'title' => ''], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 't5********'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'UsedDisk' => ['title' => '', 'description' => 'The size of disk space for the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'UnitNum' => ['title' => '', 'description' => 'The number of nodes of the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TenantMode' => ['title' => '', 'description' => 'The mode of the tenant.', 'type' => 'string', 'example' => 'Oracle'], + 'TenantDataBackupRemainDays' => ['title' => '', 'description' => 'The remaining validity period, in days, of the backup data of the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Tenants\\": [\\n {\\n \\"TenantName\\": \\"sbtest1\\",\\n \\"Method\\": \\"logical\\",\\n \\"TenantId\\": \\"ob317v4uif****\\",\\n \\"TimeIntervalList\\": [\\n {\\n \\"StartTime\\": \\"2023-01-20T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-03-13T02:43:03Z\\",\\n \\"FromArchive\\": true,\\n \\"StorageType\\": \\"standard\\"\\n }\\n ],\\n \\"ClusterId\\": \\"objnf3b2****\\",\\n \\"ObRpmVersion\\": \\"3.2.3.1-2022080510****\\",\\n \\"ObVersion\\": \\"3.2.3.1\\",\\n \\"SourceRegion\\": \\"cn-hangzhou\\",\\n \\"TenantAlias\\": \\"aaa\\",\\n \\"CpuNum\\": 1,\\n \\"MemoryNum\\": 100,\\n \\"BackupBucketName\\": \\"backup\\",\\n \\"ObTenantId\\": \\"tvd43v****\\",\\n \\"ClusterName\\": \\"testCluster\\",\\n \\"BackupSets\\": [\\n {\\n \\"Checkpoint\\": \\"2024-01-01\'T\'12:10:10.000\'Z\'\\",\\n \\"SetId\\": \\"bak-xxxxx\\",\\n \\"BackupSetId\\": \\"bak-4n****gacpa8\\",\\n \\"TenantId\\": \\"t5********\\"\\n }\\n ],\\n \\"UsedDisk\\": 50,\\n \\"UnitNum\\": 2,\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantDataBackupRemainDays\\": 7\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeRestorableTenants', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeRestorableTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSQLDetails' => [ + 'summary' => 'The ID of the tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'SQLID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'SQLID', 'description' => 'The SQL text. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The details of the SQL statement. ', + 'description' => 'The name of the database. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeSQLDetails**. ', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'SQLDetails' => [ + 'title' => 'Example 1', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeSQLDetails'."\n" + .'&TenantId=t2mr3oae0****'."\n" + .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result of the Request.', + 'type' => 'object', + 'properties' => [ + 'SQLText' => ['title' => 'You can call this operation to query the SQL text of an SQL statement based on the SQL ID. ', 'description' => '{"name":"DescribeSQLDetails","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeSQLDetails\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"t2mr3oae0****\\"},{\\"name\\":\\"SQLId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"SQLID\\",\\"description\\":\\"SQLID。\\",\\"example\\":\\"8D6E84****0B8FB1823D199E2CA1****\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"},{\\"name\\":\\"SQLDetails\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Array\\",\\"subType\\":\\"Object\\",\\"description\\":\\" \\",\\"children\\":[{\\"name\\":\\"SQLText\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\"},{\\"name\\":\\"DbName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"testdb\\"},{\\"name\\":\\"UserName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tester\\"}],\\"title\\":\\"\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', 'type' => 'string', 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC'], + 'DbName' => ['title' => '', 'description' => 'Database name.', 'type' => 'string', 'example' => 'testdb'], + 'UserName' => ['title' => '', 'description' => 'Username.', 'type' => 'string', 'example' => 'tester'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLDetails\\": [\\n {\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query SQL Text Information', + 'description' => 'To optimize User Experience, ApsaraDB has upgraded the SQL Diagnosis feature. This API has been unpublished and overridden by a new API. For details, see [【Notice】ApsaraDB Diagnosis Management API Interface Unpublished](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[【Notice】ApsaraDB Diagnosis Management API Interface Unpublished](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline).', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSQLHistoryList' => [ + 'summary' => 'You can call this operation to query the execution history of an SQL statement in a specified period based on an SQL ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant.', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => 'The start time of the time range for querying the parameter modification history. ', 'description' => 'The start time of the time range for querying the SQL execution history. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => 'The end time for the query of parameter modification history. ', 'description' => 'The end time of the time range for querying the SQL execution history. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'SQLID', 'description' => 'SQLID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => 'The page number.', 'description' => 'The page number. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => 'The number of entries returned on each page.', 'description' => 'The number of entries returned on each page. '."\n" + .'Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'SQLHistoryList' => [ + 'title' => 'The execution history of the SQL statement.', + 'description' => 'The execution history of the SQL statement. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => 'The list.', + 'description' => 'SQL History information.', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL History List information.', + 'type' => 'object', + 'properties' => [ + 'ExecPerSecond' => ['title' => 'The number of executions per second.', 'description' => 'The number of executions per second. ', 'type' => 'integer', 'format' => 'int64', 'example' => '163.0'], + 'MaxCpuTime' => ['title' => 'The maximum CPU time.', 'description' => 'The maximum CPU time. ', 'type' => 'number', 'format' => 'float', 'example' => '257.967'], + 'BlockCacheHit' => ['title' => 'The number of block cache hits.', 'description' => 'The number of block cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + 'DecodeTime' => ['title' => 'The time to wait for decoding.', 'description' => 'The time to wait for decoding. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'RemotePlans' => ['title' => 'The number of remote plans.', 'description' => 'The number of remote plans. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RPCCount' => ['title' => 'The number of RPCs.', 'description' => 'The number of RPCs. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'NetWaitTime' => ['title' => 'The network latency.', 'description' => 'The network latency. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'DiskRead' => ['title' => 'The number of physical reads.', 'description' => 'The number of physical reads. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'NodeIp' => ['title' => 'The IP address of the node.', 'description' => 'The IP address of the node. ', 'type' => 'string', 'example' => 'i-bp18qljorblo8es*****'], + 'ConcurrencyWaitTime' => ['title' => 'The wait time in concurrent execution.', 'description' => 'The wait time in concurrent execution. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'DbName' => ['title' => 'The name of the database.', 'description' => 'The name of the database. ', 'type' => 'string', 'example' => 'testdb'], + 'MemstoreReadRowCount' => ['title' => 'The number of rows read from the memory.', 'description' => 'The number of rows read from the memory. ', 'type' => 'integer', 'format' => 'int64', 'example' => '527'], + 'AppWaitTime' => ['title' => 'The wait time of the client.', 'description' => 'The wait time of the client. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'ElapsedTime' => ['title' => 'The average response time.', 'description' => 'The average response time. ', 'type' => 'number', 'format' => 'float', 'example' => '76.382'], + 'MissPlans' => ['title' => 'The number of plan misses.', 'description' => 'The number of plan misses. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AffectedRows' => ['title' => 'The number of rows affected.', 'description' => 'The number of rows affected. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ScheduleTime' => ['title' => 'The scheduling duration.', 'description' => 'The scheduling duration. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'Event' => ['title' => 'The wait event.', 'description' => 'The wait event. ', 'type' => 'string', 'example' => 'mysql response wait client'], + 'TotalWaitTime' => ['title' => 'The internal wait time.', 'description' => 'The internal wait time. ', 'type' => 'number', 'format' => 'float', 'example' => '10.966'], + 'ReturnRows' => ['title' => 'The number of rows returned.', 'description' => 'The number of rows returned. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ExecuteTime' => ['title' => 'The internal execution time.', 'description' => 'The internal execution time. ', 'type' => 'number', 'format' => 'float', 'example' => '61.044'], + 'UserName' => ['title' => 'The username.', 'description' => 'The username. ', 'type' => 'string', 'example' => 'tester'], + 'Executions' => ['title' => 'The number of executions.', 'description' => 'The number of executions. ', 'type' => 'integer', 'format' => 'int64', 'example' => '89403'], + 'GetPlanTime' => ['title' => 'The time spent in hard parsing.', 'description' => 'The time spent in hard parsing. ', 'type' => 'number', 'format' => 'float', 'example' => '0.052'], + 'CpuTime' => ['title' => 'The average CPU time.', 'description' => 'The average CPU time. ', 'type' => 'number', 'format' => 'float', 'example' => '50.13'], + 'MaxElapsedTime' => ['title' => 'The maximum response time.', 'description' => 'The maximum response time. ', 'type' => 'number', 'format' => 'float', 'example' => '260.44'], + 'BlockIndexCacheHit' => ['title' => 'The number of block index cache hits.', 'description' => 'The number of block index cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'EndTimeUTCString' => ['title' => 'The end time in UTC +0.', 'description' => 'The end time in UTC +0. ', 'type' => 'string', 'example' => '2021-12-28T02:08:18Z'], + 'EndTime' => ['title' => 'The end time.', 'description' => 'The end time. ', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-12-28T02:08:18Z'], + 'RetryCount' => ['title' => 'The number of retries.', 'description' => 'The number of retries. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ClientIp' => ['title' => 'The IP address of the client.', 'description' => 'The IP address of the client. ', 'type' => 'string', 'example' => '1*2.***.1*3.***'], + 'BloomFilterCacheHit' => ['title' => 'The number of Bloom filter cache hits.', 'description' => 'The number of Bloom filter cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'IOWaitTime' => ['title' => 'The I/O wait time.', 'description' => 'The I/O wait time. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'FailTimes' => ['title' => 'The number of failures.', 'description' => 'The number of failures. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueTime' => ['title' => 'The queuing time.', 'description' => 'The queuing time. ', 'type' => 'number', 'format' => 'float', 'example' => '15.275'], + 'RowCacheHit' => ['title' => 'The number of row cache hits.', 'description' => 'The number of row cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LogicalRead' => ['title' => 'The number of logical reads.', 'description' => 'The number of logical reads. ', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'SsstoreReadRowCount' => ['title' => 'The number of rows read from the disk.', 'description' => 'The number of rows read from the disk. ', 'type' => 'integer', 'format' => 'int64', 'example' => '43086'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Count' => ['title' => 'The quantity.', 'description' => 'The quantity. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLHistoryList\\": {\\n \\"List\\": [\\n {\\n \\"ExecPerSecond\\": 163,\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"DbName\\": \\"testdb\\",\\n \\"MemstoreReadRowCount\\": 527,\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.44,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"EndTimeUTCString\\": \\"2021-12-28T02:08:18Z\\",\\n \\"EndTime\\": 0,\\n \\"RetryCount\\": 0,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ],\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Query SQL Execution History', + 'description' => 'To optimize User Experience, ApsaraDB has upgraded the SQL Diagnosis feature. This API has been unpublished and overridden by a new API. For more information, see [【Notice】ApsaraDB Diagnosis Management API Unpublished](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[【Notice】ApsaraDB Diagnosis Management API Unpublished](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline).', + 'changeSet' => [ + ['createdAt' => '2022-01-17T12:57:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [], + ], + 'DescribeSQLPlans' => [ + 'summary' => 'You can call this operation to query the information about the SQL execution plans stored in the diagnostic system based on an SQL ID. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant.', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'SQLID', 'description' => 'SQLID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'SQLPlans' => [ + 'title' => 'The information about the execution plan.', + 'description' => 'The information about the execution plan. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the execution plan. ', + 'type' => 'object', + 'properties' => [ + 'HitCount' => ['title' => 'The number of hits.', 'description' => 'The number of hits. ', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'OutlineData' => ['title' => 'The outline data', 'description' => 'The outline data. ', 'type' => 'string', 'example' => '/*+ BEGIN_OUTLINE_DATA FULL(@\\"SEL$1\\" \\"testdb1.bmsql_order_line\\"@\\"SEL$1\\") END_OUTLINE_DATA*/'], + 'AvgExecutionMS' => ['title' => 'The average execution duration, in ms.', 'description' => 'The average execution duration, in ms. ', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'PlanUnionHash' => ['title' => 'The unique identifier of the SQL execution plan in the diagnostic system', 'description' => 'The unique identifier of the SQL execution plan in the diagnostic system. ', 'type' => 'string', 'example' => '859ef7ee****b23ac98cdeb2476f****'], + 'OutlineId' => ['title' => 'OutlineID', 'description' => 'OutlineID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'AvgExecutionTimeMS' => ['title' => 'The average execution duration.', 'description' => 'The average execution duration when the database uses this execution plan, in ms. ', 'type' => 'integer', 'format' => 'int64', 'example' => '288'], + 'PlanId' => ['title' => 'The ID of the SQL execution plan in the database.', 'description' => 'The ID of the SQL execution plan in the database. ', 'type' => 'integer', 'format' => 'int32', 'example' => '9114'], + 'OutlineTime' => ['title' => 'The time when the plan was bound.', 'description' => 'The time when the plan was bound. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1641492303000'], + 'OutlineTimeUTCString' => ['title' => 'The time when the plan was bound, in UTC +0.', 'description' => 'The time when the plan was bound, in UTC +0. ', 'type' => 'string', 'example' => '2022-01-06T18:05:03Z'], + 'PlanFull' => ['title' => 'The complete execution plan of the SQL statement.', 'description' => 'The complete execution plan of the SQL statement. ', 'type' => 'string', 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******'], + 'NodeIp' => ['title' => 'The IP address of the node.', 'description' => 'The IP address of the node. ', 'type' => 'string', 'example' => 'i-bp16niirq4zdmgvm****'], + 'MergedVersion' => ['title' => 'The major compaction version.', 'description' => 'The major compaction version. ', 'type' => 'integer', 'format' => 'int32', 'example' => '132'], + 'QuerySQL' => ['title' => 'The query SQL statement.', 'description' => 'The query SQL statement. ', 'type' => 'string', 'example' => 'SELECT ol_i_id, ***, *** FROM aaa'], + 'FirstLoadTimeUTCString' => ['title' => 'The time when the plan was loaded for the first time, in UTC +0.', 'description' => 'The time when the plan was loaded for the first time, in UTC +0. ', 'type' => 'string', 'example' => '2022-01-06T18:05:03Z'], + 'FirstLoadTime' => ['title' => 'The time when the plan was loaded for the first time, .', 'description' => 'The time when the plan was loaded for the first time, . ', 'type' => 'integer', 'format' => 'int64', 'example' => '1641492303000'], + 'PlanInfo' => ['title' => 'The information about the plan.', 'description' => 'The information about the plan. ', 'type' => 'string', 'example' => 'PHY_TABLE_SCAN'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SQLPlans\\": [\\n {\\n \\"HitCount\\": 3,\\n \\"OutlineData\\": \\"/*+ BEGIN_OUTLINE_DATA FULL(@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"testdb1.bmsql_order_line\\\\\\\\\\\\\\"@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\\\\\") END_OUTLINE_DATA*/\\",\\n \\"AvgExecutionMS\\": 1,\\n \\"PlanUnionHash\\": \\"859ef7ee****b23ac98cdeb2476f****\\",\\n \\"OutlineId\\": -1,\\n \\"AvgExecutionTimeMS\\": 288,\\n \\"PlanId\\": 9114,\\n \\"OutlineTime\\": 1641492303000,\\n \\"OutlineTimeUTCString\\": \\"2022-01-06T18:05:03Z\\",\\n \\"PlanFull\\": \\"PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\",\\n \\"NodeIp\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"MergedVersion\\": 132,\\n \\"QuerySQL\\": \\"SELECT ol_i_id, ***, *** FROM aaa\\",\\n \\"FirstLoadTimeUTCString\\": \\"2022-01-06T18:05:03Z\\",\\n \\"FirstLoadTime\\": 1641492303000,\\n \\"PlanInfo\\": \\"PHY_TABLE_SCAN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 3\\n /*+ BEGIN_OUTLINE_DATA FULL(@\\\\\\"SEL$1\\\\\\" \\\\\\"testdb1.bmsql_order_line\\\\\\"@\\\\\\"SEL$1\\\\\\") END_OUTLINE_DATA*/\\n 1\\n 859ef7ee****b23ac98cdeb2476f****\\n -1\\n 288\\n 9114\\n 1641492303000\\n 2022-01-06T18:05:03Z\\n PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\n i-bp16niirq4zdmgvm****\\n 132\\n SELECT ol_i_id, ***, *** FROM aaa\\n 2022-01-06T18:05:03Z\\n 1641492303000\\n PHY_TABLE_SCAN\\n \\n","errorExample":""}]', + 'title' => 'DescribeSQLPlans', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 [【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSQLSamples' => [ + 'summary' => 'Query sampled data for slow SQL execution details.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'required' => false, 'example' => 't4louaeei****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time to query for slow SQL executions.'."\n" + ."\n" + .'The time must be in UTC format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time to query for slow SQL executions.'."\n" + ."\n" + .'The time must be in UTC format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', 'title' => ''], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => ['description' => 'The SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + ], + [ + 'name' => 'ReturnSqlText', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to return the SQL text.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'A list of slow SQL execution samples.', + 'type' => 'array', + 'items' => [ + 'description' => 'A slow SQL execution sample.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'RequestId', 'description' => 'The request ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TraceId' => ['title' => 'TraceId', 'description' => 'The trace ID.', 'type' => 'string', 'example' => 'YB42C****-0005E303D1****-0-0'], + 'RequestTime' => ['description' => 'The time the SQL request was made.', 'type' => 'string', 'title' => '', 'example' => '2023-04-12T04:46:38Z'], + 'Server' => ['description' => 'The server that executed the SQL statement.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db1****8uemejio'], + 'ClientIp' => ['description' => 'The client\'s IP address.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1db****38uemejio'], + 'ClientPort' => ['description' => 'The client port.', 'type' => 'integer', 'format' => 'int32', 'example' => '4****', 'title' => ''], + 'DbName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'test_db'], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'example' => 'test_user'], + 'SqlType' => ['description' => 'The SQL statement type.', 'type' => 'string', 'title' => '', 'example' => 'select'], + 'PlanId' => ['description' => 'The execution plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '590****', 'title' => ''], + 'AffectedRows' => ['description' => 'The number of rows affected by the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000.0', 'title' => ''], + 'ReturnRows' => ['description' => 'The number of rows returned by the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0', 'title' => ''], + 'PartitionCount' => ['description' => 'The number of partitions accessed during the execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '1.0', 'title' => ''], + 'RetCode' => ['description' => 'The result code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WaitEvent' => ['description' => 'The longest wait event during the execution.', 'type' => 'string', 'title' => '', 'example' => 'none'], + 'WaitTime' => ['description' => 'The wait time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'WaitCount' => ['description' => 'The number of waits.', 'type' => 'integer', 'format' => 'int64', 'example' => '0.0', 'title' => ''], + 'RpcCount' => ['description' => 'The RPC count.', 'type' => 'integer', 'format' => 'int64', 'example' => '8.0', 'title' => ''], + 'PlanType' => ['description' => 'The plan type.', 'type' => 'string', 'title' => '', 'example' => 'LOCAL'], + 'Inner' => ['description' => 'Indicates whether the SQL statement is internal.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'ExecutorRpc' => ['description' => 'Indicates whether an RPC was initiated.', 'type' => 'boolean', 'example' => '0.0', 'title' => ''], + 'HitPlan' => ['description' => 'Indicates whether the execution plan was hit.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ElapsedTime' => ['description' => 'The response time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '2182.66'], + 'CpuTime' => ['description' => 'The CPU time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3377.57'], + 'NetTime' => ['description' => 'The network transport time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'NetWaitTime' => ['description' => 'The network queuing time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'QueueTime' => ['description' => 'The queue time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.02'], + 'DecodeTime' => ['description' => 'The syntax parsing time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'GetPlanTime' => ['description' => 'The plan generation time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.19'], + 'ExecuteTime' => ['description' => 'The plan execution time, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '8262.01'], + 'ApplicationWaitTime' => ['description' => 'The wait time for Application events, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'ConcurrencyWaitTime' => ['description' => 'The wait time for Concurrency events, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'UserIoWaitTime' => ['description' => 'The wait time for UserIO events, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'ScheduleTime' => ['description' => 'The wait time for Schedule events, in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'RowCacheHit' => ['description' => 'The number of row cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '498.0'], + 'BloomFilterCacheHit' => ['description' => 'The number of Bloom filter cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.0'], + 'BlockCacheHit' => ['description' => 'The number of block cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '99279.0'], + 'BlockIndexCacheHit' => ['description' => 'The number of block index cache hits.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '142514.0'], + 'DiskReads' => ['description' => 'The number of disk reads.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '96972.0'], + 'RetryCount' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'TableScan' => ['description' => 'Indicates whether a full table scan was performed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ConsistencyLevel' => ['description' => 'The consistency level.', 'type' => 'string', 'title' => '', 'example' => '3'], + 'MemstoreReadRows' => ['description' => 'The number of rows read from the Memstore.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ExpectedWorkerCount' => ['description' => 'The degree of parallelism.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'UsedWorkerCount' => ['description' => 'The actual number of worker threads used.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'SsstoreReadRows' => ['description' => 'The number of rows read from the SSStore.', 'type' => 'integer', 'format' => 'int64', 'example' => '986190', 'title' => ''], + 'ObServerId' => ['title' => 'server ID', 'description' => 'The server ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ObUserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100010', 'title' => ''], + 'ObDbId' => ['description' => 'The database ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11006111****4828', 'title' => ''], + 'Statement' => ['description' => 'The parameterized SQL statement.', 'type' => 'string', 'title' => '', 'example' => 'select a from b'], + 'TransHash' => ['title' => 'transaction hash', 'description' => 'The transaction hash.', 'type' => 'string', 'example' => '1219****927****73791'], + 'FullSqlText' => ['description' => 'The complete SQL statement.'."\n" + ."\n" + .'> This parameter is temporarily unavailable.', 'type' => 'string', 'example' => 'select * from test where c1 > 1 and c2 > 3;', 'title' => ''], + 'SqlText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => 'select ** from t', 'title' => ''], + 'ParamsValue' => ['title' => 'SQL参数值', 'description' => 'The SQL parameter values.', 'type' => 'string', 'example' => '1****'], + 'SqlId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SqlTextShort' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"RequestId\\": 0,\\n \\"TraceId\\": \\"YB42C****-0005E303D1****-0-0\\",\\n \\"RequestTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ClientIp\\": \\"i-bp1db****38uemejio\\",\\n \\"ClientPort\\": 0,\\n \\"DbName\\": \\"test_db\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"SqlType\\": \\"select\\",\\n \\"PlanId\\": 0,\\n \\"AffectedRows\\": 10000,\\n \\"ReturnRows\\": 0,\\n \\"PartitionCount\\": 1,\\n \\"RetCode\\": 0,\\n \\"WaitEvent\\": \\"none\\",\\n \\"WaitTime\\": 0,\\n \\"WaitCount\\": 0,\\n \\"RpcCount\\": 8,\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"Inner\\": false,\\n \\"ExecutorRpc\\": true,\\n \\"HitPlan\\": true,\\n \\"ElapsedTime\\": 2182.66,\\n \\"CpuTime\\": 3377.57,\\n \\"NetTime\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"QueueTime\\": 0.02,\\n \\"DecodeTime\\": 0,\\n \\"GetPlanTime\\": 0.19,\\n \\"ExecuteTime\\": 8262.01,\\n \\"ApplicationWaitTime\\": 0,\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"UserIoWaitTime\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"RowCacheHit\\": 498,\\n \\"BloomFilterCacheHit\\": 0,\\n \\"BlockCacheHit\\": 99279,\\n \\"BlockIndexCacheHit\\": 142514,\\n \\"DiskReads\\": 96972,\\n \\"RetryCount\\": 0,\\n \\"TableScan\\": false,\\n \\"ConsistencyLevel\\": \\"3\\",\\n \\"MemstoreReadRows\\": 0,\\n \\"ExpectedWorkerCount\\": 0,\\n \\"UsedWorkerCount\\": 0,\\n \\"SsstoreReadRows\\": 986190,\\n \\"ObServerId\\": 2,\\n \\"ObUserId\\": 100010,\\n \\"ObDbId\\": 0,\\n \\"Statement\\": \\"select a from b\\",\\n \\"TransHash\\": \\"1219****927****73791\\",\\n \\"FullSqlText\\": \\"select * from test where c1 > 1 and c2 > 3;\\",\\n \\"SqlText\\": \\"select ** from t\\",\\n \\"ParamsValue\\": \\"1****\\",\\n \\"SqlId\\": \\"\\",\\n \\"SqlTextShort\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSQLSamples', + 'changeSet' => [ + ['createdAt' => '2025-08-05T15:58:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-09T06:06:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-08T12:08:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-15T13:01:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-12-11T13:13:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-30T13:50:59.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLSamples', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSQLTuningAdvices' => [ + 'summary' => 'You can call this operation to query SQL optimization suggestions for two purposes: creating indexes and binding execution plans.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'obsdf43****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tsdc2s2****'], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the database. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb'], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => ['title' => 'SqlId', 'description' => 'The ID of the SQL statement.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T04:38:38Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-12T05:38:38Z'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'The supported language. Valid values: '."\n" + .'* zh-CN '."\n" + .'* en-US', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the execution plans of the SQL statement.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The optimization type.', 'type' => 'string', 'example' => 'PLAN_BINDING/INDEX_CREATION', 'title' => ''], + 'ColumnNames' => ['description' => 'The sequence of index columns.', 'type' => 'string', 'example' => 'c1;c2;c3', 'title' => ''], + 'LocalityType' => ['title' => '', 'description' => 'The type of the index.', 'type' => 'string', 'example' => 'Local/Global'], + 'Columns' => [ + 'title' => '', + 'description' => 'The list of index columns.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about index columns.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['title' => '', 'description' => 'The name of the column.', 'type' => 'string', 'example' => 'xxxx'], + 'Ndv' => ['title' => 'NDV', 'description' => 'The NDV of the column.', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'MinValue' => ['title' => '', 'description' => 'The minimum value of the column.', 'type' => 'string', 'example' => '1'], + 'MaxValue' => ['title' => '', 'description' => 'The maximum value of the column.', 'type' => 'string', 'example' => '100'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DbName' => ['title' => '', 'description' => 'The name of the database. ', 'type' => 'string', 'example' => 'test_db'], + 'Table' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'example' => 'test_table'], + 'Plan' => [ + 'description' => 'The execution plan.', + 'type' => 'object', + 'properties' => [ + 'Executions' => ['description' => 'The total number of executions within the specified period of time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2062', 'title' => ''], + 'AvgCpuTime' => ['description' => 'The average CPU time within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '100.36', 'title' => ''], + 'PlanHash' => ['description' => 'The unique identifier of the execution plan in the diagnostic system.', 'type' => 'string', 'example' => '-86290582****886880', 'title' => ''], + 'TimeoutPercentage' => ['description' => 'The percentage of executions with a timeout error.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'AvgConcurrencyWaitTime' => ['description' => 'The average amount of time spent on a Concurrency wait event within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'FirstLoadTimeUs' => ['description' => 'The time when the execution plan was loaded for the first time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1672367130576163', 'title' => ''], + 'AvgDiskWrites' => ['description' => 'The average number of physical writes within the specified period of time.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'AvgUserIoWaitTime' => ['description' => 'The average amount of time spent on a UserIo wait event within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'PlanSize' => ['description' => 'The size of the execution plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '49216', 'title' => ''], + 'ServerSn' => ['description' => 'The ID of the node.', 'type' => 'string', 'example' => 'i-bp1*****sw64dhb*****', 'title' => ''], + 'OutlineData' => ['description' => 'The outline_data field of the execution plan.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], + 'PlanType' => ['description' => 'The type of the execution plan. Valid values: LOCAL, REMOTE, and DIST.', 'type' => 'string', 'example' => 'LOCAL', 'title' => ''], + 'ObDbId' => ['description' => 'The ID of the database.', 'type' => 'integer', 'format' => 'int64', 'example' => '1108307720799259', 'title' => ''], + 'HitPercentage' => ['description' => 'The hit rate.', 'type' => 'number', 'format' => 'float', 'example' => '66.8', 'title' => ''], + 'AvgBufferGets' => ['description' => 'The average number of cache reads within the specified period of time.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'ExecPs' => ['description' => 'The average number of executions per second within the specified period of time.', 'type' => 'number', 'format' => 'float', 'example' => '1.45', 'title' => ''], + 'DelayedLargeQueryPercentage' => ['description' => 'The percentage of delayed long-running queries.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'TableScan' => ['description' => 'Indicates whether full table scan is performed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'LargeQueryPercentage' => ['description' => 'The percentage of completed long-running queries.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'SchemaVersion' => ['description' => 'The version of the schema.', 'type' => 'integer', 'format' => 'int64', 'example' => '1672367130529680', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the execution plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '818', 'title' => ''], + 'FirstLoadTime' => ['description' => 'The time when the execution plan was loaded for the first time.', 'type' => 'string', 'example' => '2022-12-30T02:25:30.576Z', 'title' => ''], + 'AvgRowProcessed' => ['description' => 'The average wait time of row processing within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'MergedVersion' => ['description' => 'The version of the major compaction.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'HitDiagnosis' => ['description' => 'Indicates whether the diagnosis is hit.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Uid' => ['description' => 'The unique identifier of the execution plan.', 'type' => 'string', 'example' => 'AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj', 'title' => ''], + 'AvgApplicationWaitTime' => ['description' => 'The average amount of time spent on an Application wait event within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'CollectTimeUs' => ['description' => 'The period of time during which data is collected.', 'type' => 'integer', 'format' => 'int64', 'example' => '1672358400000000', 'title' => ''], + 'AvgElapsedTime' => ['description' => 'The average interval wait time within the specified period of time, in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '713.62', 'title' => ''], + 'ObServerId' => ['description' => 'The ID of the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'OutlineId' => ['description' => 'The ID of the outline.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AvgDiskReads' => ['description' => 'The average number of physical reads within the specified period of time.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": \\"PLAN_BINDING/INDEX_CREATION\\",\\n \\"ColumnNames\\": \\"c1;c2;c3\\",\\n \\"LocalityType\\": \\"Local/Global\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"xxxx\\",\\n \\"Ndv\\": 100,\\n \\"MinValue\\": \\"1\\",\\n \\"MaxValue\\": \\"100\\"\\n }\\n ],\\n \\"DbName\\": \\"test_db\\",\\n \\"Table\\": \\"test_table\\",\\n \\"Plan\\": {\\n \\"Executions\\": 2062,\\n \\"AvgCpuTime\\": 100.36,\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"TimeoutPercentage\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"FirstLoadTimeUs\\": 1672367130576163,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"PlanSize\\": 49216,\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\",\\n \\"OutlineData\\": \\"xxxxx\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"ObDbId\\": 1108307720799259,\\n \\"HitPercentage\\": 66.8,\\n \\"AvgBufferGets\\": 0,\\n \\"ExecPs\\": 1.45,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"LargeQueryPercentage\\": 0,\\n \\"SchemaVersion\\": 1672367130529680,\\n \\"PlanId\\": 818,\\n \\"FirstLoadTime\\": \\"2022-12-30T02:25:30.576Z\\",\\n \\"AvgRowProcessed\\": 1,\\n \\"MergedVersion\\": 3,\\n \\"HitDiagnosis\\": false,\\n \\"Uid\\": \\"AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj\\",\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"CollectTimeUs\\": 1672358400000000,\\n \\"AvgElapsedTime\\": 713.62,\\n \\"ObServerId\\": 1,\\n \\"OutlineId\\": 1,\\n \\"AvgDiskReads\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSQLTuningAdvices', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLTuningAdvices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSampleSqlRawTexts' => [ + 'summary' => 'You can call this operation to query the original text of a sampled SQL statement.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'required' => false, 'example' => 'ob2mr3oae0****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-12T04:38:38Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-12T05:38:38Z', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test_db', 'title' => ''], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the SQL statement.', 'type' => 'string', 'required' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + ], + [ + 'name' => 'TraceId', + 'in' => 'formData', + 'schema' => ['description' => 'The trace ID of the executed query, which is the value of TraceId returned by DescribeSQLSamples.'."\n" + .'> Note '."\n" + .'Not all trace IDs of slow SQL statements can be used to query the original text.', 'type' => 'string', 'required' => false, 'example' => 'YB420A700EFB-00060D53E42D0C61-0-0', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => ['description' => 'The number of returned rows of the SQL statement.', 'type' => 'string', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => ['title' => '是否为聚合sql', 'description' => 'Specifies whether the SQL statement is an aggregation statement.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The data list.', + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'The SQL statement.', + 'type' => 'array', + 'items' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => '{'."\n" + .' "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",'."\n" + .' "Data": {'."\n" + .' "SqlText": ['."\n" + .' "\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\""'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"SqlText\\": [\\n \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"EE205C00-30E4-****-****-87E3A8A2AA0C\\\\\\",\\\\n \\\\\\"Data\\\\\\": {\\\\n \\\\\\"SqlText\\\\\\": [\\\\n \\\\\\"\\\\\\\\\\\\\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\\\\\\\\\\\\\"\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSampleSqlRawTexts', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSampleSqlRawTexts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSecurityIpGroups' => [ + 'summary' => 'Alibaba Cloud CLI', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The number of whitelist groups returned. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp67acfmxazb4p****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request. ', + 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" + .'It is a JSON array. Each object in the array is an IP address or CIDR block. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The name of the security group. ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TotalCount' => ['title' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeSecurityIpGroups**. ', 'description' => 'Example 1', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'SecurityIpGroups' => [ + 'title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeSecurityIpGroups'."\n" + .'&InstanceId=i-bp67acfmxazb4p****'."\n" + .'&Common request parameters'."\n" + .'```', + 'description' => 'Information about the IP address whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to view the list of IP address whitelist groups. ', + 'type' => 'object', + 'properties' => [ + 'SecurityIps' => ['title' => '{"name":"DescribeSecurityIpGroups","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST","protocol":"HTTP|HTTPS","hidden":0,"timeout":5000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeSecurityIpGroups\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"i-bp67acfmxazb4p****\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"TotalCount\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2\\"},{\\"name\\":\\"SecurityIpGroups\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Array\\",\\"subType\\":\\"Object\\",\\"description\\":\\" \\",\\"children\\":[{\\"name\\":\\"SecurityIps\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"{“127.0.0.1”，”123.123.1.23“}\\"},{\\"name\\":\\"SecurityIpGroupName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"online_paycore\\"}],\\"title\\":\\"\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{\\"500\\":[{\\"code\\":\\"500\\",\\"defaultError\\":false,\\"errorCode\\":\\"InternalError\\",\\"errorMessage\\":\\"The request processing has failed due to some unknown error.\\",\\"errorMessageCn\\":\\"\\",\\"type\\":\\"user\\"}]}"}', 'description' => 'The IP address whitelist list. '."\n" + .'It is a string-formatted array, where each element is an IP address string or an IP segment.', 'type' => 'string', 'example' => '127.*.*.1'], + 'SecurityIpGroupName' => ['title' => '', 'description' => 'Security group name.', 'type' => 'string', 'example' => 'default'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIps\\": \\"127.*.*.1\\",\\n \\"SecurityIpGroupName\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of IP address whitelist groups', + 'changeSet' => [ + ['createdAt' => '2021-06-17T12:55:49.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSecurityIpGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSessionList' => [ + 'summary' => 'You can call this operation to query sessions between the ApsaraDB for OceanBase and the application.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The object information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result.', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['title' => '', 'description' => 'The session ID of the proxy service.', 'type' => 'string', 'example' => '4325'], + 'Host' => ['title' => '', 'description' => 'The address of the client, with the format ip:port.', 'type' => 'string', 'example' => '192.***.**.100:80'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"4325\\",\\n \\"Host\\": \\"192.***.**.100:80\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSessionList', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeSlowSQLHistoryList' => [ + 'summary' => 'You can call this operation to query the execution history of an SQL statement by SQL ID that is determined as a slow SQL statement during a specified period of time. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the tenant.', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't384tolsj****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => 'The start time.', 'description' => 'The start time of the time range for querying the execution history of the slow SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-12-14T02:34:49Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => 'The end time.', 'description' => 'The end time of the time range for querying the execution history of the slow SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-12-14T08:34:49Z'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'The SQL ID.', 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84735C0****1823D199E2CA1****'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'SlowSQLHistoryList' => [ + 'title' => 'The execution history of the slow SQL statement.', + 'description' => 'The execution history of the slow SQL statement. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The return result of the request.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'SqlId' => ['description' => 'SQLID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + 'SqlType' => ['description' => 'The SQL type. ', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant. ', 'type' => 'string', 'example' => 'pay_online', 'title' => ''], + 'UserName' => ['description' => 'The username. ', 'type' => 'string', 'example' => 'tester', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client. ', 'type' => 'string', 'example' => '1*2.***.1*3.***', 'title' => ''], + 'DbName' => ['description' => 'The name of the database. ', 'type' => 'string', 'example' => 'testdb', 'title' => ''], + 'Event' => ['description' => 'The wait event. ', 'type' => 'string', 'example' => 'mysql response wait client', 'title' => ''], + 'NodeIp' => ['description' => 'The IP address of the node. ', 'type' => 'string', 'example' => 'i-bp18qljorblo8es*****', 'title' => ''], + 'AffectedRows' => ['description' => 'The number of rows affected. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'BlockCacheHit' => ['description' => 'The number of block cache hits. ', 'type' => 'number', 'format' => 'double', 'example' => '14', 'title' => ''], + 'BlockIndexCacheHit' => ['description' => 'The number of block index cache hits. ', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], + 'BloomFilterCacheHit' => ['description' => 'The number of Bloom filter cache hits. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'Executions' => ['description' => 'The number of executions. ', 'type' => 'number', 'format' => 'double', 'example' => '89403', 'title' => ''], + 'FailTimes' => ['description' => 'The number of failures. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'RPCCount' => ['description' => 'The number of RPCs. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'RemotePlans' => ['description' => 'The number of remote plans. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'MissPlans' => ['description' => 'The number of plan misses. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'ReturnRows' => ['description' => 'The number of rows returned. ', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'LogicalRead' => ['description' => 'The number of logical reads. ', 'type' => 'number', 'format' => 'double', 'example' => '19', 'title' => ''], + 'RetryCount' => ['description' => 'The number of retries. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'RowCacheHit' => ['description' => 'The number of row cache hits. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'DiskRead' => ['description' => 'The number of physical reads. ', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'MemstoreReadRowCount' => ['description' => 'The number of rows read from the memory. ', 'type' => 'number', 'format' => 'double', 'example' => '527', 'title' => ''], + 'SsstoreReadRowCount' => ['description' => 'The number of rows read from the disk. ', 'type' => 'number', 'format' => 'double', 'example' => '43086', 'title' => ''], + 'ExecPerSecond' => ['description' => 'The number of executions per second. ', 'type' => 'number', 'format' => 'double', 'example' => '163.0', 'title' => ''], + 'AppWaitTime' => ['description' => 'The wait time of the client. ', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'ElapsedTime' => ['description' => 'The average response time. ', 'type' => 'number', 'format' => 'double', 'example' => '76.382', 'title' => ''], + 'ExecuteTime' => ['description' => 'The internal execution time. ', 'type' => 'number', 'format' => 'double', 'example' => '61.044', 'title' => ''], + 'QueueTime' => ['description' => 'The queuing time. ', 'type' => 'number', 'format' => 'double', 'example' => '15.275', 'title' => ''], + 'ConcurrencyWaitTime' => ['description' => 'The wait time in concurrent execution. ', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'CpuTime' => ['description' => 'The average CPU time. ', 'type' => 'number', 'format' => 'double', 'example' => '50.13', 'title' => ''], + 'DecodeTime' => ['description' => 'The time to wait for decoding. ', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'NetWaitTime' => ['description' => 'The wait time for network.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'IOWaitTime' => ['description' => 'The I/O wait time. ', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'GetPlanTime' => ['description' => 'Hard parsing time.', 'type' => 'number', 'format' => 'double', 'example' => '0.052', 'title' => ''], + 'MaxElapsedTime' => ['description' => 'The maximum response time. ', 'type' => 'number', 'format' => 'double', 'example' => '260.044', 'title' => ''], + 'TotalWaitTime' => ['description' => 'The internal wait time. ', 'type' => 'number', 'format' => 'double', 'example' => '10.966', 'title' => ''], + 'ScheduleTime' => ['description' => 'The scheduling duration. ', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], + 'MaxCpuTime' => ['description' => 'The maximum CPU time. ', 'type' => 'number', 'format' => 'double', 'example' => '257.967', 'title' => ''], + 'EndTimeUTCString' => ['description' => 'The end time. ', 'type' => 'string', 'example' => '2021-12-28T02:08:18Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Count' => ['description' => 'The quantity. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SlowSQLHistoryList\\": {\\n \\"List\\": [\\n {\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"SqlType\\": \\"1\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"UserName\\": \\"tester\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"AffectedRows\\": 0,\\n \\"BlockCacheHit\\": 14,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"BloomFilterCacheHit\\": 0,\\n \\"Executions\\": 89403,\\n \\"FailTimes\\": 0,\\n \\"RPCCount\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"ReturnRows\\": 1,\\n \\"LogicalRead\\": 19,\\n \\"RetryCount\\": 0,\\n \\"RowCacheHit\\": 0,\\n \\"DiskRead\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"SsstoreReadRowCount\\": 43086,\\n \\"ExecPerSecond\\": 163,\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"ExecuteTime\\": 61.044,\\n \\"QueueTime\\": 15.275,\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"CpuTime\\": 50.13,\\n \\"DecodeTime\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"GetPlanTime\\": 0.052,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"TotalWaitTime\\": 10.966,\\n \\"ScheduleTime\\": 0,\\n \\"MaxCpuTime\\": 257.967,\\n \\"EndTimeUTCString\\": \\"2021-12-28T02:08:18Z\\"\\n }\\n ],\\n \\"Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n \\n 8D6E84****0B8FB1823D199E2CA1****\\n 1\\n pay_online\\n tester\\n 1*2.***.1*3.***\\n testdb\\n mysql response wait client\\n i-bp18qljorblo8es*****\\n 0\\n 14\\n 4\\n 0\\n 89403\\n 0\\n 0\\n 0\\n 0\\n 1\\n 19\\n 0\\n 0\\n 0\\n 527\\n 43086\\n 163\\n 0\\n 76.382\\n 61.044\\n 15.275\\n 0\\n 50.13\\n 0\\n 0\\n 0\\n 0.052\\n 260.044\\n 10.966\\n 0\\n 257.967\\n 2021-12-28T02:08:18Z\\n \\n 1\\n \\n","errorExample":""}]', + 'title' => 'DescribeSlowSQLHistoryList', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 [【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSlowSQLHistoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSlowSQLList' => [ + 'summary' => 'You can call this operation to query the list of slow SQL statements ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant.', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => 'The start time.', 'description' => 'The start time of the time range for querying slow SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => 'The end time.', 'description' => 'The end time of the time range for querying slow SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database.', 'description' => 'The name of the database. ', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => ['title' => 'The search keyword.', 'description' => 'The search keyword. ', 'type' => 'string', 'required' => false, 'example' => 'update'], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => ['title' => 'The search parameter.', 'description' => 'The search parameter. ', 'type' => 'string', 'required' => false, 'example' => 'cputime'], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => ['title' => 'The search rule.', 'description' => 'The search rule. ', 'type' => 'string', 'required' => false, 'example' => '>'], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => ['title' => 'The search value.', 'description' => 'The search value. ', 'type' => 'string', 'required' => false, 'example' => '0.01'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'The SQL ID.', 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => ['title' => 'The IP address of the node.', 'description' => 'The IP address of the database node. ', 'type' => 'string', 'required' => false, 'example' => 'i-bp18qljorblo8es*****'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => 'The page number.', 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => 'The page size.', 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['title' => 'The filter condition.', 'description' => 'The filter condition. ', 'type' => 'object', 'required' => false, 'example' => '[dbName:sys]'], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => ['title' => 'The sorted column.', 'description' => 'The sorted column. ', 'type' => 'string', 'required' => false, 'example' => 'cputime'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => ['title' => 'The sorting rule.', 'description' => 'The sorting rule. ', 'type' => 'string', 'required' => false, 'example' => 'desc'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'The total count.', 'description' => 'The total count. ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RequestId' => ['title' => 'The request ID.', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'SlowSQLList' => [ + 'title' => 'The list of slow SQL statements.', + 'description' => 'The list of slow SQL statements. ', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The sequence number of the returned SQL statement. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExecPerSecond' => ['description' => 'The number of executions per second. ', 'type' => 'number', 'format' => 'float', 'example' => '163.0', 'title' => ''], + 'SQLText' => ['description' => 'The SQL text. ', 'type' => 'string', 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', 'title' => ''], + 'MaxCpuTime' => ['description' => 'The maximum CPU time. ', 'type' => 'number', 'format' => 'float', 'example' => '257.967', 'title' => ''], + 'BlockCacheHit' => ['description' => 'The number of block cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '14', 'title' => ''], + 'DecodeTime' => ['description' => 'The time to wait for decoding. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'RemotePlans' => ['description' => 'The number of remote plans. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RPCCount' => ['description' => 'The number of RPCs. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetWaitTime' => ['description' => 'The network latency. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'DiskRead' => ['description' => 'The number of physical reads. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NodeIp' => ['description' => 'The IP address of the node. ', 'type' => 'string', 'example' => 'i-bp18qljorblo8es*****', 'title' => ''], + 'ConcurrencyWaitTime' => ['description' => 'The wait time in concurrent execution. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'MemstoreReadRowCount' => ['description' => 'The number of rows read from the memory. ', 'type' => 'integer', 'format' => 'int64', 'example' => '527', 'title' => ''], + 'DbName' => ['description' => 'The name of the database. ', 'type' => 'string', 'example' => 'testdb', 'title' => ''], + 'AppWaitTime' => ['description' => 'The wait time of the client. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'ElapsedTime' => ['description' => 'The average response time. ', 'type' => 'number', 'format' => 'float', 'example' => '76.382', 'title' => ''], + 'MissPlans' => ['description' => 'The number of plan misses. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AffectedRows' => ['description' => 'The number of rows affected. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ScheduleTime' => ['description' => 'The scheduling duration. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'Event' => ['description' => 'The wait event. ', 'type' => 'string', 'example' => 'mysql response wait client', 'title' => ''], + 'TotalWaitTime' => ['description' => 'The internal wait time. ', 'type' => 'number', 'format' => 'float', 'example' => '10.966', 'title' => ''], + 'ReturnRows' => ['description' => 'The number of rows returned. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExecuteTime' => ['description' => 'The internal execution time. ', 'type' => 'number', 'format' => 'float', 'example' => '61.044', 'title' => ''], + 'UserName' => ['description' => 'The username. ', 'type' => 'string', 'example' => 'tester', 'title' => ''], + 'Executions' => ['description' => 'The number of executions. ', 'type' => 'integer', 'format' => 'int64', 'example' => '89403', 'title' => ''], + 'GetPlanTime' => ['description' => 'The time spent in hard parsing. ', 'type' => 'number', 'format' => 'float', 'example' => '0.052', 'title' => ''], + 'CpuTime' => ['description' => 'The average CPU time. ', 'type' => 'number', 'format' => 'float', 'example' => '50.13', 'title' => ''], + 'MaxElapsedTime' => ['description' => 'The maximum response time. ', 'type' => 'number', 'format' => 'float', 'example' => '260.044', 'title' => ''], + 'SQLType' => ['description' => 'The SQL type. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BlockIndexCacheHit' => ['description' => 'The number of block index cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'RetryCount' => ['description' => 'The number of retries. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'SQLId' => ['description' => 'SQLID.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client. ', 'type' => 'string', 'example' => '1*2.***.1*3.***', 'title' => ''], + 'BloomFilterCacheHit' => ['description' => 'The number of Bloom filter cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'IOWaitTime' => ['description' => 'The I/O wait time. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'FailTimes' => ['description' => 'The number of failures. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'QueueTime' => ['description' => 'The queuing time. ', 'type' => 'number', 'format' => 'float', 'example' => '15.275', 'title' => ''], + 'RowCacheHit' => ['description' => 'The number of row cache hits. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'LogicalRead' => ['description' => 'The number of logical reads. ', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], + 'SsstoreReadRowCount' => ['description' => 'The number of rows read from the disk. ', 'type' => 'integer', 'format' => 'int64', 'example' => '43086', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SlowSQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"ExecPerSecond\\": 163,\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"DbName\\": \\"testdb\\",\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"SQLType\\": 1,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"RetryCount\\": 0,\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 1\\n 163\\n SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\n 257.967\\n 14\\n 0\\n 0\\n 0\\n 0\\n 0\\n i-bp18qljorblo8es*****\\n 0\\n 527\\n testdb\\n 0\\n 76.382\\n 0\\n 0\\n 0\\n mysql response wait client\\n 10.966\\n 1\\n 61.044\\n tester\\n 89403\\n 0.052\\n 50.13\\n 260.044\\n 1\\n 4\\n 0\\n 8D6E84****0B8FB1823D199E2CA1****\\n 1*2.***.1*3.***\\n 0\\n 0\\n 0\\n 15.275\\n 0\\n 19\\n 43086\\n \\n","errorExample":""}]', + 'title' => 'DescribeSlowSQLList', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 [【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM) [【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline?spm=a2c63.p38356.0.0.cc7e1ffeUU8HNb)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSlowSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeSqlAuditStat' => [ + 'summary' => 'You can call this operation to collect the execution statistics of an SQL statement by client IP address, user, and SQL statement ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => false, 'example' => 't33h8y08k****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The start time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\'.', 'type' => 'string', 'required' => false, 'example' => '2025-01-14T02:34:49Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The end time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\' . The time range cannot exceed 6 hours.', 'type' => 'string', 'required' => false, 'example' => '2025-01-14T03:34:49Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + ], + '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' => ' '."\n" + .'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'."\n"], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '', 'description' => 'The ID of the cluster instance.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 't33h8y08k****'], + 'UserClientIp' => ['title' => '', 'description' => 'The IP address of the client.', 'type' => 'string', 'example' => 'xx.xx.xx.xx'."\n"], + 'UserName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'test_mysql '], + 'DatabaseName' => ['title' => '', 'description' => 'The name of the database', 'type' => 'string', 'example' => 'test_database_1'], + 'SqlId' => ['title' => 'SqlID', 'description' => 'The ID of the SQL statement.', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'TotalSucceed' => ['title' => '', 'description' => 'The total number of successful executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalFailed' => ['title' => '', 'description' => 'The total number of failed executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAffectRows' => ['title' => '', 'description' => 'The total number of affected rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalScanRows' => ['title' => '', 'description' => 'The total number of scanned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalReturnRows' => ['title' => '', 'description' => 'The total number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AffectRows' => ['title' => '', 'description' => 'The average number of affected rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'ScanRows' => ['title' => '', 'description' => 'The average number of scanned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'ReturnRows' => ['title' => '', 'description' => 'The average number of returned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'ExecuteTime' => ['title' => '', 'description' => 'The average execution time, in ms.', 'type' => 'number', 'format' => 'double', 'example' => '142'], + 'SqlStatement' => ['title' => '', 'description' => 'The SQL template.', 'type' => 'string', 'example' => 'UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?'], + 'OperatorType' => ['title' => '', 'description' => 'The type of the operation.', 'type' => 'string', 'example' => 'UPDATE'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TotalCount' => ['title' => '总数', 'description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\\\t\\\\nEE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UserClientIp\\": \\"xx.xx.xx.xx\\\\n\\",\\n \\"UserName\\": \\"test_mysql \\",\\n \\"DatabaseName\\": \\"test_database_1\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"TotalSucceed\\": 1,\\n \\"TotalFailed\\": 0,\\n \\"TotalAffectRows\\": 1,\\n \\"TotalScanRows\\": 10,\\n \\"TotalReturnRows\\": 1,\\n \\"AffectRows\\": 1,\\n \\"ScanRows\\": 1,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 142,\\n \\"SqlStatement\\": \\"UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?\\",\\n \\"OperatorType\\": \\"UPDATE\\"\\n }\\n ],\\n \\"TotalCount\\": 9\\n}","type":"json"}]', + 'title' => 'DescribeSqlAuditStat', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSqlAuditStat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeStandbyCreateMode' => [ + 'summary' => 'DescribeStandbyCreateMode', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob4wibn0abo9uo'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 'txxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'CreateMode' => [ + 'title' => '', + 'description' => 'The creation mode. Enumerated values: * DIRECT_CREATE: indicates that the standby cluster was created empty. * BACKUP_RESTORE: indicates that the standby cluster was created by using the backup and restore feature.', + 'type' => 'string', + 'enumValueTitles' => ['DIRECT_CREATE' => '', 'BACKUP_RESTORE' => ''], + 'example' => 'BACKUP_RESTORE', + 'enum' => ['BACKUP_RE', 'STORE/DIRE', 'CT_CREATE'], + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"CreateMode\\": \\"BACKUP_RESTORE\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the standby cluster creation mode', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeTagValues' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tag', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Map' => ['description' => 'The mappings between tag groups and tags.', 'type' => 'string', 'example' => '"{\\"标签组2\\":[\\"标签值2-1\\",\\"标签值2-2\\"],\\"标签组1\\":[\\"标签值1-1\\"]}"', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Map\\": \\"\\\\\\"{\\\\\\\\\\\\\\"标签组2\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值2-1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"标签值2-2\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"标签组1\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值1-1\\\\\\\\\\\\\\"]}\\\\\\"\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DescribeTagValues', + 'summary' => 'You can call this operation to query tags.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTagValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenant' => [ + 'summary' => 'View information about a specified tenant in a specified cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'Detailed tenant information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Tenant' => [ + 'title' => 'The information of the tenant. ', + 'description' => 'Tenant information.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => 'The ID of the tenant. ', 'description' => 'Tenant ID.', 'type' => 'string', 'example' => 't4louaeei****'], + 'TenantName' => ['title' => 'The name of the tenant. ', 'description' => 'Tenant name.', 'type' => 'string', 'example' => 'forMySQLTenant'], + 'TenantMode' => ['title' => 'The tenant mode. Valid values: Oracle and MySQL', 'description' => 'Tenant mode.
'."\n" + .'Supported values:
'."\n" + ."\n" + .'- Oracle: Oracle mode.'."\n" + ."\n" + .'- MySQL: MySQL mode.', 'type' => 'string', 'example' => 'MySQL'], + 'VpcId' => ['title' => 'The ID of the VPC. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC".', 'description' => 'VPC ID.'."\n" + .'If you do not have a suitable VPC, create one as instructed on the console. For more information, see What is a virtual private cloud?', 'type' => 'string', 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], + 'Status' => ['title' => 'The status of the tenant. PENDING_CREATE: The tenant is being created. RESTORE: The tenant is being recovered. ONLINE: The tenant is running. SPEC_MODIFYING: The specification of the tenant is being modified. ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated. PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled. PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone. PARAMETER_MODIFYING: Parameters are being modified. WHITE_LIST_MODIFING: The whitelist is being modified.', 'description' => 'Tenant status:'."\n" + ."\n" + .'- ONLINE: running.'."\n" + ."\n" + .'- PENDING\\_CREATE: creating.'."\n" + ."\n" + .'- WAITING\\_ALLOCATE\\_MASTER\\_ADDRESS: (secondary database) waiting to create primary endpoint.'."\n" + ."\n" + .'- ALLOCATING\\_MASTER\\_ADDRESS: creating primary endpoint.'."\n" + ."\n" + .'- DELETING\\_MASTER\\_ADDRESS: deleting primary endpoint.'."\n" + ."\n" + .'- ALLOCATING\\_INTERNET\\_ADDRESS: creating public endpoint.'."\n" + ."\n" + .'- PENDING\\_OFFLINE\\_INTERNET\\_ADDRESS: deleting public endpoint.'."\n" + ."\n" + .'- ALLOCATING\\_READONLY\\_ADDRESS: creating read-only endpoint.'."\n" + ."\n" + .'- DELETING\\_READONLY\\_ADDRESS: deleting read-only endpoint.'."\n" + ."\n" + .'- ALLOCATING\\_READWRITE\\_ADDRESS: creating read/write splitting endpoint.'."\n" + ."\n" + .'- DELETING\\_READWRITE\\_ADDRESS: deleting read/write splitting endpoint.'."\n" + ."\n" + .'- ALLOCATING\\_CLOGSERVICE\\_ADDRESS: creating transaction log endpoint.'."\n" + ."\n" + .'- DELETING\\_CLOGSERVICE\\_ADDRESS: deleting transaction log endpoint.'."\n" + ."\n" + .'- MODIFYING\\_ADDRESS: modifying endpoint domain name.'."\n" + ."\n" + .'- MODIFYING\\_PRIMARY\\_ZONE: switching primary zone.'."\n" + ."\n" + .'- MODIFYING\\_READONLY\\_ADDRESS: modifying read-only endpoint.'."\n" + ."\n" + .'- MODIFYING\\_READWRITE\\_ADDRESS: modifying read/write splitting endpoint.'."\n" + ."\n" + .'- SPEC\\_MODIFYING: modifying specifications.'."\n" + ."\n" + .'- WHITE\\_LIST\\_MODIFYING: modifying whitelist.'."\n" + ."\n" + .'- CREATING\\_BINLOG: creating Binlog.', 'type' => 'string', 'example' => 'ONLINE'], + 'EnableInternetAddressService' => ['title' => 'Indicates whether the Internet address can be enabled for the tenant. ', 'description' => 'Indicates whether the tenant\'s public endpoint can be enabled.', 'type' => 'boolean', 'example' => 'true'], + 'PrimaryZone' => ['title' => 'The primary zone of the tenant. ', 'description' => 'Primary zone of the tenant.', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'DeployType' => ['title' => 'The deployment type of the cluster. Valid values: multiple: multi-IDC deployment. single: single-IDC deployment. dual: dual-IDC deployment.', 'description' => 'Cluster deployment type.'."\n" + ."\n" + .'- multiple: multi-data center.'."\n" + ."\n" + .'- single: single data center.'."\n" + ."\n" + .'- dual: dual data center.', 'type' => 'string', 'example' => 'multiple'], + 'DeployMode' => ['title' => 'The data replica distribution mode of the tenant. For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode. For the basic version, N indicates the single-zone mode. N represents the number of nodes in a single zone. ', 'description' => 'Data replica mode of the tenant.'."\n" + ."\n" + .'- For High-availability Edition: N-N-N for three regions; N-N for two zones and single zone.'."\n" + ."\n" + .'- For Basic Edition: N.'."\n" + ."\n" + .'>
N is the number of nodes in a single zone.
', 'type' => 'string', 'example' => 'FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j'], + 'Description' => ['title' => 'The description of the tenant. ', 'description' => 'Tenant description.', 'type' => 'string', 'example' => 'paycore database'], + 'CreateTime' => ['title' => 'The time when the tenant was created. ', 'description' => 'Tenant creation time.', 'type' => 'string', 'example' => '2023-04-21 11:15:47.0'], + 'TenantResource' => [ + 'title' => 'The resource information of the tenant. ', + 'description' => 'Tenant resource information.', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['title' => 'The number of resource units in the tenant. ', 'description' => 'Number of tenant units.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Cpu' => [ + 'title' => 'The information about of the CPU resources of the tenant. ', + 'description' => 'CPU resource information of the tenant.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => ['title' => 'The number of used CPU cores of the tenant. ', 'description' => 'Used CPU cores of the tenant. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'TotalCpu' => ['title' => 'The total number of CPU cores of the tenant. ', 'description' => 'Total CPU cores of the tenant. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '10'], + 'UnitCpu' => ['title' => 'The number of CPU cores in each resource unit of the tenant. ', 'description' => 'CPU cores per unit of the tenant. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '8'], + ], + 'example' => '', + ], + 'Memory' => [ + 'title' => 'The information about the memory resources of the tenant. ', + 'description' => 'Memory resource information of the tenant.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => ['title' => 'The size of used memory of the tenant, in GB. ', 'description' => 'Used memory of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '30'], + 'TotalMemory' => ['title' => 'The total memory size of the tenant, in GB. ', 'description' => 'Total memory size of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '64'], + 'UnitMemory' => ['title' => 'The memory size of each resource unit of the tenant, in GB. ', 'description' => 'Memory size per unit of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '32'], + ], + 'example' => '', + ], + 'DiskSize' => [ + 'title' => 'The information about the disk resources of the tenant. ', + 'description' => 'Disk resource information of the tenant.', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => ['title' => 'The size of used disk space of the tenant, in GB. ', 'description' => 'Used disk size of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '86'], + ], + 'example' => '', + ], + 'CapacityUnit' => [ + 'title' => '容量单元', + 'description' => 'Capacity unit.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => ['title' => '最大容量单元', 'description' => 'Maximum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'MinCapacityUnit' => ['title' => '最小容量单元', 'description' => 'Minimum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UsedCapacit' => ['title' => '已使用容量单元', 'description' => 'Used capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + ], + 'example' => '', + ], + 'LogDiskSize' => [ + 'description' => 'Log disk resource information of the tenant.', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => ['description' => 'Total allocated log disk size of the tenant. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8.0', 'title' => ''], + 'UnitLogDisk' => ['description' => 'Allocated log disk size per unit of the tenant. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'MigrationObjectsInfo' => [ - 'title' => '减少的对象（迁移）', - 'description' => '', + 'example' => '', + ], + 'TenantConnections' => [ + 'title' => 'The connection access information of the tenant. ', + 'description' => 'Connection information of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'Connection information of the tenant.', 'type' => 'object', 'properties' => [ - 'WildcardMode' => [ - 'title' => '是否通配模式', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tables' => [ - 'title' => '待迁移的 table 列表', - 'description' => '', + 'IntranetAddress' => ['title' => 'The intranet address for accessing the tenant. ', 'description' => 'Private endpoint for accessing the tenant.', 'type' => 'string', 'example' => 't4nunwxr0****.oceanbase.aliyuncs.com'], + 'IntranetPort' => ['title' => 'The intranet port for accessing the tenant. ', 'description' => 'Private port for accessing the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '2983'], + 'InternetAddress' => ['title' => 'The Internet address for accessing the tenant. ', 'description' => 'Public endpoint for accessing the tenant.', 'type' => 'string', 'example' => 't4nunwxr0****-mi.oceanbase.aliyuncs.com'], + 'InternetPort' => ['title' => 'The Internet port for accessing the tenant. ', 'description' => 'Public port for accessing the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], + 'VpcId' => ['title' => 'The ID of the VPC. ', 'description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1qiail1asmfe23t****'], + 'VSwitchId' => ['title' => 'The ID of the vSwitch. ', 'description' => 'VSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1i7b94u2et716yl****'], + 'IntranetAddressMasterZoneId' => ['title' => 'The primary zone corresponding to the address for accessing the tenant. ', 'description' => 'Primary zone corresponding to the tenant\'s connection endpoint.', 'type' => 'string', 'example' => 'cn-hangzhou-b'], + 'IntranetAddressSlaveZoneId' => ['title' => 'The standby zone corresponding to the address for accessing the tenant. ', 'description' => 'Secondary zone corresponding to the tenant\'s connection endpoint.', 'type' => 'string', 'example' => 'cn-hangzhou-g'], + 'IntranetAddressStatus' => ['title' => 'The status of the intranet address for accessing the tenant. The value ONLINE indicates that the address is in service.', 'description' => 'Status of the tenant\'s private endpoint.'."\n" + .'ONLINE: in service.', 'type' => 'string', 'example' => 'ONLINE'], + 'ConnectionZones' => [ + 'title' => 'The list of zones corresponding to the tenant connection. ', + 'description' => 'List of zones accessible through the tenant connection.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Schema' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'Name' => [ - 'title' => '对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - ], - ], + 'items' => ['description' => 'Zone accessible through the tenant connection.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], + 'example' => '["cn-hangzhou-i", "cn-hangzhou-j"]', ], - 'TablesBlack' => [ - 'title' => '待迁移的 table 黑名单列表', - 'description' => '', + 'InternetAddressStatus' => ['title' => 'The status of the Internet address for accessing the tenant. Valid values: CLOSED: The address is disabled. ALLOCATING_INTERNET_ADDRESS: An address is being applied for. PENDING_OFFLINE_INTERNET_ADDRESS: The address is being disabled. ONLINE: The address is in service.', 'description' => 'Status of the tenant\'s public network connection.'."\n" + ."\n" + .'- CLOSED: shutdown.'."\n" + ."\n" + .'- ALLOCATING\\_INTERNET\\_ADDRESS: requesting.'."\n" + ."\n" + .'- PENDING\\_OFFLINE\\_INTERNET\\_ADDRESS: shutting down public endpoint.'."\n" + ."\n" + .'- ONLINE: in service.', 'type' => 'string', 'example' => 'CLOSED'], + 'TransactionSplit' => ['title' => '是否开启事务拆分', 'description' => 'Indicates whether transaction splitting is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'AddressType' => [ + 'title' => '地址类型', + 'description' => 'Endpoint type.'."\n" + ."\n" + .'- MASTER: primary endpoint, supports read and write.'."\n" + ."\n" + .'- READONLY: read-only endpoint, supports read only.'."\n" + ."\n" + .'- READWRITE: read/write splitting endpoint, enables automatic read/write splitting.'."\n" + ."\n" + .'- CLOGSERVICE: transaction log service endpoint.', + 'enumValueTitles' => ['MASTER' => 'MASTER', 'READWRITE' => 'READWRITE', 'CLOGSERVICE' => 'CLOGSERVICE', 'READONLY' => 'READONLY'], + 'type' => 'string', + 'example' => 'READONLY', + ], + 'EnableTransactionSplit' => ['title' => '是否开启事务拆分', 'description' => 'Indicates whether transaction splitting is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'ParallelQueryDegree' => ['title' => '并行度', 'description' => 'Degree of parallelism.', 'type' => 'integer', 'format' => 'int64', 'default' => '2', 'example' => '1'], + 'TenantEndpointId' => ['title' => '租户地址id', 'description' => 'Tenant endpoint ID.', 'type' => 'string', 'example' => 'obe-4tw51gp7****'], + 'MaxConnectionNum' => ['title' => '最大连接数', 'description' => 'Maximum connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '5000'], + 'ConnectionReplicaType' => ['title' => '链接对应的副本类型', 'description' => 'Replica type corresponding to the connection.', 'type' => 'string', 'example' => 'FULL'], + 'ProxyClusterId' => ['description' => 'ODP cluster ID.', 'type' => 'string', 'example' => 'proxy-xxxxxxx', 'title' => ''], + 'MaxConnectionLimit' => ['title' => '私网最大连接数的当前值', 'description' => 'Current value of maximum private connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'InternetMaxConnectionLimit' => ['title' => '公网最大连接数的上限', 'description' => 'Upper limit of maximum public connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '4000'], + 'IntranetRpcPort' => ['description' => 'Private bypass import port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3307'."\n", 'title' => ''], + 'InternetMaxConnectionNum' => ['title' => '公网最大连接数的当前值', 'description' => 'Current value of maximum public connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '2500'], + 'InternetRpcPort' => ['description' => 'Public bypass import port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3307', 'title' => ''], + 'ConnectionLogicalZones' => [ + 'description' => 'Logical zones where the endpoint resides.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Schema' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'Name' => [ - 'title' => '对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - ], - ], + 'items' => ['description' => 'Information about the logical zone where the endpoint resides.', 'type' => 'string', 'example' => 'cn-bejing-3-z0,cn-bejing-4-z0', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Views' => [ - 'title' => '待迁移的 view 列表', - 'description' => '', + 'IntranetSqlPort' => ['description' => 'Private SQL port.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3306'], + 'OdpVersion' => ['description' => 'ODP version.', 'type' => 'string', 'example' => '4.3.1-xxxxxxxxx', 'title' => ''], + 'InternetSqlPort' => ['title' => 'Internet SQL port', 'description' => 'Public SQL port.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'InternetAddressServiceType' => ['title' => 'The service type of the Internet address.', 'description' => 'Type of public endpoint.', 'type' => 'string', 'example' => ''], + 'IntranetAddressServiceType' => ['title' => 'Private endpoint address type', 'description' => 'Type of private endpoint.', 'type' => 'string', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TenantZones' => [ + 'title' => 'The zone information of the tenant. ', + 'description' => 'Zone information of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'Zone information of the tenant.', + 'type' => 'object', + 'properties' => [ + 'TenantZoneId' => ['title' => 'The ID of the zone. ', 'description' => 'Tenant zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'Region' => ['title' => 'The region where the zone of the tenant resides. ', 'description' => 'Region to which the tenant zone belongs.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'TenantZoneRole' => ['title' => 'The request type of the zone of the tenant. ReadWrite: The zone supports data reads and writes. ReadOnly: The zone supports only data reads. For a high availability cluster with multiple IDCs, the primary zone provides ReadWrite services, and the standby zone provides ReadOnly services. For a high availability cluster with a single IDC, all zones provide ReadWrite services. ', 'description' => 'Role of the tenant zone.', 'type' => 'string', 'example' => 'ReadWrite'], + 'TenantZoneReplicas' => [ + 'description' => 'Replica information of the tenant zone.', 'type' => 'array', 'items' => [ + 'description' => 'Replica information of the tenant zone.', 'type' => 'object', 'properties' => [ - 'Schema' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'Name' => [ - 'title' => '对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], + 'ZoneReplicaType' => ['description' => 'Replica type of the zone.', 'type' => 'string', 'example' => 'FULL', 'title' => ''], + 'ZoneNodes' => ['description' => 'Zone nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'LogicZoneName' => ['description' => 'Logical zone name.', 'type' => 'string', 'example' => 'cn-shanghai-f-z0', 'title' => ''], + 'ZoneCopyId' => ['description' => 'Zone replica ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'FullCopyId' => ['description' => 'Full-function replica ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ReadOnlyCopyId' => ['description' => 'Read-only replica ID.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'ReadOnlyReplicaType' => ['description' => 'Read-only replica type.', 'type' => 'string', 'example' => 'ROW_STORE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ClogServiceStatus' => ['title' => 'The enabling status of the Clog service. CLOSED: The Clog service is disabled. ONLINE: The Clog service is running.', 'description' => 'Clog service status.'."\n" + ."\n" + .'- CLOSED: shutdown.'."\n" + ."\n" + .'- ONLINE: in service.', 'type' => 'string', 'example' => 'ONLINE'], + 'EnableClogService' => ['title' => 'Indicates whether the Clog service is available. To enable the Clog service, submit a ticket. ', 'description' => 'Indicates whether Clog service is available. To enable it, submit a ticket.', 'type' => 'boolean', 'example' => 'true'], + 'Charset' => ['title' => '字符集', 'description' => 'Character set.', 'type' => 'string', 'example' => 'gb18030'], + 'Collation' => ['title' => '字符序', 'description' => 'Collation.', 'type' => 'string', 'example' => 'gb18030_chinese_ci'], + 'PrimaryZoneDeployType' => [ + 'title' => '租户主可用区部署模式', + 'description' => 'Deployment mode of the tenant\'s primary zone.', + 'enumValueTitles' => ['RANDOM' => 'RANDOM', 'STATIC' => 'STATIC'], + 'type' => 'string', + 'example' => 'STATIC', + ], + 'MasterIntranetAddressZone' => ['title' => '租户主地址可用区', 'description' => 'Zone where the Master node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'PayType' => ['title' => '付费类型', 'description' => 'Payment type.', 'type' => 'string', 'example' => 'POSTPAY'], + 'InstanceType' => ['title' => '实例类型', 'description' => 'Instance type.', 'type' => 'string', 'example' => 'KAFKA_PUBLIC'], + 'Series' => ['title' => '实例系列', 'description' => 'Instance edition.', 'type' => 'string', 'example' => 'normal'], + 'DiskType' => ['title' => '磁盘类型', 'description' => 'Disk type.', 'type' => 'string', 'example' => 'cloud_essd_pl1'], + 'AvailableZones' => [ + 'title' => '可用区', + 'description' => 'List of available zones.', + 'type' => 'array', + 'items' => ['description' => 'List of available zones.', 'type' => 'string', 'example' => '["cn-hangzhou-i"]', 'title' => ''], + 'example' => '', + ], + 'EnableReadWriteSplit' => ['title' => '是否允许开启读写分离地址', 'description' => 'Indicates whether read/write splitting endpoint can be enabled.', 'type' => 'boolean', 'example' => 'true'], + 'EnableParallelQuery' => ['title' => '是否允许开通并行查询', 'description' => 'Indicates whether parallel query can be enabled.', 'type' => 'boolean', 'example' => 'true'], + 'MaxParallelQueryDegree' => ['title' => '并行度设置上限', 'description' => 'Upper limit of degree of parallelism.', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'EnableBinlogService' => ['title' => '是否可以申请Binlog服务', 'description' => 'Indicates whether Binlog service can be requested.', 'type' => 'boolean', 'example' => 'true'], + 'TimeZone' => ['title' => '租户所在时区。 详细参见：DescribeTimeZones。', 'description' => 'Time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai'], + 'DataMergeTime' => ['title' => '租户合并时间，仅对4.0以上OB版本有效', 'description' => 'Tenant merge time. Supported only in OceanBase V4.0.0 and later.', 'type' => 'string', 'example' => '02:36Z'], + 'ReadOnlyResource' => [ + 'description' => 'Read-only resource information.', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['title' => '租户的unit个数。', 'description' => 'Number of tenant units.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Cpu' => [ + 'description' => 'CPU per replica node in the cluster. Unit: Core.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => ['description' => 'Used CPU of the cluster. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], + 'TotalCpu' => ['title' => '租户总的CPU核数，单位：Core。', 'description' => 'Total CPU cores of the tenant. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '10'], + 'UnitCpu' => ['title' => '租户每个Unit的CPU核数，单位：Core。', 'description' => 'CPU cores per unit of the tenant. Unit: Core.', 'type' => 'number', 'format' => 'float', 'example' => '8'], + ], + 'title' => '', + 'example' => '', + ], + 'Memory' => [ + 'description' => 'Cluster memory information.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => ['title' => '租户已使用的内存，单位：GB。', 'description' => 'Used memory of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '30'], + 'TotalMemory' => ['title' => '租户总的内存大小，单位：GB。', 'description' => 'Total memory size of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '64'], + 'UnitMemory' => ['title' => '租户每个Unit的内存大小，单位：GB。', 'description' => 'Memory size per unit of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '32'], + ], + 'title' => '', + 'example' => '', + ], + 'DiskSize' => [ + 'description' => 'Data disk size specification.', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => ['title' => '租户已使用的磁盘大小，单位：GB。', 'description' => 'Used disk size of the tenant. Unit: GB.', 'type' => 'number', 'format' => 'float', 'example' => '86'], + ], + 'title' => '', + 'example' => '', + ], + 'CapacityUnit' => [ + 'description' => 'Capacity unit information.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => ['title' => '最大容量单元', 'description' => 'Maximum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'MinCapacityUnit' => ['title' => '最小容量单元', 'description' => 'Minimum capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UsedCapacit' => ['title' => '已使用容量单元', 'description' => 'Used capacity unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + ], + 'title' => '', + 'example' => '', + ], + 'LogDiskSize' => [ + 'description' => 'Log disk size information.', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => ['description' => 'Total log disk size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8.0', 'title' => ''], + 'UnitLogDisk' => ['description' => 'Log disk unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '8.0', 'title' => ''], ], - 'ViewsBlack' => [ - 'title' => '待迁移的 view 黑名单列表', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'EnableReadOnlyReplica' => ['description' => 'Indicates whether read-only replicas are supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RecycleBinStatus' => ['title' => '表示租户回收站状态，ON表示开启，OFF表示关闭', 'description' => 'Tenant recycle bin status. ON indicates enabled. OFF indicates disabled.', 'type' => 'string', 'example' => 'ON'], + 'LowerCaseTableNames' => ['description' => 'Indicates whether table names are case-sensitive. Valid values:'."\n" + ."\n" + .'- **1**: not case-sensitive'."\n" + ."\n" + .'- **0**: case-sensitive', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Version' => ['title' => '版本信息', 'description' => 'Version information.', 'type' => 'string', 'example' => '4.2.1'], + 'OdpVersion' => ['description' => 'ODP version.', 'type' => 'string', 'example' => '4.3.1-xxxxxxxxx', 'title' => ''], + 'TenantMaxConnections' => ['title' => '租户允许的最大连接数', 'description' => 'Maximum allowed connections for the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600'], + 'ParameterTemplate' => ['title' => '参数模板', 'description' => 'Parameter template.', 'type' => 'string', 'example' => 'express_oltp'], + 'Iops' => ['title' => 'Tenant IOPS ', 'description' => 'Tenant IOPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Tenant\\": {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"EnableInternetAddressService\\": true,\\n \\"PrimaryZone\\": \\"cn-hangzhou-h\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j\\",\\n \\"Description\\": \\"paycore database\\",\\n \\"CreateTime\\": \\"2023-04-21 11:15:47.0\\",\\n \\"TenantResource\\": {\\n \\"UnitNum\\": 1,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"TenantConnections\\": [\\n {\\n \\"IntranetAddress\\": \\"t4nunwxr0****.oceanbase.aliyuncs.com\\",\\n \\"IntranetPort\\": 2983,\\n \\"InternetAddress\\": \\"t4nunwxr0****-mi.oceanbase.aliyuncs.com\\",\\n \\"InternetPort\\": 3306,\\n \\"VpcId\\": \\"vpc-bp1qiail1asmfe23t****\\",\\n \\"VSwitchId\\": \\"vsw-bp1i7b94u2et716yl****\\",\\n \\"IntranetAddressMasterZoneId\\": \\"cn-hangzhou-b\\",\\n \\"IntranetAddressSlaveZoneId\\": \\"cn-hangzhou-g\\",\\n \\"IntranetAddressStatus\\": \\"ONLINE\\",\\n \\"ConnectionZones\\": [\\n \\"cn-hangzhou-b\\"\\n ],\\n \\"InternetAddressStatus\\": \\"CLOSED\\",\\n \\"TransactionSplit\\": false,\\n \\"AddressType\\": \\"READONLY\\",\\n \\"EnableTransactionSplit\\": false,\\n \\"ParallelQueryDegree\\": 1,\\n \\"TenantEndpointId\\": \\"obe-4tw51gp7****\\",\\n \\"MaxConnectionNum\\": 5000,\\n \\"ConnectionReplicaType\\": \\"FULL\\",\\n \\"ProxyClusterId\\": \\"proxy-xxxxxxx\\",\\n \\"MaxConnectionLimit\\": 1000,\\n \\"InternetMaxConnectionLimit\\": 4000,\\n \\"IntranetRpcPort\\": 3307,\\n \\"InternetMaxConnectionNum\\": 2500,\\n \\"InternetRpcPort\\": 3307,\\n \\"ConnectionLogicalZones\\": [\\n \\"cn-bejing-3-z0,cn-bejing-4-z0\\"\\n ],\\n \\"IntranetSqlPort\\": 3306,\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"InternetSqlPort\\": 0,\\n \\"InternetAddressServiceType\\": \\"\\",\\n \\"IntranetAddressServiceType\\": \\"\\"\\n }\\n ],\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"TenantZoneReplicas\\": [\\n {\\n \\"ZoneReplicaType\\": \\"FULL\\",\\n \\"ZoneNodes\\": 1,\\n \\"LogicZoneName\\": \\"cn-shanghai-f-z0\\",\\n \\"ZoneCopyId\\": 2,\\n \\"FullCopyId\\": 3,\\n \\"ReadOnlyCopyId\\": \\"3\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ]\\n }\\n ],\\n \\"ClogServiceStatus\\": \\"ONLINE\\",\\n \\"EnableClogService\\": true,\\n \\"Charset\\": \\"gb18030\\",\\n \\"Collation\\": \\"gb18030_chinese_ci\\",\\n \\"PrimaryZoneDeployType\\": \\"STATIC\\",\\n \\"MasterIntranetAddressZone\\": \\"cn-hangzhou-h\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"InstanceType\\": \\"KAFKA_PUBLIC\\",\\n \\"Series\\": \\"normal\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"AvailableZones\\": [\\n \\"[\\\\\\"cn-hangzhou-i\\\\\\"]\\"\\n ],\\n \\"EnableReadWriteSplit\\": true,\\n \\"EnableParallelQuery\\": true,\\n \\"MaxParallelQueryDegree\\": 32,\\n \\"EnableBinlogService\\": true,\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"DataMergeTime\\": \\"02:36Z\\",\\n \\"ReadOnlyResource\\": {\\n \\"UnitNum\\": 2,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"EnableReadOnlyReplica\\": true,\\n \\"RecycleBinStatus\\": \\"ON\\",\\n \\"LowerCaseTableNames\\": 1,\\n \\"Version\\": \\"4.2.1\\",\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"TenantMaxConnections\\": 1600,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n}","type":"json"}]', + 'title' => 'Query the specified tenant information under the specified cluster.', + 'changeSet' => [ + ['createdAt' => '2026-05-21T10:21:23.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-05-21T10:21:21.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-05-21T10:21:20.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-02-11T03:27:37.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-01-29T06:14:30.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-08-05T15:58:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-03T13:53:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-05T16:11:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-15T13:01:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-01T13:29:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-15T11:26:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-02T12:38:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T12:16:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-30T13:51:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-25T09:00:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-21T11:36:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-09T02:29:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-04T02:53:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-17T02:26:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-01T03:58:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T06:07:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenant', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantAddressProxyInfo' => [ + 'summary' => 'You can call this operation to query the address proxy service information about a tenant.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob********', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't********', 'title' => '', 'required' => false], + ], + ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Data' => [ + 'description' => 'The information about the object to query.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 't********', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'forMySQLTenant', 'title' => ''], + 'TenantConnections' => [ + 'description' => 'The information about the tenant endpoint.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'TenantEndpointId' => ['description' => 'The ID of the tenant endpoint.', 'type' => 'string', 'example' => 'obe-********', 'title' => ''], + 'AddressType' => ['description' => 'The address type.', 'type' => 'string', 'title' => '', 'example' => 'MASTER'], + 'IntranetAddress' => ['description' => 'The domain name of the private IP address.', 'type' => 'string', 'title' => '', 'example' => 'xx.xx.xx.xx'], + 'IntranetPort' => ['description' => 'The service port of the private IP address.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3306'], + 'IntranetAddressStatus' => ['description' => 'The status of the private IP address.', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'], + 'MaxConnectionNum' => ['description' => 'The maximum number of connections of the private IP address.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1500'], + 'IntranetAddressMasterZoneId' => ['description' => 'The primary zone of the private IP address.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-j'], + 'IntranetAddressSlaveZoneId' => ['description' => 'The standby zone of the private IP address.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-i'], + 'InternetAddress' => ['description' => 'The domain name of the public IP address.', 'type' => 'string', 'title' => '', 'example' => 't4nun********-mi.oceanbase.aliyuncs.com'], + 'InternetPort' => ['description' => 'The service port of the public IP address.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3306'], + 'InternetAddressStatus' => ['description' => 'The status of the public IP address.', 'type' => 'string', 'title' => '', 'example' => 'CLOSED'], + 'InternetMaxConnectionNum' => ['description' => 'The maximum number of connections of the public IP address.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1500'], + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'title' => '', 'example' => 'vpc-********'], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'title' => '', 'example' => 'vsw-********'], + 'MaxConnectionLimit' => ['description' => 'The maximum number of connections allowed for the private IP address.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '50000'], + 'InternetMaxConnectionLimit' => ['description' => 'The maximum number of connections allowed for the public IP address.', 'type' => 'string', 'title' => '', 'example' => '4000'], + 'ProxyClusterInfo' => [ + 'description' => 'Proxy service information.', 'type' => 'object', 'properties' => [ - 'Schema' => [ - 'title' => '库名', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'Name' => [ - 'title' => '对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'view_name', - ], + 'Status' => ['description' => 'The status of the proxy cluster.', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'], + 'Zone' => ['description' => 'The list of zones for proxies, which are separated with commas (,).', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-j,cn-hangzhou-k'], + 'UnitNum' => ['description' => 'The number of proxy specification types.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'ExclusiveUnitNumLimit' => ['description' => 'The maximum number of exclusive specifications of the proxy.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'CreateTime' => ['description' => 'The time when the proxy cluster was created, in the ISO 8601 format.', 'type' => 'string', 'example' => '2026-01-12T03:34:22Z', 'title' => ''], + 'ProxyVersion' => ['description' => 'The kernel version of the proxy.', 'type' => 'string', 'title' => '', 'example' => '4.3.1.9-32025112117'], + 'ProxyClusterId' => ['description' => 'The ID of the proxy cluster.', 'type' => 'string', 'title' => '', 'example' => 'ob********'], + 'AllowModifyServerNum' => ['description' => 'Specifies whether you are allowed to modify the number of server groups.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'SharedUnitNumLimit' => ['description' => 'The maximum number of shared specifications of the proxy.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], + 'DeployMode' => ['description' => 'The deployment mode of the proxy.', 'type' => 'string', 'title' => '', 'example' => '2-2'], + 'UnitSpec' => ['description' => 'The basic specification of the proxy. For example, 2C4G indicates two CPU cores and 4 GB of memory.', 'type' => 'string', 'title' => '', 'example' => '2C4G'], + 'ProxyServiceVersion' => ['description' => 'The architecture version of the proxy.', 'type' => 'string', 'title' => '', 'example' => '1.0'], + 'ProxyMode' => ['description' => 'The proxy mode.', 'type' => 'string', 'title' => '', 'example' => 'fusion'], + 'ServerNumLimit' => ['description' => 'The maximum number of server groups.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '15'], + 'AllowModifyProxyMode' => ['description' => 'Specifies whether you are allowed to modify the proxy mode.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableExclusiveNodeMode' => ['description' => 'Specifies whether to enable the exclusive node mode.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'NeedUpdateProxyMode' => ['description' => 'Specifies whether the proxy architecture needs to be updated.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IsExclusiveNodeMode' => ['description' => 'Specifies whether the proxy is in exclusive node mode.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'OmsProjectMappingInfo' => [ - 'title' => '减少的对象对应的匹配规则（迁移）', - 'description' => '', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeTenantAddressProxyInfo', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"TenantId\\": \\"t********\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"TenantConnections\\": [\\n {\\n \\"TenantEndpointId\\": \\"obe-********\\",\\n \\"AddressType\\": \\"MASTER\\",\\n \\"IntranetAddress\\": \\"xx.xx.xx.xx\\",\\n \\"IntranetPort\\": 3306,\\n \\"IntranetAddressStatus\\": \\"ONLINE\\",\\n \\"MaxConnectionNum\\": 1500,\\n \\"IntranetAddressMasterZoneId\\": \\"cn-hangzhou-j\\",\\n \\"IntranetAddressSlaveZoneId\\": \\"cn-hangzhou-i\\",\\n \\"InternetAddress\\": \\"t4nun********-mi.oceanbase.aliyuncs.com\\",\\n \\"InternetPort\\": 3306,\\n \\"InternetAddressStatus\\": \\"CLOSED\\",\\n \\"InternetMaxConnectionNum\\": 1500,\\n \\"VpcId\\": \\"vpc-********\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"MaxConnectionLimit\\": 50000,\\n \\"InternetMaxConnectionLimit\\": \\"4000\\",\\n \\"ProxyClusterInfo\\": {\\n \\"Status\\": \\"ONLINE\\",\\n \\"Zone\\": \\"cn-hangzhou-j,cn-hangzhou-k\\",\\n \\"UnitNum\\": 2,\\n \\"ExclusiveUnitNumLimit\\": 10,\\n \\"CreateTime\\": \\"2026-01-12T03:34:22Z\\",\\n \\"ProxyVersion\\": \\"4.3.1.9-32025112117\\",\\n \\"ProxyClusterId\\": \\"ob********\\",\\n \\"AllowModifyServerNum\\": false,\\n \\"SharedUnitNumLimit\\": 4,\\n \\"DeployMode\\": \\"2-2\\",\\n \\"UnitSpec\\": \\"2C4G\\",\\n \\"ProxyServiceVersion\\": \\"1.0\\",\\n \\"ProxyMode\\": \\"fusion\\",\\n \\"ServerNumLimit\\": 15,\\n \\"AllowModifyProxyMode\\": true,\\n \\"EnableExclusiveNodeMode\\": false,\\n \\"NeedUpdateProxyMode\\": true,\\n \\"IsExclusiveNodeMode\\": false\\n }\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeTenantEncryption' => [ + 'summary' => 'You can call this operation to query the encryption information of a tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => false, 'example' => 't4louaeei****', 'title' => ''], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', 'type' => 'string', 'required' => false, 'example' => 'forMySQLTenant', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TotalCount' => ['description' => 'The total number of entries returned. This parameter takes effect in a pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'TenantEncryptions' => [ + 'description' => 'The scenarios supporting encryption.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about scenarios supporting encryption.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4louaeei****', 'title' => ''], + 'TenantMode' => ['description' => 'The compatible mode of the tenant. Valid values: '."\n" + .'* Oracle '."\n" + .'* MySQL', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'forMySQLTenant', 'title' => ''], + 'EnableEncryption' => ['description' => 'Indicates whether encryption is enabled. Valid values: '."\n" + .'* true '."\n" + .'* false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TenantStatus' => ['description' => 'The status of the tenant.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'Status' => ['description' => 'The status of tenant encryption enablement.', 'type' => 'string', 'example' => 'OPEN', 'title' => ''], + 'EncryptionType' => ['title' => '', 'description' => 'The encryption type.', 'type' => 'string', 'example' => 'INTERNAL'], + 'EncryptionKeyId' => ['title' => 'xxx', 'description' => 'The ID of the encryption key created by Key Management Service (KMS).', 'type' => 'string', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 8,\\n \\"TenantEncryptions\\": [\\n {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"EnableEncryption\\": false,\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"Status\\": \\"OPEN\\",\\n \\"EncryptionType\\": \\"INTERNAL\\",\\n \\"EncryptionKeyId\\": \\"xxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantEncryption', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantEncryption', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantMetrics' => [ + 'summary' => 'The monitoring metrics. '."\n" + .'For more information about supported metrics, see [View tenant statistics](~~212125~~). ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The start time of the time range for querying monitoring data. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'description' => '2021-06-13T15:40:43Z', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => 'The end time of the time range for querying monitoring data. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'description' => 'tfafd34fs****', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => 'The list of tenant IDs. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. '."\n" + .'>
This parameter will be deprecated. We recommend that you use the TenantIdList parameter instead. ', 'description' => '2021-06-13T15:45:43Z', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'pay_online'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => 'The request ID. ', 'description' => 'Example 1', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeTenantMetrics'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&PageSize=10'."\n" + .'&PageNumber=1'."\n" + .'&TenantName=pay_online'."\n" + .'&StartTime=2021-06-13 15:40:43'."\n" + .'&EndTime=2021-09-13 15:40:43'."\n" + .'&Metrics=tps'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&TenantIdList=["t3ddna03wqpog","t3dachev5jkm8","t3d6maw3t41vk"]'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'End time of monitoring data. '."\n" + .'This time supports only UTC, in the format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:45:43Z'], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => ['title' => 'You can call this operation to query the metrics of a specified OceanBase Database tenant. ', 'description' => '{"name":"DescribeTenantMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeTenantMetrics\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"ob317v4uif****\\"},{\\"name\\":\\"PageSize\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"10\\"},{\\"name\\":\\"PageNumber\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"1\\"},{\\"name\\":\\"TenantName\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"pay_online\\"},{\\"name\\":\\"StartTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:40:43Z\\"},{\\"name\\":\\"EndTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:45:43Z\\"},{\\"name\\":\\"Metrics\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tps\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tfafd34fs****\\"},{\\"name\\":\\"TenantIdList\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"[tdak3nac****,tdakc42df****]\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"TotalCount\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"9\\"},{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"TenantMetrics\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tps'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Tenant ID. '."\n" + .'>
This parameter will be deprecated in the future. We recommend that you use TenantIdList instead.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'tfafd34fs****'], + ], + [ + 'name' => 'TenantIdList', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'List of tenant IDs. ', 'type' => 'string', 'required' => false, 'example' => '[tdak3nac****,tdakc42df****]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Return Result of the request', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TenantMetrics' => ['title' => '', 'description' => 'Tenant metric information.', 'type' => 'string', 'example' => '"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantMetrics\\": \\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"\\n}","type":"json"}]', + 'title' => 'Query Tenant Metric Information', + 'changeSet' => [ + ['createdAt' => '2025-08-05T15:58:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-16T03:49:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T13:01:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-01-17T12:57:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-30T06:26:47.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantReadableScn' => [ + 'summary' => 'You can call this operation to query the maximum readable timestamp of a tenant.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'required' => true, 'example' => 't33h8y08k****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8442BB1E-3171-1192-B9DC-F6F4E53B2673'], + 'Data' => [ + 'description' => 'The data in the return result of the request.', + 'type' => 'object', + 'properties' => [ + 'ReadableScn' => ['description' => 'The maximum readable timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715329164977', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8442BB1E-3171-1192-B9DC-F6F4E53B2673\\",\\n \\"Data\\": {\\n \\"ReadableScn\\": 1715329164977\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTenantReadableScn', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeTenantSecurityConfigs' => [ + 'summary' => 'You can call this operation to query security check items of an OceanBase Database tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 't4louaeei****'], + ], + [ + 'name' => 'CheckId', + 'in' => 'formData', + 'schema' => ['title' => '安全检测的唯一标识', 'description' => 'The unique identifier of the security check.', 'type' => 'string', 'required' => false, 'example' => '****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '523E7183-1490-590D-BA03-12DFD316614B'], + 'Configs' => [ + 'description' => 'The list of parameters.', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => ['title' => '', 'description' => 'The total number of security check items.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'TotalRiskCount' => ['title' => '', 'description' => 'The total number of detected security risks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'TenantSecurityConfigs' => [ + 'title' => '', + 'description' => 'The check result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the tenant.', 'type' => 'object', 'properties' => [ - 'SchemaMappings' => [ - 'title' => 'schema映射信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceName' => [ - 'title' => '源schema名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_name', - ], - 'DestName' => [ - 'title' => '映射schema名', - 'description' => '', - 'type' => 'string', - 'example' => 'mapped_schema', - ], - ], - ], - ], - 'TableMappings' => [ - 'title' => '表映射信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceSchema' => [ - 'title' => '源schema名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_schema', - ], - 'SourceName' => [ - 'title' => '源对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_name', - ], - 'DestName' => [ - 'title' => '映射对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_name', - ], - ], - ], - ], - 'ColumnMappings' => [ - 'title' => '列映射信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceSchema' => [ - 'title' => '源schema名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_schema', - ], - 'SourceTable' => [ - 'title' => '源table名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_table', - ], - 'SourceName' => [ - 'title' => '源对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_name', - ], - 'DestName' => [ - 'title' => '目的对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_name', - ], - ], - ], - ], - 'ViewMappings' => [ - 'title' => '视图映射信息列表', - 'description' => '', + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 'xxx'], + 'TenantName' => ['title' => '', 'description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'xxx'], + 'RiskCount' => ['title' => '', 'description' => 'The number of detected tenant security risks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'SecurityConfigs' => [ + 'title' => '', + 'description' => 'The list of risks.', 'type' => 'array', 'items' => [ + 'description' => 'The list of risks.', 'type' => 'object', 'properties' => [ - 'SourceSchema' => [ - 'title' => '源schema名', - 'description' => '', - 'type' => 'string', - 'example' => 'schema_name', - ], - 'SourceName' => [ - 'title' => '源对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'source_name', - ], - 'DestName' => [ - 'title' => '映射对象名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_name', - ], + 'ConfigGroup' => ['title' => '', 'description' => 'The group of the risk.', 'type' => 'string', 'example' => 'WHITELIST'], + 'ConfigName' => ['title' => '', 'description' => 'The name of the risk.', 'type' => 'string', 'example' => 'WHITELIST_RANGE_LARGE'], + 'Risk' => ['title' => '', 'description' => 'Indicates whether the risk causes security issues.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'RiskDescription' => ['title' => '', 'description' => 'The description of the risk.', 'type' => 'string', 'example' => '白名单开放过大，建议按需设置'], + 'ConfigDescription' => ['title' => '', 'description' => 'The name of the check item.', 'type' => 'string', 'example' => '校验集群白名单范围是否过大'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'TableEtlList' => [ - 'title' => '减少对象的etl信息（迁移）', - 'description' => '', + 'example' => '', + ], + 'CheckId' => ['title' => '检测的唯一标识', 'description' => 'The unique identifier of the check.', 'type' => 'string', 'example' => ' xxx'], + 'InstanceId' => ['title' => 'Oceanbase集群ID。', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'CheckTime' => ['title' => '检测时间', 'description' => 'The time when the check was performed.', 'type' => 'string', 'example' => '2023-08-07 15:30:00'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"523E7183-1490-590D-BA03-12DFD316614B\\",\\n \\"Configs\\": {\\n \\"TotalCheckCount\\": 4,\\n \\"TotalRiskCount\\": 0,\\n \\"TenantSecurityConfigs\\": [\\n {\\n \\"TenantId\\": \\"xxx\\",\\n \\"TenantName\\": \\"xxx\\",\\n \\"RiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigName\\": \\"WHITELIST_RANGE_LARGE\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"白名单开放过大，建议按需设置\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ]\\n }\\n ],\\n \\"CheckId\\": \\" xxx\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTenantSecurityConfigs', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantSecurityConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantSecurityIpGroups' => [ + 'summary' => 'You can call this operation to view the list of whitelist groups of the tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of the whitelist groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'SecurityIpGroups' => [ + 'title' => '', + 'description' => 'The list of the whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'test1'], + 'SecurityIps' => ['title' => '', 'description' => 'The whitelist of IP addresses. It is a string separated by commas, and each object is an IP string or a CIDR block.', 'type' => 'string', 'example' => '192.***.*.*'], + 'SecurityIpGroupType' => ['title' => '', 'description' => 'The whitelist group type.'."\n" + .'- instance: the whitelist group from the cluster.'."\n" + .'- tenant: the whitelist group of the current tenant.', 'type' => 'string', 'example' => 'tenant'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4louaeei****'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIpGroupName\\": \\"test1\\",\\n \\"SecurityIps\\": \\"192.***.*.*\\",\\n \\"SecurityIpGroupType\\": \\"tenant\\",\\n \\"TenantId\\": \\"t4louaeei****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantSecurityIpGroups', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantSecurityIpGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantTags' => [ + 'summary' => 'You can call this operation to query the tags of tenants in a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantIds', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The JSON string of the tenant ID.', 'type' => 'string', 'required' => true, 'example' => '["t5r0x2f6q****", "t33h8y08k****", "t5r41rtl7****"]'], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tags.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Key": "xxx", "Value", "xxx"}]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TagResources' => [ + 'title' => '', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned response.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '', 'description' => 'The ID of the resource.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'ResourceType' => ['title' => '', 'description' => 'The type of the resource.', 'type' => 'string', 'example' => 'instance'], + 'Tag' => ['title' => '', 'description' => 'The tag of the resource.', 'type' => 'string', 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"ob317v4uif****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": \\"[{\\\\\\"Key\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"Value\\\\\\", \\\\\\"xxx\\\\\\"},{}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantTags', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantUserRoles' => [ + 'summary' => 'You can call this operation to obtain the account authorization information of the tenant. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'TenantId: 租户id, 如果传入的是mysql模式租户Id, 则返回mysql模式下普通用户的权限配置信息; 如果传入的是oracle租户Id, 则返回的是oracle普通用户的权限配置信息', 'description' => 'The ID of the tenant. If you specify the ID of a tenant in MySQL mode, the privilege configuration of the regular user in MySQL mode is returned. If you specify the ID of a tenant in Oracle mode, the privilege configuration of the regular user in Oracle mode is returned.', 'type' => 'string', 'required' => false, 'example' => 't4pnum****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => 'The list of roles of the user. Valid values: ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. ReadOnly: a role that has only the read-only privilege SELECT. DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'description' => 'The list of roles of the user. '."\n" + .'Valid values: '."\n" + ."\n" + .'ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES.'."\n" + .'ReadOnly: a role that has only the read-only privilege SELECT.'."\n" + .'DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW.'."\n" + .'DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'type' => 'array', + 'items' => ['description' => 'The return result of the request.', 'type' => 'string', 'example' => 'DDL', 'title' => ''], + 'example' => '', + ], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 1000 => [ + ['errorCode' => 'E001R000', 'errorMessage' => 'Error found, please try agent later.', 'description' => ''], + ], + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": [\\n \\"DDL\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DDL\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'DescribeTenantUserRoles', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantUsers' => [ + 'summary' => 'Queries the list of database access accounts under a tenant.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The filter keyword for fuzzy match when querying the list.', 'type' => 'string', 'required' => false, 'example' => 'pay'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The page number of the paged query.'."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of rows per page for the paged query.'."\n" + .'Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The database account name.'."\n" + .'Certain reserved keywords such as SYS and root cannot be used.', 'type' => 'string', 'example' => 'pay_test', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of database accounts in the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TenantUsers' => [ + 'title' => '', + 'description' => 'The list of database accounts in the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a database account.', + 'type' => 'object', + 'properties' => [ + 'UserType' => ['title' => '', 'description' => 'The type of the database account. Valid values:'."\n" + .'- Admin: superuser account.'."\n" + .'- Normal: standard account.', 'type' => 'string', 'example' => 'Normal'], + 'Description' => ['title' => '', 'description' => 'The description of the database account.', 'type' => 'string', 'example' => 'use for test'], + 'Databases' => [ + 'title' => '', + 'description' => 'The list of database permissions granted to the account.', 'type' => 'array', 'items' => [ + 'description' => 'The details of a database account.', 'type' => 'object', 'properties' => [ - 'TenantName' => [ - 'title' => '租户名', - 'description' => '', - 'type' => 'string', - 'example' => 'tenant_name', - ], - 'Database' => [ - 'title' => '数据库名', - 'description' => '', - 'type' => 'string', - 'example' => 'db_name', - ], - 'DestDatabase' => [ - 'title' => '目标数据库名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_db', - ], - 'TableName' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'example' => 'table_name', - ], - 'DestName' => [ - 'title' => '目标端表名/Topic名', - 'description' => '', - 'type' => 'string', - 'example' => 'dest_name', - ], - 'WhereClause' => [ - 'title' => 'sql 语法', - 'description' => '', - 'type' => 'string', - 'example' => 'id>1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col', - ], - ], - 'ShardColumns' => [ - 'title' => '分片键列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - ], - 'LogicTableId' => [ - 'title' => '针对逻辑表下，逻辑表 tableId', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'SourceEndpointId' => [ - 'title' => '针对物理表下传递 endpointId', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'Database' => ['title' => '', 'description' => 'The database (schema) name.', 'type' => 'string', 'example' => 'db_pay1'], + 'Role' => ['title' => '', 'description' => 'The granted role. '."\n" + .'For Oracle mode, roles are at the schema level. Valid values: '."\n" + .'- ReadWrite: read and write permissions, including CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE. '."\n" + .'- ReadOnly: read-only permission, including SELECT.'."\n" + .'For MySQL mode, roles are at the database level. Valid values:'."\n" + .'- ReadWrite: read and write permissions, including ALL PRIVILEGES.'."\n" + .'- ReadOnly: read-only permission, including SELECT.'."\n" + .'- DDL: DDL permissions, including CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW. '."\n" + .'- DML: DML permissions, including SELECT, INSERT, UPDATE, DELETE, SHOW VIEW. '."\n" + ."\n" + .'>
In addition, an Oracle account has default read and write permissions on its own schema, which are not listed here.', 'type' => 'string', 'example' => 'ReadOnly'], + 'Table' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'tbl_pay1'], + 'Privileges' => ['description' => 'When custom permissions are granted to a user for a database, privileges returns the custom permission content separated by commas (,). Otherwise, privileges does not return data.', 'type' => 'string', 'example' => 'select,delete,update', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'UserStatus' => ['title' => '', 'description' => 'The status of the database account. Valid values:'."\n" + .'- LOCKED: locked.'."\n" + .'- ONLINE: unlocked.', 'type' => 'string', 'example' => 'ONLINE'], + 'UserName' => ['title' => '', 'description' => 'The database account name.', 'type' => 'string', 'example' => 'pay_test'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant to which the account belongs.', 'type' => 'string', 'example' => 't4pnum**** '], + 'InstanceId' => ['title' => '', 'description' => 'The ID of the cluster to which the account belongs.', 'type' => 'string', 'example' => 'obshc32****'], + 'GlobalPermissions' => ['title' => '', 'description' => 'The global permission information.', 'type' => 'string', 'example' => 'Encrypt,Decrypt'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUsers\\": [\\n {\\n \\"UserType\\": \\"Normal\\",\\n \\"Description\\": \\"use for test\\",\\n \\"Databases\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"Privileges\\": \\"select,delete,update\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum**** \\",\\n \\"InstanceId\\": \\"obshc32****\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query tenant account list', + 'changeSet' => [ + ['createdAt' => '2025-02-13T13:01:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-04T02:53:06.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-15T11:37:08.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTenantZonesRead' => [ + 'summary' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The zone information of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The return result of the request. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The ID of the tenant. ', + 'description' => 'Indicates whether a read-only connection has been created. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Indicates whether the zone is the primary zone. ', 'description' => 'Indicates whether a read-only connection needs to be created for the zone. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TenantZones' => [ + 'title' => 'Indicates whether the zone can be set as the primary zone. ', + 'description' => 'The request ID. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to DescribeTenantZonesRead. ', + 'type' => 'object', + 'properties' => [ + 'IsElectable' => ['title' => 'The ID of the zone. ', 'description' => 'Example 1', 'type' => 'boolean', 'example' => 'true'], + 'IsPrimary' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeTenantZonesRead'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Indicates whether the zone is the primary zone.', 'type' => 'boolean', 'example' => 'true'], + 'Zone' => ['title' => 'You can call this operation to query the information about read-only zones of a tenant. ', 'description' => 'Zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'IsReadable' => ['title' => '', 'description' => 'Indicates whether the zone can be set to read-only.', 'type' => 'string', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantZones\\": [\\n {\\n \\"IsElectable\\": true,\\n \\"IsPrimary\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsReadable\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Read-Only Zone Information of a Tenant', + 'changeSet' => [ + ['createdAt' => '2023-07-04T02:52:48.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [], + ], + 'DescribeTenants' => [ + 'summary' => 'Lists tenant information for the specified OceanBase clusters.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the tenant. It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', 'description' => 'The tenant name.
The name must be 2 to 20 characters long, start with a letter or an underscore, and consist of letters, digits, and underscores (\\_). The name is case-sensitive. "sys" is a reserved name and cannot be used.
', 'type' => 'string', 'required' => false, 'example' => 'pay_online'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => 'The number of rows to return on each page. Maximum value: 100. Default value: 10.', 'description' => 'The number of items to return per page.'."\n" + ."\n" + .'- Maximum value: 100'."\n" + ."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => 'The number of the page to return. Start value: 1. Default value: 1.', 'description' => 'The page number to return.'."\n" + ."\n" + .'- Minimum value: 1'."\n" + ."\n" + .'- Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant.', 'type' => 'string', 'required' => false, 'example' => 'ob2mr3oae0****'], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => ['title' => 'The search keyword. ', 'description' => 'The keyword to filter query results.', 'type' => 'string', 'example' => 'pay', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'The total number of tenants in the specified OceanBase cluster. ', 'description' => 'The total number of tenants in the specified OceanBase cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Tenants' => [ + 'title' => 'The information of tenants. ', + 'description' => 'A list of tenant objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tenant object.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'The ID of the VPC. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC".', 'description' => 'The ID of the VPC.
If no suitable VPC is available, follow the prompts on the page to create one. For more information, see What is a VPC.
', 'type' => 'string', 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], + 'Status' => ['title' => 'The status of the tenant. PENDING_CREATE: The tenant is being created. RESTORE: The tenant is being recovered. ONLINE: The tenant is running. SPEC_MODIFYING: The specification of the tenant is being modified. ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated. PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled. PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone. PARAMETER_MODIFYING: Parameters are being modified. WHITE_LIST_MODIFING: The whitelist is being modified.', 'description' => 'The status of the tenant.
'."\n" + ."\n" + .'- `PENDING_CREATE`: The tenant is being created.'."\n" + ."\n" + .'- `RESTORE`: The tenant is being restored.'."\n" + ."\n" + .'- `ONLINE`: The tenant is running.'."\n" + ."\n" + .'- `SPEC_MODIFYING`: The tenant\'s specifications are being modified.'."\n" + ."\n" + .'- `ALLOCATING_INTERNET_ADDRESS`: A public endpoint is being allocated.'."\n" + ."\n" + .'- `PENDING_OFFLINE_INTERNET_ADDRESS`: The public endpoint is being disabled.'."\n" + ."\n" + .'- `PRIMARY_ZONE_MODIFYING`: The primary zone is being switched.'."\n" + ."\n" + .'- `PARAMETER_MODIFYING`: The tenant\'s parameters are being modified.'."\n" + ."\n" + .'- `WHITE_LIST_MODIFYING`: The tenant\'s allow list is being modified.', 'type' => 'string', 'example' => 'ONLINE'], + 'PrimaryZone' => ['title' => 'The primary zone of the tenant. ', 'description' => 'The primary zone of the tenant.', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'DeployType' => ['title' => 'The deployment type of the tenant. multiple: multi-IDC deployment. single: single-IDC deployment. dual: dual-IDC deployment.', 'description' => 'The deployment type of the tenant.
'."\n" + ."\n" + .'- `multiple`: Multi-data center deployment'."\n" + ."\n" + .'- `single`: Single-data center deployment'."\n" + ."\n" + .'- `dual`: Dual-data center deployment', 'type' => 'string', 'example' => 'multiple'], + 'DeployMode' => ['title' => 'The data replica distribution mode of the tenant. For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode. For the basic version, N indicates the single-zone mode. N represents the number of nodes in a single zone. ', 'description' => 'The deployment mode of the tenant.'."\n" + ."\n" + .'- For the high availability edition, the value is N-N-N for a three-zone deployment, and N-N for two-zone and single-zone deployments.'."\n" + ."\n" + .'- For the basic edition, the value is N.'."\n" + ."\n" + .'>
N represents the number of nodes per availability zone.
', 'type' => 'string', 'example' => '1-1-1'], + 'CreateTime' => ['title' => 'The time when the tenant was created. ', 'description' => 'The time when the tenant was created.', 'type' => 'string', 'example' => '2021-09-17 15:52:17.0'], + 'TenantName' => ['title' => 'The name of the tenant. ', 'description' => 'The tenant name.', 'type' => 'string', 'example' => 'pay_online'], + 'Mem' => ['title' => 'The total memory size of the tenant, in GB. ', 'description' => 'The total memory of the tenant, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Cpu' => ['title' => 'The total number of CPU cores of the tenant. ', 'description' => 'The total number of CPU cores of the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Description' => ['title' => 'The description of the tenant. ', 'description' => 'The tenant description.', 'type' => 'string', 'example' => 'paycore database'], + 'TenantMode' => ['title' => 'The tenant mode. Valid values: Oracle and MySQL', 'description' => 'The tenant mode.
'."\n" + .'Valid values:
'."\n" + ."\n" + .'- `Oracle`: Oracle-compatible mode'."\n" + ."\n" + .'- `MySQL`: MySQL-compatible mode', 'type' => 'string', 'example' => 'Oracle'], + 'TenantId' => ['title' => 'The ID of the tenant. ', 'description' => 'The tenant ID.', 'type' => 'string', 'example' => 't33h8y08k****'], + 'UnitCpu' => ['title' => 'The number of CPU cores in each resource unit of the tenant. ', 'description' => 'The number of CPU cores per tenant unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'UnitMem' => ['title' => 'The memory size of each resource unit of the tenant, in GB. ', 'description' => 'The memory size per tenant unit, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'UnitNum' => ['title' => 'The number of resource units in the tenant. ', 'description' => 'The number of units in the tenant.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UsedDiskSize' => ['title' => 'The number of used disks of the tenant.', 'description' => 'The amount of disk space used by the tenant.', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'Charset' => ['title' => '字符集', 'description' => 'The character set.', 'type' => 'string', 'example' => 'utf8mb4'], + 'Collation' => ['title' => '字符序', 'description' => 'The collation.', 'type' => 'string', 'example' => 'utf8mb4_general_ci'], + 'EnableReadOnlyReplica' => ['description' => 'Indicates whether read-only replicas are supported.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'ParameterTemplate' => ['title' => '参数模板', 'description' => 'The parameter template.', 'type' => 'string', 'example' => 'express_oltp'], + 'Iops' => ['type' => 'integer', 'format' => 'int32', 'example' => '10000', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Tenants\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-i\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CreateTime\\": \\"2021-09-17 15:52:17.0\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"Mem\\": 20,\\n \\"Cpu\\": 10,\\n \\"Description\\": \\"paycore database\\",\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UnitCpu\\": 5,\\n \\"UnitMem\\": 10,\\n \\"UnitNum\\": 2,\\n \\"UsedDiskSize\\": 10,\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"Collation\\": \\"utf8mb4_general_ci\\",\\n \\"EnableReadOnlyReplica\\": false,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenants', + 'changeSet' => [ + ['createdAt' => '2025-07-03T13:53:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-29T14:00:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-02T12:38:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T06:07:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-17T12:57:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T11:04:11.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeTimeZones' => [ + 'summary' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Alibaba Cloud CLI', + 'description' => 'The default time zone. ', + 'type' => 'object', + 'properties' => [ + 'TimeZones' => [ + 'title' => 'The time zones supported by the tenant. ', + 'description' => 'The description of the time zone. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => 'The return result of the request.', + 'description' => 'The list of time zones. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the time zone. ', + 'type' => 'object', + 'properties' => [ + 'TimeZone' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeTimeZones**. ', 'type' => 'string', 'example' => 'Asia/Shanghai'], + 'Description' => ['title' => '-', 'description' => 'Example 1', 'type' => 'string', 'example' => '(GMT+8:00) Asia/Shanghai'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Default' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeTimeZones'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Default time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai'], + ], + 'example' => '', + ], + 'RequestId' => ['title' => 'You can call this API to query the time zones supported by an OceanBase Database tenant. ', 'description' => 'DescribeTimeZones', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TimeZones\\": {\\n \\"List\\": [\\n {\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"Description\\": \\"(GMT+8:00) Asia/Shanghai\\"\\n }\\n ],\\n \\"Default\\": \\"Asia/Shanghai\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Obtain Time Zone List', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeTopSQLList' => [ + 'summary' => 'The number of executions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The time spent in hard parsing.', 'description' => 'The average CPU time, in ms. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['title' => 'The average CPU time.', 'description' => 'The maximum response time, in ms. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T15:40:43Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['title' => 'The maximum response time.', 'description' => 'The SQL type. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => ['title' => 'The SQL type.', 'description' => 'The number of block index cache hits. ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => ['title' => 'The number of block index cache hits.', 'description' => 'The number of retries. ', 'type' => 'string', 'required' => false, 'example' => 'update'], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => ['title' => 'The number of retries.', 'description' => 'SQLID.', 'type' => 'string', 'required' => false, 'example' => 'cputime'], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => ['title' => 'The IP address of the client. ', 'description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '>'], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => ['title' => 'The number of Bloom filter cache hits. ', 'description' => 'The number of Bloom filter cache hits.', 'type' => 'string', 'required' => false, 'example' => '0.01'], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => ['title' => 'SQLID', 'description' => 'The I/O wait time, in ms. ', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => ['title' => 'The I/O wait time.', 'description' => 'The number of failures. ', 'type' => 'string', 'required' => false, 'example' => 'i-bp19y05uq6xpacyqnlrc'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['title' => 'The number of failures.', 'description' => 'The queuing time, in ms. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => 'The queuing time.', 'description' => 'The number of row cache hits. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['title' => 'The number of row cache hits.', 'description' => 'The average number of logical reads of the SQL statement during the specified period of time. '."\n" + .'The value covers the numbers of reads of different caches and the number of disk I/Os. It is an important metric for measuring the SQL filtering performance. '."\n" + ."\n" + .'>
A higher ratio of the number of logical reads to the number of returned rows indicates poorer filtering performance. General causes include non-standard content written by SQL statements, non-standard table indexes created, and non-standard SQL execution plans. ', 'type' => 'object', 'required' => false, 'example' => '[dbName:sys]'], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => ['title' => 'The number of logical reads.', 'description' => 'The number of rows read from the disk. ', 'type' => 'string', 'required' => false, 'example' => 'cputime'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => ['title' => 'The number of rows read from the disk.', 'description' => 'The list of top SQL statements.', 'type' => 'string', 'required' => false, 'example' => 'desc'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request.', + 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification. ', 'description' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'RequestId' => ['title' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', 'description' => 'Alibaba Cloud CLI', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'TopSQLList' => [ + 'title' => 'The number of failures. ', + 'description' => 'The I/O wait time, in ms. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address of the node. ', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'The average number of logical reads of the SQL statement during the specified period of time. '."\n" + .'The value covers the numbers of reads of different caches and the number of disk I/Os. It is an important metric for measuring the SQL filtering performance. '."\n" + ."\n" + .'>
A higher ratio of the number of logical reads to the number of returned rows indicates poorer filtering performance. General causes include non-standard content written by SQL statements, non-standard table indexes created, and non-standard SQL execution plans. ', 'description' => 'The name of the database. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ExecPerSecond' => ['title' => 'The number of block cache hits. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeTopSQLList**. ', 'type' => 'number', 'format' => 'float', 'example' => '163.0'], + 'SQLText' => ['title' => 'The ID of the tenant. ', 'description' => 'The list of top SQL statements. ', 'type' => 'string', 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC'], + 'MaxCpuTime' => ['title' => 'The scheduling duration, in ms. ', 'description' => 'SQLID.', 'type' => 'number', 'format' => 'float', 'example' => '257.967'], + 'BlockCacheHit' => ['title' => 'The network latency, in ms. ', 'description' => 'The average CPU time, in ms. ', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + 'DecodeTime' => ['title' => 'The SQL type. ', 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'RemotePlans' => ['title' => 'The time spent in hard parsing, in ms. ', 'description' => 'The return result of the request. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RPCCount' => ['title' => 'The SQL text. ', 'description' => 'The start time of the time range for querying TOP SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'NetWaitTime' => ['title' => 'The filter condition. ', 'description' => 'The end time of the time range for querying TOP SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'DiskRead' => ['title' => 'The number of RPCs. ', 'description' => 'The IP address of the client. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'NodeIp' => ['title' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', 'description' => 'The username. ', 'type' => 'string', 'example' => 'i-bp18qljorblo8es*****'], + 'ConcurrencyWaitTime' => ['title' => 'The number of block index cache hits. ', 'description' => 'The number of rows returned. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'MemstoreReadRowCount' => ['title' => 'The time to wait for decoding, in ms. ', 'description' => 'The name of the database. ', 'type' => 'integer', 'format' => 'int64', 'example' => '527'], + 'DbName' => ['title' => 'The number of retries. ', 'description' => 'The number of remote plans. ', 'type' => 'string', 'example' => 'testdb'], + 'AppWaitTime' => ['title' => 'The maximum response time, in ms. ', 'description' => 'The wait time in concurrent execution, in ms. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'ElapsedTime' => ['title' => 'The number of rows affected. ', 'description' => 'The sorting rule. ', 'type' => 'number', 'format' => 'float', 'example' => '76.382'], + 'MissPlans' => ['title' => 'The number of physical reads. ', 'description' => 'The total count. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AffectedRows' => ['title' => 'The number of plan misses. ', 'description' => 'The internal wait time, in ms. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ScheduleTime' => ['title' => 'The wait time of the client, in ms. ', 'description' => 'The search keyword. ', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'Event' => ['title' => 'The search parameter. ', 'description' => 'The number of rows read from the disk. ', 'type' => 'string', 'example' => 'mysql response wait client'], + 'TotalWaitTime' => ['title' => 'The number of row cache hits. ', 'description' => '-', 'type' => 'number', 'format' => 'float', 'example' => '10.966'], + 'ReturnRows' => ['title' => 'The sorted column. ', 'description' => 'The wait event. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ExecuteTime' => ['title' => 'The number of executions. ', 'description' => 'The number of rows read from the memory. ', 'type' => 'number', 'format' => 'float', 'example' => '61.044'], + 'UserName' => ['title' => 'The search value. ', 'description' => 'The number of Bloom filter cache hits. ', 'type' => 'string', 'example' => 'tester'], + 'Executions' => ['title' => 'The search rule. ', 'description' => 'The number of executions per second. ', 'type' => 'integer', 'format' => 'int64', 'example' => '89403'], + 'GetPlanTime' => ['title' => 'The average response time, in ms. ', 'description' => 'The queuing time, in ms. ', 'type' => 'number', 'format' => 'float', 'example' => '0.052'], + 'CpuTime' => ['title' => 'SQLID.', 'description' => 'The maximum CPU time, in ms. ', 'type' => 'number', 'format' => 'float', 'example' => '50.13'], + 'MaxElapsedTime' => ['title' => 'The internal execution time, in ms. ', 'description' => 'The sequence number of the returned SQL statement. ', 'type' => 'number', 'format' => 'float', 'example' => '260.044'], + 'SQLType' => ['title' => 'The IP address of the node. ', 'description' => 'The request ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BlockIndexCacheHit' => ['title' => '$.parameters[16].schema.description', 'description' => '$.parameters[16].schema.example', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'RetryCount' => ['title' => '$.parameters[16].schema.enumValueTitles', 'description' => '$.parameters[13].schema.description', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SQLId' => ['title' => 'SQLID', 'description' => '$.parameters[13].schema.example', 'type' => 'string', 'example' => '8D6E84****0B8FB1823D199E2CA1****'], + 'ClientIp' => ['title' => '$.parameters[13].schema.enumValueTitles', 'description' => '$.parameters[14].schema.description', 'type' => 'string', 'example' => '1*2.***.1*3.***'], + 'BloomFilterCacheHit' => ['title' => '$.parameters[14].schema.example', 'description' => '$.parameters[14].schema.enumValueTitles', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'IOWaitTime' => ['title' => '$.parameters[15].schema.description', 'description' => '$.parameters[15].schema.example', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'FailTimes' => ['title' => '$.parameters[15].schema.enumValueTitles', 'description' => '$.parameters[12].schema.description', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueTime' => ['title' => '$.parameters[12].schema.example', 'description' => '$.parameters[12].schema.enumValueTitles', 'type' => 'number', 'format' => 'float', 'example' => '15.275'], + 'RowCacheHit' => ['title' => 'Example 1', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeTopSQLList'."\n" + .'&TenantId=t2mr3oae0****'."\n" + .'&StartTime=2021-06-13 15:40:43'."\n" + .'&EndTime=2021-09-13 15:40:43'."\n" + .'&DbName=testdb'."\n" + .'&SearchKeyWord=update'."\n" + .'&SearchParameter=cputime'."\n" + .'&SearchRule=>'."\n" + .'&SearchValue=0.01'."\n" + .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" + .'&NodeIp=i-bp19y05uq6xpacyqnlrc'."\n" + .'&PageNumber=1'."\n" + .'&PageSize=10'."\n" + .'&SortColumn=cputime'."\n" + .'&SortOrder=desc'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LogicalRead' => ['title' => ' ', 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system. ', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'SsstoreReadRowCount' => ['title' => 'DescribeTopSQLList', 'description' => 'Number of rows read from disk. ', 'type' => 'integer', 'format' => 'int64', 'example' => '43086'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TopSQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"ExecPerSecond\\": 163,\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"DbName\\": \\"testdb\\",\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"SQLType\\": 1,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"RetryCount\\": 0,\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the TopSQL List ', + 'description' => 'To optimize user experience, ApsaraDB has upgraded the SQL diagnosis feature. This API has been unpublished and overridden by a new API. For more information, see [【Notice】Unpublishing of ApsaraDB Diagnosis Management API](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)[【Notice】Unpublishing of ApsaraDB Diagnosis Management API](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline). ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTopSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeZones' => [ + 'summary' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'NORMAL: the high availability version. This is the default value. ', + 'description' => 'The deployment mode. ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NORMAL' => 'NORMAL'], + 'example' => 'NORMAL', + 'enum' => ['normal', 'basic'], + ], + ], + [ + 'name' => 'DeployType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'The request ID. ', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeZones**. ', + 'type' => 'string', + 'required' => false, + 'example' => 'single', + 'enum' => ['multiple', 'single', 'dual'], + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => ['description' => 'CPU architecture ', 'title' => 'CPU architecture ', 'type' => 'string', 'example' => 'x86', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeZones'."\n" + .'&Series=normal'."\n" + .'&DeployType=single'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], + 'Zones' => [ + 'title' => ' ', + 'description' => 'You can call this operation to learn of zones where a cluster can be created in an Alibaba Cloud region. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['title' => '', 'description' => 'List of zone IDs. '."\n" + .'For multi-zone clusters, zone names are concatenated with commas.', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h'], + 'ZoneName' => ['title' => '', 'description' => 'Zone name.', 'type' => 'string', 'example' => 'H/I/J'], + 'Series' => ['title' => '', 'description' => 'OceanBase cluster series. '."\n" + .'NORMAL (default): High-availability Edition.', 'type' => 'string', 'example' => 'NORMAL'], + 'DeployType' => ['title' => '', 'description' => 'Deployment mode.', 'type' => 'string', 'example' => '1-1-1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h\\",\\n \\"ZoneName\\": \\"H/I/J\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"DeployType\\": \\"1-1-1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain zone information', + 'changeSet' => [ + ['createdAt' => '2024-04-15T11:26:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-05T07:31:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [], + ], + 'GetUploadOssUrl' => [ + 'summary' => 'This API generates a temporary URL for uploading to OSS in the public cloud.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The action type. Set this to `CREATE_PROJECT`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'CREATE_PROJECT'], + ], + [ + 'name' => 'EffectiveTimeMinutes', + 'in' => 'formData', + 'schema' => ['description' => 'The validity period in minutes. The value must be an integer from 1 to 30. The default is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error detail.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => ' '."\n" + .'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error severity level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'A map of key-value pairs for placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context used to populate placeholders in the `Message` parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context used to populate placeholders for the `MessageMcmsKey` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context used to populate placeholders for the `MessageMcmsKey` parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of the error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The legacy suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '278'], + 'Data' => [ + 'title' => '', + 'description' => 'The presigned URL and related details for Object Storage Service (OSS).', + 'type' => 'object', + 'properties' => [ + 'OssUrl' => ['description' => 'The presigned URL for uploading content to OSS.', 'type' => 'string', 'title' => '', 'example' => 'https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************'], + 'OssKey' => ['title' => 'ossKey', 'description' => 'The object key to pass in subsequent API calls.', 'type' => 'string', 'example' => 'open_api_create_project/oacp_4xd****'], + 'ExpectedExpirationTime' => ['description' => 'The expected expiration time of the `OssUrl`, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-07-26T06:33:11.175'."\n"], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"Cost\\": \\"278\\",\\n \\"Data\\": {\\n \\"OssUrl\\": \\"https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************\\",\\n \\"OssKey\\": \\"open_api_create_project/oacp_4xd****\\",\\n \\"ExpectedExpirationTime\\": \\"2023-07-26T06:33:11.175\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain an OSS upload URL', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:GetUploadOssUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'KillProcessList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => ['description' => 'The list of the sessions that need to be closed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '['."\n" + .' {'."\n" + .' "ServerIp": "192.***.**.***",'."\n" + .' "SessionId": "322161****"'."\n" + .' }'."\n" + .']', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned from the request.', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the session.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1123', 'title' => ''], + 'ServerIp' => ['description' => 'The IP address of the server.', 'type' => 'string', 'example' => '127.*.*.*', 'title' => ''], + 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'SLEEP', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance not found.', 'title' => ''], + 'ClientIp' => ['description' => 'The client IP address.', 'type' => 'string', 'example' => '127.*.*.*', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't3ogq******n4', 'title' => ''], + 'User' => ['description' => 'The database username.', 'type' => 'string', 'example' => 'oas', 'title' => ''], + 'Database' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SqlText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => ':', 'title' => ''], + 'Command' => ['description' => 'The start command for the container of the application.', 'type' => 'string', 'example' => 'select 1', 'title' => ''], + 'ExecuteTime' => ['description' => 'Execution time (UTC+8). If it is left empty, it means to execute immediately.', 'type' => 'string', 'example' => '142', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": 1123,\\n \\"ServerIp\\": \\"127.*.*.*\\",\\n \\"Status\\": \\"SLEEP\\",\\n \\"ErrorMessage\\": \\"Instance not found.\\",\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"TenantId\\": \\"t3ogq******n4\\",\\n \\"User\\": \\"oas\\",\\n \\"Database\\": \\"test\\",\\n \\"SqlText\\": \\":\\",\\n \\"Command\\": \\"select 1\\",\\n \\"ExecuteTime\\": \\"142\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'KillProcessList', + 'summary' => 'You can call this operation to close a session.', + 'description' => '为优化用户体验，云数据库对会话功能进行了升级，本接口将下线并由新的接口替代，详情请参见 [【通知】云数据库会话管理 API 接口变更说明'."\n" + .'](https://help.aliyun.com/document_detail/2788792.html?spm=a2c4g.292641.0.0.391b4719nop80f)。'."\n" + .'为优化用户体验，云数据库对会话功能进行了升级，本接口将下线并由新的接口替代，详情请参见 [【通知】云数据库会话管理 API 接口变更说明'."\n" + .'](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notification-cloud-database-session-management-api-interface-downline)。', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ListAllLabels' => [ + 'summary' => 'This API lists your tags.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Provides values for placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Provides values for placeholders in the `Message` parameter.', 'type' => 'any', 'example' => 'null ', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The error message key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Provides values for placeholders in the message template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Provides values for placeholders in the message template identified by `MessageMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The error reason key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Provides values for placeholders in the error reason template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Provides values for placeholders in the error reason template identified by `ReasonMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'A new suggestion for resolving the error.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The suggestion key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Provides values for placeholders in the suggestion template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Provides values for placeholders in the suggestion template identified by `ProposalMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details about upstream errors that occurred during the HTTP request.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The legacy suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '29'], + 'Cost' => ['description' => 'The request duration in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The list of returned labels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'The ID of the label.', 'type' => 'string', 'example' => 'l_4w6r0***'], + 'Name' => ['description' => 'The name of the label.', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null \\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"l_4w6r0***\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query label list', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ListDataSource' => [ + 'summary' => 'Retrieves a list of data sources.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => ['description' => 'The name or ID of the data source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sourcename'], + ], + [ + 'name' => 'Types', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of data source types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the data source.', + 'type' => 'string', + 'example' => 'MYSQL_PUBLIC', + 'enum' => [ + 'MYSQL_PUBLIC', 'MYSQL_VPC', 'MYSQL_DG', 'OB_MYSQL_CE_PUBLIC', 'OB_MYSQL', 'OB_ORACLE', 'OB_MYSQL_TENANT', 'OB_ORACLE_TENANT', 'POSTGRESQL_PUBLIC', 'OB_MYSQL_VPC', 'OB_ORACLE_VPC', 'OB_MYSQL_PUBLIC', 'OB_ORACLE_PUBLIC', 'ORACLE_PUBLIC', 'ORACLE_VPC', 'ORACLE_DG', 'RDS_MYSQL', 'POLAR_MYSQL', 'ADB_MYSQL', 'TIDB_PUBLIC', + 'TIDB_VPC', 'KAFKA_ALIYUN', 'KAFKA_VPC', 'KAFKA_PUBLIC', 'ROCKETMQ_PUBLIC', 'ROCKETMQ_ALIYUN', 'ROCKETMQ_VPC', 'DB2_LUW_PUBLIC', 'SYBASE_PUBLIC', 'DATAHUB_PUBLIC', 'DATAHUB_ALIYUN', 'DATAHUB_VPC', 'DBP_OP_ROUTE', 'DMS', 'IDB', 'POLARDB_X_1_ALIYUN', 'POLARDB_X_2_ALIYUN', + ], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SortField', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The field used to sort the data sources. Valid values include gmtCreate (default) and gmtModified.', + 'enumValueTitles' => ['gmtModified' => 'gmtModified', 'gmtCreate' => 'gmtCreate'], + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The sort order for the data sources. Valid values are `asc` (ascending order) and `descend` (descending order).', + 'type' => 'string', + 'default' => 'descend', + 'enum' => ['descend', 'asc'], + 'title' => '', + 'required' => false, + 'example' => 'descend', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return.', 'type' => 'string', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'string', 'maxLength' => 150, 'minLength' => 1, 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The context for populating placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a context key.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The error message key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context for populating placeholders in the `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a context key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a context key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a context key.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggestion (legacy).', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '132'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '28'], + 'Data' => [ + 'title' => '', + 'description' => 'A list of data source details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data source.', 'type' => 'string', 'title' => '', 'example' => 'e_4w****v'], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'title' => '', 'example' => 'RATION***1DBUTF11'], + 'Type' => [ + 'description' => 'The type of the data source.', + 'type' => 'string', + 'enum' => [ + 'MYSQL_PUBLIC', 'MYSQL_VPC', 'MYSQL_DG', 'OB_MYSQL_CE_PUBLIC', 'OB_MYSQL', 'OB_ORACLE', 'OB_MYSQL_TENANT', 'OB_ORACLE_TENANT', 'POSTGRESQL_PUBLIC', 'OB_MYSQL_VPC', 'OB_ORACLE_VPC', 'OB_MYSQL_PUBLIC', 'OB_ORACLE_PUBLIC', 'ORACLE_PUBLIC', 'ORACLE_VPC', 'ORACLE_DG', 'RDS_MYSQL', 'POLAR_MYSQL', 'ADB_MYSQL', 'TIDB_PUBLIC', + 'TIDB_VPC', 'KAFKA_ALIYUN', 'KAFKA_VPC', 'KAFKA_PUBLIC', 'ROCKETMQ_PUBLIC', 'ROCKETMQ_ALIYUN', 'ROCKETMQ_VPC', 'DB2_LUW_PUBLIC', 'SYBASE_PUBLIC', 'DATAHUB_PUBLIC', 'DATAHUB_ALIYUN', 'DATAHUB_VPC', 'DBP_OP_ROUTE', 'DMS', 'IDB', 'POLARDB_X_1_ALIYUN', 'POLARDB_X_2_ALIYUN', ], + 'title' => '', + 'example' => 'MYSQL_PUBLIC', ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => '', + 'Role' => [ + 'description' => 'The data source role. Valid values: `MASTER` and `SLAVE`.', 'type' => 'string', - 'example' => '2023-07-13T06:26:15', + 'enum' => ['MASTER', 'SLAVE'], + 'title' => '', + 'example' => 'MASTER', ], + 'Owner' => ['description' => 'The owner of the data source.', 'type' => 'string', 'title' => '', 'example' => 'admin'], + 'Tenant' => ['description' => 'The name or ID of the database tenant.', 'type' => 'string', 'title' => '', 'example' => 'tenant_name'], + 'Cluster' => ['description' => 'The name or ID of the cluster where the database tenant resides.', 'type' => 'string', 'title' => '', 'example' => 'cluster_name'], + 'Schema' => ['description' => 'The name of the schema.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'title' => '', 'example' => 'vpc_t4***'], + 'Ip' => ['description' => 'The IP address of the database host.', 'type' => 'string', 'title' => '', 'example' => 'xxx.xxx.xxx.1'], + 'Port' => ['description' => 'The port number of the database host.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2883'], + 'UserName' => ['description' => 'The database username.', 'type' => 'string', 'title' => '', 'example' => 'user_name'], + 'Region' => ['description' => 'The data source region.', 'type' => 'string', 'title' => '', 'example' => 'cn-beijing'], + 'Description' => ['description' => 'A description of the data source. The maximum length is 128 characters.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'OracleSid' => ['description' => 'The Oracle SID.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OracleNlsLengthSemantics' => ['description' => 'The `nls_length_semantics` attribute. This parameter applies only to Oracle data sources and Oracle tenants in OceanBase databases.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OperatingSystem' => ['description' => 'The operating system. This parameter is not returned for OceanBase data sources.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + 'Version' => ['description' => 'The version of the database.', 'type' => 'string', 'title' => '', 'example' => '4.1.0'], + 'Timezone' => ['description' => 'The time zone of the database.', 'type' => 'string', 'title' => '', 'example' => '+08:00'], + 'Charset' => ['description' => 'The character set of the database.', 'type' => 'string', 'title' => '', 'example' => 'utf8mb4'], + 'ResourceOwner' => ['description' => 'The resource owner.', 'type' => 'string', 'title' => '', 'example' => '178641****05809'], + 'GmtCreate' => ['description' => 'The time at which the data source was created, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T20:27:28.000+00:00'], + 'GmtModified' => ['description' => 'The time at which the data source was last modified, in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T20:37:28.000+00:00'], + 'PartnerId' => ['description' => 'The ID of the corresponding primary/standby database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ConnExtraAttributes' => ['description' => 'Extra connection attributes. For details, see the Appendix.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 132,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"e_4w****v\\",\\n \\"Name\\": \\"RATION***1DBUTF11\\",\\n \\"Type\\": \\"MYSQL_PUBLIC\\",\\n \\"Role\\": \\"MASTER\\",\\n \\"Owner\\": \\"admin\\",\\n \\"Tenant\\": \\"tenant_name\\",\\n \\"Cluster\\": \\"cluster_name\\",\\n \\"Schema\\": \\"schema_name\\",\\n \\"VpcId\\": \\"vpc_t4***\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883,\\n \\"UserName\\": \\"user_name\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Description\\": \\"test\\",\\n \\"OracleSid\\": \\"null\\",\\n \\"OracleNlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Version\\": \\"4.1.0\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"ResourceOwner\\": \\"178641****05809\\",\\n \\"GmtCreate\\": \\"2023-07-13T20:27:28.000+00:00\\",\\n \\"GmtModified\\": \\"2023-07-13T20:37:28.000+00:00\\",\\n \\"PartnerId\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query data source list', + 'responseParamsDescription' => '## Appendix'."\n" + ."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------------------------ | ---------------------- | ------------------------------------------------------------------------------------------------------ |'."\n" + .'| endpoint | string | Service endpoint. |'."\n" + .'| username | string | Username. Required when the authentication method is PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. |'."\n" + .'| enableSSL | boolean | Enables SSL authentication. If enabled, you must upload a trusted certificate. |'."\n" + .'| enableSASL | boolean | Enables SASL authentication. |'."\n" + .'| saslMechanism | KafkaSaslMechanisnEnum | The SASL authentication mechanism. Valid values are PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS. |'."\n" + .'| disableIdentificationAlgorithm | boolean | Disables hostname verification during SSL authentication. |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ----------------- |'."\n" + .'| endpoint | string | Service endpoint. |'."\n" + .'| project | string | Project name. |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | -------------------------- | ----------------- |'."\n" + .'| endpoint | string | Service endpoint. |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | Endpoint type. |'."\n" + .'| version | CloudRocketMQInst.Version | RocketMQ version. |'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| cluster | string | Cluster name. |'."\n" + .'| tenant | string | Tenant name. |'."\n" + .'| isLogicSource | boolean | Indicates if the data source is logical. |'."\n" + .'| useLogProxy | boolean | Enables the use of LogProxy. |'."\n" + .'| drcUser | string | drc_user configuration. |'."\n" + .'| configUrl | string | The URL to retrieve addresses of underlying OceanBase servers. |'."\n" + .'| logProxyIp | string | The LogProxy service IP address. |'."\n" + .'| logProxyPort | integer | The LogProxy service port. |'."\n" + .'| noUserAuth | boolean | Bypasses user authentication. This is used when Data Transmission Service automatically generates the data source for synchronization with DataWorks, in which case user credentials may not be available. |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------- | ------ | ------------------------------------ |'."\n" + .'| kafkaId | string | ID of the bound Kafka data source. |'."\n" + .'| kafkaTopic | string | Name of the bound Kafka topic. |'."\n" + .'| kafkaName | string | Name of the bound Kafka data source. |', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ListProjectFullVerifyResult' => [ + 'summary' => 'This API queries the full validation results of a data migration task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_4w5abs****'], + ], + [ + 'name' => 'SourceSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A list of source databases.', + 'type' => 'array', + 'items' => ['description' => 'The name of the source database.', 'type' => 'string', 'required' => false, 'example' => 'source_schema', 'title' => ''], + 'required' => false, + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 344000005,\\n \\"SubProjectId\\": \\"np_598qm***\\",\\n \\"MergeRequestId\\": 0,\\n \\"UpdateRequestId\\": 0,\\n \\"Type\\": \\"INCREASE_OBJECT\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Databases\\": [\\n {\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"Name\\": \\"db_name\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Tables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_col\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col1\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ]\\n }\\n ],\\n \\"MigrationObjectsInfo\\": {\\n \\"WildcardMode\\": true,\\n \\"Tables\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"TablesBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ],\\n \\"ViewsBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ]\\n },\\n \\"OmsProjectMappingInfo\\": {\\n \\"SchemaMappings\\": [\\n {\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"mapped_schema\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ColumnMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceTable\\": \\"source_table\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ViewMappings\\": [\\n {\\n \\"SourceSchema\\": \\"schema_name\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ]\\n },\\n \\"TableEtlList\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"null\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'CreateProjectModifyRecords' => [ - 'summary' => '修改传输对象（加减表）(仅支持处于 RUNNING/FAILED/SUSPEND 状态的项目)', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DestSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A list of target databases.', + 'type' => 'array', + 'items' => ['description' => 'The name of the target database.', 'type' => 'string', 'required' => false, 'example' => 'dest_schema', 'title' => ''], + 'required' => false, + 'example' => '', + ], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'title' => '项目 ID', - 'description' => '', + 'description' => 'The status of the data migration task.', 'type' => 'string', - 'required' => true, - 'example' => 'np_fe****', + 'example' => 'FINISHED', + 'enum' => ['RUNNING', 'ERROR', 'FINISHED', 'SUSPEND'], + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'Databases', + 'name' => 'PageNumber', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '150', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '页大小，分页查询时生效。'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '数据库信息（加减表时必填）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '库ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db_id', - ], - 'Name' => [ - 'title' => '数据库名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db_name', - ], - 'MappedName' => [ - 'title' => '数据库映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_db', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details about the error that occurred.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values include `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Provides values for the placeholders in the `Message` field.', 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'title' => '表ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col1', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col2', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - 'ObkvPartitionConfig' => [ - 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', - 'type' => 'object', - 'properties' => [ - 'PartitionType' => [ - 'type' => 'string', - 'enum' => [ - 'KEY', - 'RANGE', - 'NONE', - ], - ], - 'VirtualColumn' => [ - 'type' => 'string', - ], - 'PartitionSize' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1024', - 'minimum' => '1', - ], - ], - ], - ], - 'required' => false, + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `MessageMcmsKey`.', 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_name', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_id', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col1', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col2', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The recommended action (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the recommended action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The detailed error information from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The recommended action (legacy).', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The full verification results for the data migration project.', + 'type' => 'object', + 'properties' => [ + 'DifferentNumber' => ['description' => 'The total number of rows with mismatched data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11'], + 'FullVerifyTableStatistics' => [ + 'title' => '', + 'description' => 'A list of full verification results for each table.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceTableName' => ['description' => 'The name of the source table.', 'type' => 'string', 'title' => '', 'example' => 'source_table'], + 'SourceSchemaName' => ['description' => 'The name of the source database schema.', 'type' => 'string', 'title' => '', 'example' => 'source_db'], + 'DestSchemaName' => ['description' => 'The name of the destination database schema.', 'type' => 'string', 'title' => '', 'example' => 'dest_db'], + 'SourceOnlyCount' => ['description' => 'The number of rows that exist only in the source.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], + 'DestOnlyCount' => ['description' => 'The number of rows that exist only in the destination.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], + 'MismatchedCount' => ['description' => 'The number of rows with mismatched data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], + 'ConsistentCount' => ['description' => 'The number of rows with consistent data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'Progress' => ['description' => 'The full verification progress, represented as a percentage.', 'type' => 'string', 'title' => '', 'example' => '80'], + 'Message' => ['description' => 'A message that provides details about the full verification status for the table.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Status' => ['description' => 'The full verification status for the table. Valid values include `RUNNING`, `ERROR`, `FINISHED`, and `SUSPEND`.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ResultType' => ['description' => 'The type of the full verification result. Valid values: RUNNING, SCHEMA\\_MISMATCH, INDEX\\_CONFLICT, TARGET\\_TABLE\\_NOT\\_EXIST, RUNTIME\\_EXCEPTION, BOTH\\_EMPTY, CONSISTENT, INCONSISTENT, SOURCE\\_EMPTY, TARGET\\_EMPTY, MISMATCH\\_LIMIT, MISMATCH\\_LIMIT\\_NO\\_PK, and NOT\\_CATEGORIZED.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ResultDesc' => ['description' => 'A description of the full verification result type.', 'type' => 'string', 'title' => '', 'example' => 'desc'], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'A list of error details for the table if the verification failed.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details about a specific error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (new).', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values include `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Provides values for the placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The recommended action (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the recommended action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Provides values for the placeholders in the template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The detailed error information from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'required' => false, ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'example' => '', ], - 'required' => false, ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"DifferentNumber\\": 11,\\n \\"FullVerifyTableStatistics\\": [\\n {\\n \\"SourceTableName\\": \\"source_table\\",\\n \\"SourceSchemaName\\": \\"source_db\\",\\n \\"DestSchemaName\\": \\"dest_db\\",\\n \\"SourceOnlyCount\\": 0,\\n \\"DestOnlyCount\\": 0,\\n \\"MismatchedCount\\": 0,\\n \\"ConsistentCount\\": 200,\\n \\"Progress\\": \\"80\\",\\n \\"Message\\": \\"null\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ResultType\\": \\"RUNNING\\",\\n \\"ResultDesc\\": \\"desc\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Full Verification Results of a Job ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:ListProjectFullVerifyResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListProjectModifyRecords' => [ + 'summary' => 'You can use this operation to query modification records of a data migration or data synchronization task by its ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_598jmu****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The context used to fill placeholders in the Message field.', 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_table', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'table_id', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id<1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col1', - ], - 'required' => false, - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk', - ], - 'required' => false, - ], - 'DistributedKeys' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col2', - ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', - ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, + 'additionalProperties' => ['description' => 'The context used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', - 'description' => '', - 'type' => 'array', - 'items' => [ + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context used to fill placeholders in the MessageMcmsKey field.', 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_name', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mapped_view', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'view_id', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id <1', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col', + 'additionalProperties' => ['description' => 'The context used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter takes effect only for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The time consumed by the request, in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => [ + 'title' => '', + 'description' => 'The information about task modification records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the modification record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '344000005'], + 'SubProjectId' => ['description' => 'The ID of the subtask (generated when adding tables).', 'type' => 'string', 'title' => '', 'example' => 'np_598qm***'], + 'MergeRequestId' => ['description' => 'The ticket ID for merging parent and child tasks, used when adding tables.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'id'], + 'UpdateRequestId' => ['description' => 'The ticket ID for updating the parent task, used when removing tables or updating existing table objects.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'id'], + 'Type' => ['description' => 'The type of the modification record task. Valid values: INCREASE\\_OBJECT (add object) and DECREASE\\_OBJECT (remove object).', 'type' => 'string', 'title' => '', 'example' => 'INCREASE_OBJECT'], + 'Status' => ['description' => 'The status of the modification record. Valid values:'."\n" + ."\n" + .'- PENDING: Pending execution'."\n" + ."\n" + .'- MODIFYING: Modifying (updating the parent task ticket for table removal or creating a subtask for table addition)'."\n" + ."\n" + .'- RUNNING: Running (subtask is running)'."\n" + ."\n" + .'- MERGING: Merging (parent and child tasks meet merge conditions)'."\n" + ."\n" + .'- TERMINATED: Terminated'."\n" + ."\n" + .'- SUCCESS: Successful'."\n" + ."\n" + .'- FAILED: Failed'."\n" + ."\n" + .'- CANCEL: Canceled', 'type' => 'string', 'title' => '', 'example' => 'PENDING'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code (legacy).', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message (legacy).', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The context used to fill placeholders in the Message field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context used to fill placeholders in the Message field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col1', + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context used to fill placeholders in the MessageMcmsKey field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context used to fill placeholders in the MessageMcmsKey field.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion (new).', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggestion.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error details for handling HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'description' => '', + 'example' => '', + ], + 'Databases' => [ + 'title' => '', + 'description' => 'The removed objects (synchronization).', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'PrimaryKeys' => [ - 'description' => '', + 'MappedName' => ['description' => 'The mapped name of the database.', 'type' => 'string', 'title' => '', 'example' => 'mapped_db'], + 'Name' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'Id' => ['description' => 'The ID of the database.', 'type' => 'string', 'title' => '', 'example' => 'db_id'], + 'Tables' => [ + 'title' => '', + 'description' => 'The configuration of table objects to be transferred in the current database.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => ['description' => 'The mapped name of the table or topic.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_id'], + 'WhereClause' => ['description' => 'Configure row filtering using the `WHERE` clause in standard SQL statements.', 'type' => 'string', 'title' => '', 'example' => 'id < 1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The list of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The list of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'example' => '', + ], + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns to be transferred.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'col_name'], + 'MappedName' => ['description' => 'The mapped name of the column.', 'type' => 'string', 'title' => '', 'example' => 'mapped_col'], + 'Position' => ['description' => 'The position of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'FLOAT'], + 'RecordFieldType' => ['description' => 'The extended type of the column. Valid values include INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL\\_MONEY, MONEY, DEC\\_FLOAT, REAL, UCHAR\\_STRING, GRAPHIC\\_STRING, CHAR\\_STRING, NCHAR\\_STRING, VAR\\_GRAPHIC\\_STRING, VAR\\_UCHAR\\_STRING, VAR\\_STRING, VAR\\_CHAR\\_STRING, VAR\\_NCHAR\\_STRING, ROW\\_ID, UROWID, TEXT, NTEXT, UTEXT, TINY\\_TEXT, MEDIUM\\_TEXT, LONG\\_TEXT, BINARY\\_BYTES, VAR\\_BINARY\\_BYTES, RAW, LONG\\_RAW, BIT, VAR\\_BIT, BLOB, TINY\\_BLOB, MEDIUM\\_BLOB, LONG\\_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL\\_DAY\\_TO\\_SECOND, INTERVAL\\_YEAR\\_TO\\_MONTH, INTERVAL\\_DATE\\_TIME, CLOB, NCLOB, XML, JSON, LONG\\_VAR\\_CHAR, LONG\\_VAR\\_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL\\_NEW\\_DATE, TIME, TIME\\_WITH\\_NANOS, TIME\\_WITH\\_TIMEZONE, SMALL\\_DATETIME, DATETIME, DATETIME\\_WITH\\_NONAS, TIMESTAMP\\_IN\\_LONG, TIMESTAMP\\_IN\\_LONG\\_WITH\\_NANOS, TIMESTAMP, TIMESTAMP\\_WITH\\_NANOS, TIMESTAMP\\_WITH\\_TIMEZONE, TIMESTAMP\\_WITH\\_LOCAL\\_TIMEZONE, ZONED\\_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM\\_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED\\_TYPE.', 'type' => 'string', 'title' => '', 'example' => 'INT8'], + 'RawColumnType' => ['description' => 'The raw string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The index type. Valid values: PRI, UNI, and MUL.', 'type' => 'string', 'title' => '', 'example' => 'PRI'], + 'Nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The length of the column.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The precision of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The number of decimal places.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => 'utf8'], + 'ColumnComment' => ['description' => 'The comment of the column.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is hidden.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Type' => ['title' => 'DATABASE, TABLE', 'description' => 'Valid values: DATABASE and TABLE.', 'type' => 'string', 'example' => 'DATABASE'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The list of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The list of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Views' => [ + 'title' => '', + 'description' => 'The configuration list of view objects to be transferred in the current database.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => ['description' => 'The mapped name of the view.', 'type' => 'string', 'title' => '', 'example' => 'mapped_view'], + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_id'], + 'WhereClause' => ['description' => 'Configure row filtering using the `WHERE` clause in standard SQL statements.', 'type' => 'string', 'title' => '', 'example' => 'id<1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The list of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The list of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'example' => '', + ], + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns to be transferred.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'col_name'], + 'MappedName' => ['description' => 'The mapped name of the column.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Position' => ['description' => 'The position of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'FLOAT'], + 'RecordFieldType' => ['description' => 'The extended type of the column.', 'type' => 'string', 'title' => '', 'example' => 'INT8'], + 'RawColumnType' => ['description' => 'The raw string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The index type. Valid values: PRI, UNI, and MUL.', 'type' => 'string', 'title' => '', 'example' => 'PRI'], + 'Nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The length of the column.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The precision of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The number of decimal places.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => 'utf16'], + 'ColumnComment' => ['description' => 'The comment of the column.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is hidden.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Type' => ['title' => 'DATABASE, TABLE', 'description' => 'Valid values: DATABASE and TABLE.', 'type' => 'string', 'example' => 'DATABASE'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The list of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The list of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pk', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'example' => '', ], - 'DistributedKeys' => [ - 'description' => '', + 'SpecificTables' => [ + 'title' => '', + 'description' => 'The configuration set of specific table objects.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => ['description' => 'The mapped name of the table or topic.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_id'], + 'WhereClause' => ['description' => 'Configure row filtering using the `WHERE` clause in standard SQL statements.', 'type' => 'string', 'title' => '', 'example' => 'id<3'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The list of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The list of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'example' => '', + ], + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns to be transferred.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'col_name'], + 'MappedName' => ['description' => 'The mapped name of the column.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Position' => ['description' => 'The position of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'FLOAT'], + 'RecordFieldType' => ['description' => 'The extended type of the column.', 'type' => 'string', 'title' => '', 'example' => 'INT8'], + 'RawColumnType' => ['description' => 'The raw string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The index type. Valid values: PRI, UNI, and MUL.', 'type' => 'string', 'title' => '', 'example' => 'PRI'], + 'Nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The length of the column.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The precision of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The number of decimal places.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => 'utf16'], + 'ColumnComment' => ['description' => 'The comment of the column.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is hidden.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Type' => ['title' => 'DATABASE, TABLE', 'description' => 'Valid values: DATABASE and TABLE.', 'type' => 'string', 'example' => 'DATABASE'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The list of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The list of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'Partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'col2', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'PartitionStatement' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PARTITION BY VALUE(\'id\')', + 'example' => '', ], - 'PartitionLifeCycle' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', + 'SpecificViews' => [ + 'title' => '', + 'description' => 'The configuration list of specific view objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => ['description' => 'The mapped name of the table or topic.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'Id' => ['description' => 'The ID of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_id'], + 'WhereClause' => ['description' => 'Configure row filtering using the `WHERE` clause in standard SQL statements.', 'type' => 'string', 'title' => '', 'example' => 'id < 1'], + 'FilterColumns' => [ + 'title' => '', + 'description' => 'The list of filter columns.', + 'type' => 'array', + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'example' => '', + ], + 'ShardColumns' => [ + 'title' => '', + 'description' => 'The list of sharding key columns.', + 'type' => 'array', + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'example' => '', + ], + 'Columns' => [ + 'title' => '', + 'description' => 'The list of columns to be transferred.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'col_name'], + 'MappedName' => ['description' => 'The mapped name of the column.', 'type' => 'string', 'title' => '', 'example' => 'mapped_name'], + 'Position' => ['description' => 'The position of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'FLOAT'], + 'RecordFieldType' => ['description' => 'The extended type of the column.', 'type' => 'string', 'title' => '', 'example' => 'INT8'], + 'RawColumnType' => ['description' => 'The raw string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The index type. Valid values: PRI, UNI, and MUL.', 'type' => 'string', 'title' => '', 'example' => 'PRI'], + 'Nullable' => ['description' => 'Indicates whether the column can be null.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The length of the column.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The precision of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The number of decimal places.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => 'utf16'], + 'ColumnComment' => ['description' => 'The comment of the column.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is hidden.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Type' => ['title' => 'DATABASE, TABLE', 'description' => 'Valid values: DATABASE and TABLE.', 'type' => 'string', 'example' => 'DATABASE'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'The mapping information of the ADB data source.', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => 'The list of primary key columns.', + 'type' => 'array', + 'items' => ['description' => 'A primary key column.', 'type' => 'string', 'example' => 'pk', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DistributedKeys' => [ + 'description' => 'The list of distribution key columns.', + 'type' => 'array', + 'items' => ['description' => 'A distribution key column.', 'type' => 'string', 'example' => 'col2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PartitionStatement' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'PARTITION BY VALUE(\'id\')', 'title' => ''], + 'PartitionLifeCycle' => ['description' => 'The lifecycle of the table.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'TransferMapping', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '传输对象列表（修改匹配规则时必填）', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则、COMPLEX 混合规则）', - 'type' => 'string', - 'required' => false, - 'example' => 'SPCEIFIC', - 'enum' => [ - 'SPECIFIC', - 'WILDCARD', - 'COMPLEX', - ], - ], - 'Databases' => [ - 'title' => '数据库信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '库ID', - 'type' => 'string', - ], - 'Name' => [ - 'title' => '数据库名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '数据库映射名', - 'type' => 'string', - ], - 'ClusterName' => [ - 'title' => '映射对象集群（已废弃）', - 'type' => 'string', - ], - 'TenantName' => [ - 'title' => '映射对象租户（已废弃）', - 'type' => 'string', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '表ID', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'MigrationObjectsInfo' => [ + 'title' => '', + 'description' => 'The removed objects (migration).', + 'type' => 'object', + 'properties' => [ + 'WildcardMode' => ['description' => 'Indicates whether wildcard mode is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Tables' => [ + 'title' => '', + 'description' => 'The list of tables to be migrated.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'Name' => ['description' => 'The name of the migration object.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'example' => '', + ], + 'TablesBlack' => [ + 'title' => '', + 'description' => 'The blacklist of tables to be migrated.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'Name' => ['description' => 'The name of the object.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', + 'example' => '', + ], + 'Views' => [ + 'title' => '', + 'description' => 'The list of views to be migrated.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], + 'Schema' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'Name' => ['description' => 'The name of the object.', 'type' => 'string', 'title' => '', 'example' => 'view_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ObkvPartitionConfig' => [ - 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'example' => '', + ], + 'ViewsBlack' => [ + 'title' => '', + 'description' => 'The blacklist of views to be migrated.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'PartitionType' => [ - 'type' => 'string', - 'enum' => [ - 'KEY', - 'RANGE', - 'NONE', - ], - ], - 'VirtualColumn' => [ - 'type' => 'string', - ], - 'PartitionSize' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1024', - 'minimum' => '1', - ], + 'Schema' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'Name' => ['description' => 'The name of the object.', 'type' => 'string', 'title' => '', 'example' => 'view_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', + 'OmsProjectMappingInfo' => [ + 'title' => '', + 'description' => 'The matching rules for removed objects (migration).', + 'type' => 'object', + 'properties' => [ + 'SchemaMappings' => [ + 'title' => '', + 'description' => 'The list of schema mapping information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceName' => ['description' => 'The name of the source schema.', 'type' => 'string', 'title' => '', 'example' => 'source_name'], + 'DestName' => ['description' => 'The mapped name of the schema.', 'type' => 'string', 'title' => '', 'example' => 'mapped_schema'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'example' => '', + ], + 'TableMappings' => [ + 'title' => '', + 'description' => 'The list of table mapping information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => ['description' => 'The name of the source schema.', 'type' => 'string', 'title' => '', 'example' => 'source_schema'], + 'SourceName' => ['description' => 'The name of the source object.', 'type' => 'string', 'title' => '', 'example' => 'source_name'], + 'DestName' => ['description' => 'The mapped name of the object.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'example' => '', + ], + 'ColumnMappings' => [ + 'title' => '', + 'description' => 'The list of column mapping information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => ['description' => 'The name of the source schema.', 'type' => 'string', 'title' => '', 'example' => 'source_schema'], + 'SourceTable' => ['description' => 'The name of the source table.', 'type' => 'string', 'title' => '', 'example' => 'source_table'], + 'SourceName' => ['description' => 'The name of the source object.', 'type' => 'string', 'title' => '', 'example' => 'source_name'], + 'DestName' => ['description' => 'The name of the destination object.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', + 'example' => '', + ], + 'ViewMappings' => [ + 'title' => '', + 'description' => 'The list of view mapping information.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], + 'SourceSchema' => ['description' => 'The name of the source schema.', 'type' => 'string', 'title' => '', 'example' => 'schema_name'], + 'SourceName' => ['description' => 'The name of the source object.', 'type' => 'string', 'title' => '', 'example' => 'source_name'], + 'DestName' => ['description' => 'The mapped name of the object.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'TableEtlList' => [ + 'title' => '', + 'description' => 'The ETL information of removed objects (migration).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'title' => '', 'example' => 'tenant_name'], + 'Database' => ['description' => 'The name of the source database.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'DestDatabase' => ['description' => 'The name of the destination database.', 'type' => 'string', 'title' => '', 'example' => 'dest_db'], + 'TableName' => ['description' => 'The name of the source table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'DestName' => ['description' => 'The name of the destination table or topic.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], + 'WhereClause' => ['description' => 'Configure row filtering using the `WHERE` clause in standard SQL statements.', 'type' => 'string', 'title' => '', 'example' => 'id>1'], 'FilterColumns' => [ - 'title' => '过滤列', + 'title' => '', + 'description' => 'The list of filter columns.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'A filter column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'example' => '', ], 'ShardColumns' => [ - 'title' => '分片列', + 'title' => '', + 'description' => 'The list of sharding key columns.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], + 'items' => ['description' => 'A sharding key column.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', ], + 'LogicTableId' => ['description' => 'The ID of the logical table for logical tables.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SourceEndpointId' => ['description' => 'The endpoint ID passed for physical tables.', 'type' => 'string', 'title' => '', 'example' => 'null'], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'GmtModified' => ['description' => 'The time when the task was updated, displayed in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T06:26:15'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 344000005,\\n \\"SubProjectId\\": \\"np_598qm***\\",\\n \\"MergeRequestId\\": 0,\\n \\"UpdateRequestId\\": 0,\\n \\"Type\\": \\"INCREASE_OBJECT\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Databases\\": [\\n {\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"Name\\": \\"db_name\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Tables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_col\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col1\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ]\\n }\\n ],\\n \\"MigrationObjectsInfo\\": {\\n \\"WildcardMode\\": true,\\n \\"Tables\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"TablesBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ],\\n \\"ViewsBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ]\\n },\\n \\"OmsProjectMappingInfo\\": {\\n \\"SchemaMappings\\": [\\n {\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"mapped_schema\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ColumnMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceTable\\": \\"source_table\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ViewMappings\\": [\\n {\\n \\"SourceSchema\\": \\"schema_name\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ]\\n },\\n \\"TableEtlList\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"null\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query modification records of a job ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:ListProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListProjects' => [ + 'summary' => 'This API retrieves a paginated list of data migration or data synchronization tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => ['description' => 'The name or ID of the data migration or data synchronization task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'np_4w****'], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The task type. Valid values are `MIGRATION` for data migration and `SYNC` for data synchronization.'."\n" + .'>The Type parameter is required.>', + 'type' => 'string', + 'example' => 'MIGRATION', + 'enum' => ['MIGRATION', 'SYNC'], + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of task statuses. Valid values include \\`INIT\\`, \\`RUNNING\\`, \\`SUSPEND\\`, \\`FAILED\\`, \\`FINISHED\\`, \\`RELEASING\\`, \\`RELEASED\\`, \\`DELETED\\`, \\`RUNNING\\_MODIFYING\\`, \\`RUNNING\\_MERGING\\`, \\`RUNNING\\_ALARMING\\`, and \\`UNCONFIGURED\\`.', + 'type' => 'array', + 'items' => [ + 'description' => 'The status of the task.', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => ['INIT', 'RUNNING', 'SUSPEND', 'FAILED', 'FINISHED', 'RELEASING', 'RELEASED', 'DELETED', 'RUNNING_MODIFYING', 'RUNNING_MERGING', 'RUNNING_ALARMING', 'UNCONFIGURED'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'enumValueTitles' => [], + 'example' => '', + ], + ], + [ + 'name' => 'LabelIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of label IDs. A maximum of five IDs can be specified.', + 'type' => 'array', + 'items' => ['description' => 'The label ID.', 'type' => 'string', 'required' => false, 'example' => 'l_dfe****'."\n", 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SourceEndpointTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of source data source types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the source data source.', + 'enumValueTitles' => ['POLARDB_X_1' => 'POLARDB\\_X\\_1', 'MYSQL' => 'MySQL', 'TIDB' => 'TiDB', 'OB_ORACLE' => 'OB\\_ORACLE', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'Oracle', 'POLARDB_X_2' => 'POLARDB\\_X\\_2'], + 'type' => 'string', + 'example' => 'MYSQL', + 'enum' => ['MYSQL', 'MARIADB', 'OB_MYSQL', 'OB_MYSQL_CE', 'OB_ORACLE', 'ORACLE', 'DB2_LUW', 'KAFKA', 'ROCKETMQ', 'DATAHUB', 'ADB', 'DBP_OP_ROUTE', 'DMS', 'IDB', 'TIDB', 'POSTGRESQL', 'POLARDB_X_1', 'POLARDB_X_2'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SinkEndpointTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of destination data source types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the destination data source.', + 'enumValueTitles' => ['MYSQL' => 'MySQL', 'OB_ORACLE' => 'OB\\_ORACLE', 'KAFKA' => 'Kafka', 'ROCKETMQ' => 'RocketMQ', 'DATAHUB' => 'DataHub', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'ORACLE', 'ADB' => 'ADB'], + 'type' => 'string', + 'example' => 'MYSQL', + 'enum' => ['MYSQL', 'MARIADB', 'OB_MYSQL', 'OB_MYSQL_CE', 'OB_ORACLE', 'ORACLE', 'DB2_LUW', 'KAFKA', 'ROCKETMQ', 'DATAHUB', 'ADB', 'DBP_OP_ROUTE', 'DMS', 'IDB', 'TIDB', 'POSTGRESQL', 'POLARDB_X_1', 'POLARDB_X_2'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'VisibleSubProject', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to display subtasks.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'SortField', + 'in' => 'formData', + 'schema' => ['description' => 'The field to sort by. Valid values are `gmtCreate` and `gmtModified`. The default value is `gmtCreate`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'gmtCreate'], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The sort order. Valid values are `asc` (ascending) and `descend` (descending). The default value is `descend`.', + 'type' => 'string', + 'default' => 'descend', + 'enum' => ['asc', 'descend'], + 'title' => '', + 'required' => false, + 'example' => 'descend', + ], + ], + [ + 'name' => 'NeedRelatedInfo', + 'in' => 'formData', + 'schema' => ['title' => 'Whether to query associated project information. Default: true (including data source connection information, transmission instance information, and project step information)', 'description' => 'Specifies whether to query related task information, such as data source connections, transfer instances, and task steps. The default value is true.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number for paged queries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page for paged queries.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '150', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill the placeholders in the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill the placeholders in the Message parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill the placeholders in the MessageMcmsKey parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill the placeholders in the MessageMcmsKey parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the cause of the error.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The new suggested solution.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggested solution.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of the upstream error. This parameter is used to handle HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The old error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The old error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The old suggested solution.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is valid only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter is valid only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter is valid only for paged queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'Cost' => ['description' => 'The time it takes to complete the request. Unit: seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The information about the task list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WorkerGradeId' => ['description' => 'The ID of the migration instance.', 'type' => 'string', 'title' => '', 'example' => 'g_i4wa7***'], + 'WorkerGradeInfo' => [ + 'description' => 'The details of the migration instance.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'The ID of the migration instance.', 'type' => 'string', 'example' => 'g_i4wa7***'], + 'Name' => ['title' => 'Alias ', 'description' => 'The alias of the migration instance.', 'type' => 'string', 'example' => 'i5fu***'], + 'Grade' => ['title' => 'Instance Type', 'description' => 'The specifications of the migration instance.', 'type' => 'string', 'example' => 'OMS_G2_MIGRATION_LARGE'], + 'Spec' => ['title' => 'Specification Size', 'description' => 'The size of the migration instance.', 'type' => 'string', 'example' => 'LARGE'], + 'SpecName' => ['title' => 'Specification Name ', 'description' => 'The name of the migration instance size.', 'type' => 'string', 'example' => 'LARGE'], + 'SourceType' => ['title' => 'Source Data Source Type', 'description' => 'The type of the source data source.', 'type' => 'string', 'example' => 'OB_MYSQL'], + 'SourceRegion' => ['title' => 'Source Data Source Region ', 'description' => 'The region where the source data source resides.', 'type' => 'string', 'example' => 'ap-southeast-1'], + 'DestType' => ['title' => 'Target Data Source Type ', 'description' => 'The type of the destination data source.', 'type' => 'string', 'example' => 'OB_MYSQL'], + 'DestRegion' => ['title' => 'Target Data Source Region', 'description' => 'The region where the destination data source resides.', 'type' => 'string', 'example' => 'ap-southeast-1'], + 'ChargeType' => ['title' => 'Billing Type', 'description' => 'The billing method of the data migration or data synchronization task.', 'type' => 'string', 'example' => 'POSTPAY'], + 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the instance has expired.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'EndTime' => ['title' => 'Expiration Time, UTC', 'description' => 'The expiration time. The time is in UTC and the format is YYYY-MM-DDThh:mm:ss.', 'type' => 'string', 'example' => '2024-01-28T15:07:44'], + 'GmtCreate' => ['title' => 'Creation Time, UTC ', 'description' => 'The creation time. The time is in UTC and the format is YYYY-MM-DDThh:mm:ss.', 'type' => 'string', 'example' => '2024-01-28T14:07:44'], ], + 'title' => '', + 'example' => '', ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'Id' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'title' => '', 'example' => 'np_4w****'."\n"], + 'Type' => [ + 'description' => 'The type of the task. Valid values: `MIGRATION` (data migration task) and `SYNC` (data synchronization task).', + 'enumValueTitles' => ['MIGRATION' => 'MIGRATION', 'SYNC' => 'SYNC'], + 'type' => 'string', + 'title' => '', + 'example' => 'MIGRATION', + ], + 'Name' => ['description' => 'The name of the data migration or data synchronization task.', 'type' => 'string', 'title' => '', 'example' => 'project_name'], + 'Labels' => [ + 'title' => '', + 'description' => 'The collection of labels.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], + 'Id' => ['description' => 'The label ID.', 'type' => 'string', 'title' => '', 'example' => 'l_dfe****'."\n"], + 'Name' => ['description' => 'The name of the label.', 'type' => 'string', 'title' => '', 'example' => 'label_name'], + 'Creator' => ['description' => 'The creator. This parameter is returned only for administrators.', 'type' => 'string', 'title' => '', 'example' => 'admin'], + 'Type' => ['description' => 'The type of the label. A value of 1 indicates a user label. A value of 0 indicates an O\\&M label.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Count' => ['description' => 'The number of tasks that use the label.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - ], - ], - ], - 'DatabasesBlack' => [ - 'title' => '匹配规则模式：数据库对象黑名单', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ + 'Owner' => ['description' => 'The owner of the task.', 'type' => 'string', 'title' => '', 'example' => 'admin'], + 'Importance' => [ + 'description' => 'The alert level of the task. Valid values: `HIGH` (high protection status), `MEDIUM` (medium protection status), `LOW` (low protection status), and `IGNORE` (no protection status).', + 'enumValueTitles' => ['HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'IGNORE' => 'IGNORE'], 'type' => 'string', + 'title' => '', + 'example' => 'MEDIUM', ], - 'Name' => [ - 'title' => '库名', + 'Status' => ['description' => 'The status of the data migration or data synchronization task. Valid values: INIT (not started), RUNNING, SUSPEND (paused), FAILED, FINISHED, RELEASING, RELEASED, DELETED, RUNNING\\_MODIFYING (modifying), and RUNNING\\_MERGING (merging).', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'GmtCreate' => ['description' => 'The time when the task was created. The time is displayed in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T06:26:15'], + 'GmtModified' => ['description' => 'The time when the task was updated. The time is displayed in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T07:01:27'], + 'GmtStart' => ['description' => 'The time when the task started.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T07:02:27'], + 'GmtFinish' => ['description' => 'The time when the task ended.', 'type' => 'string', 'title' => '', 'example' => '2023-07-13T08:01:27'], + 'DestConnId' => ['description' => 'The ID of the destination connection.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'IsMerging' => ['description' => 'Indicates whether the task is being merged.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'IsModifying' => ['description' => 'Indicates whether the task is being modified.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'IsSubProject' => ['description' => 'Indicates whether the task is a subtask.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'SourceEndpointType' => [ + 'description' => 'The type of the source data source.', + 'enumValueTitles' => ['POLARDB_X_1' => 'POLARDB\\_X\\_1', 'MYSQL' => 'MYSQL', 'TIDB' => 'TIDB', 'OB_ORACLE' => 'OB\\_ORACLE', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'ORACLE', 'POLARDB_X_2' => 'POLARDB\\_X\\_2'], 'type' => 'string', + 'title' => '', + 'example' => 'MYSQL', ], - 'MappedName' => [ - 'title' => '映射库名', + 'SinkEndpointType' => [ + 'description' => 'The type of the destination data source.', + 'enumValueTitles' => ['MYSQL' => 'MYSQL', 'OB_ORACLE' => 'OB\\_ORACLE', 'KAFKA' => 'KAFKA', 'ROCKETMQ' => 'ROCKETMQ', 'DATAHUB' => 'DATAHUB', 'OB_MYSQL' => 'OB\\_MYSQL', 'ORACLE' => 'ORACLE', 'ADB' => 'ADB'], 'type' => 'string', + 'title' => '', + 'example' => 'OB_MYSQL', ], - 'ClusterName' => [ - 'title' => '映射对象集群（已废弃）', - 'type' => 'string', + 'TransferMapping' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The mapping mode of the transfer object. Valid values: `SPECIFIC` (specified object) and `WILDCARD` (matching rule).', 'type' => 'string', 'title' => '', 'example' => 'SPECIFIC'], + ], + 'example' => '', ], - 'TenantName' => [ - 'title' => '映射对象租户（已废弃）', - 'type' => 'string', + 'CommonTransferConfig' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => ['description' => 'The supported table types. Valid values: ALL (all tables), WITH\\_UNIQUE\\_ROW\\_ID (tables with a unique row identifier), and WITHOUT\\_UNIQUE\\_ROW\\_ID (tables without a unique row identifier). The default value is ALL.', 'type' => 'string', 'title' => '', 'example' => 'ALL'], + 'ActiveActive' => ['description' => 'Indicates whether it is an active-active disaster recovery scenario.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'MqSerializerType' => ['description' => 'The JSON serialization type of data when it is delivered to a message queue. Valid values: DEFAULT, CANAL, DATAWORKS\\_V2, SHAREPLEX, DEFAULT\\_WITH\\_SCHEMA, DEBEZIUM, DEBEZIUMFLATTEN, and DEBEZIUMSMT.', 'type' => 'string', 'title' => '', 'example' => 'DEFAULT'], + 'MqPartitionMode' => ['description' => 'The partition routing method when delivering data to a message queue. Valid values: ONE (deliver to a specified partition), HASH (deliver to a partition based on the HASH value of the primary key or sharding column), and TABLE (deliver to a partition based on the HASH value of the database and table names).', 'type' => 'string', 'title' => '', 'example' => 'ONE'], + 'MqPartition' => ['description' => 'When MqPartitionMode is set to ONE, this parameter specifies the position of the partition to which data is delivered in the current topic.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'DatahubTopicType' => [ + 'description' => 'The type of the topic when data is delivered to DataHub.', + 'enumValueTitles' => ['BLOB' => 'BLOB', 'TUPLE' => 'TUPLE'], + 'type' => 'string', + 'title' => '', + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => ['description' => 'The name of the producer group. This parameter is valid only when the destination is a RocketMQ instance. The default value is OMS.', 'type' => 'string', 'title' => '', 'example' => 'OMS'], + 'RocketMqMsgTags' => ['description' => 'The message tag. This parameter is valid only when the destination is a RocketMQ instance. The default mapping is default->default\\_tag.', 'type' => 'string', 'title' => '', 'example' => 'default_tag'], + 'RocketMqEnableMsgTrace' => ['description' => 'Indicates whether to enable message tracing. This parameter is valid only when the destination is a RocketMQ instance.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'RocketMqSendMsgTimeout' => ['description' => 'The message delivery timeout period. This parameter is valid only when the destination is a RocketMQ instance.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataWorksBusinessName' => ['description' => 'The business system identifier. This parameter is optional.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'example' => '', ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '表ID', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], + 'EnableStructTransfer' => ['description' => 'Indicates whether to enable schema migration.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'StructTransferConfig' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'description' => 'The byte/char conversion solution. The default value is `DO_NOTHING_IF_BYTE_USED`.', + 'enumValueTitles' => ['IGNORE_BYTE_IF_BYTE_USED' => 'IGNORE\\_BYTE\\_IF\\_BYTE\\_USED', 'FORCE_CHAR_IF_BYTE_USED' => 'FORCE\\_CHAR\\_IF\\_BYTE\\_USED', 'DO_NOTHING_IF_BYTE_USED' => 'DO\\_NOTHING\\_IF\\_BYTE\\_USED', 'EXPAND_LEN_IF_BYTE_USED' => 'EXPAND\\_LEN\\_IF\\_BYTE\\_USED'], + 'type' => 'string', + 'title' => '', + 'example' => 'DO_NOTHING_IF_BYTE_USED', ], + 'DeferIndexCreation' => ['description' => 'Indicates whether to allow deferred index creation.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], + 'example' => '', ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '视图ID', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', + 'EnableFullTransfer' => ['description' => 'Indicates whether to enable full migration.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableFullVerify' => ['description' => 'Indicates whether to enable full verification.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'FullTransferConfig' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => ['description' => 'Indicates whether to empty the destination table when performing a full migration of a source table that has no unique index.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'AllowDestTableNotEmpty' => ['description' => 'The policy for handling records that exist in the destination table object. Valid values: **Ignore** and **Stop Migration**.'."\n" + ."\n" + .'- If you set this parameter to true, which means Ignore: When data exists in the destination table object, if the original data conflicts with the data to be written, Data Transmission Service logs the conflicting data and keeps the original data unchanged.'."\n" + ."\n\n" + .' >'."\n" + ."\n" + .' If you select Ignore, full verification pulls data in IN mode. In this case, scenarios with multiple data entries in the destination cannot be verified, and verification performance is degraded.'."\n" + ."\n" + .' >'."\n" + .'- If you set this parameter to false, which means Stop Migration: When data exists in the destination table object, an error is reported and the full migration is not allowed. You must handle the data in the destination table before you continue the migration.'."\n" + ."\n\n" + .' >'."\n" + ."\n" + .' If you click Resume after an error occurs, Data Transmission Service ignores this configuration and continues to migrate the table data. Proceed with caution.'."\n" + ."\n" + .' >', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'FullTransferSpeedMode' => ['description' => 'The concurrency level for full migration. Valid values: STEADY, NORMAL, and FAST.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], + 'FullVerifySpeedMode' => ['description' => 'The concurrency level for full verification. Valid values: STEADY, NORMAL, and FAST.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], + ], + 'example' => '', + ], + 'EnableIncrTransfer' => ['description' => 'Indicates whether to enable incremental transfer.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableIncrVerify' => ['description' => 'Indicates whether to enable incremental verification.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EnableReverseIncrTransfer' => ['description' => 'Indicates whether to enable reverse incremental transfer.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IncrTransferConfig' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => ['description' => 'The start offset for incremental synchronization, which is a UNIX timestamp in seconds. You can set this parameter only when you enable incremental synchronization but not full migration.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1681004708'], + 'RecordTypeWhiteList' => [ + 'title' => '', + 'description' => 'The types of incremental data to be synchronized during the incremental synchronization phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'The types of incremental data to be synchronized during the incremental synchronization phase.', + 'enumValueTitles' => ['DELETE' => 'DELETE', 'COMMIT' => 'COMMIT', 'INSERT' => 'INSERT', 'UPDATE' => 'UPDATE', 'BEGIN' => 'BEGIN', 'ROW' => 'ROW', 'HEARTBEAT' => 'HEARTBEAT', 'DDL' => 'DDL', 'ROLLBACK' => 'ROLLBACK'], 'type' => 'string', + 'example' => 'INSERT', + 'title' => '', ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], + 'example' => '', ], + 'StoreLogKeptHour' => ['description' => 'The log retention period when the incremental synchronization phase is enabled and the incremental log pulling component is Store. Unit: hours. The default value is 7 days. The maximum value is 365 days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '24'], + 'EnableSequencingWithinTxn' => ['description' => 'Indicates whether to enable sequence orchestration within transactions when the incremental synchronization phase is enabled and the incremental log pulling component is Store.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IncrSyncConcurrency' => ['description' => 'The number of threads for incremental synchronization. The default value is 64.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'EnableIncrSyncStatistics' => ['description' => 'Indicates whether to enable statistics collection for incremental records (DML and DDL).', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'SourceConnectInfo' => [ + 'title' => '', + 'description' => 'The connection information of the source node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The connection ID.', 'type' => 'string', 'title' => '', 'example' => 'c_4w3aq****'], + 'EndpointName' => ['description' => 'The name of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'ration12****0obmysql4116892***'], + 'EndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'title' => '', 'example' => 'e_4w3al***'], + 'EndpointSide' => ['description' => 'The type of the endpoint. Valid values: `source` and `dest`.', 'type' => 'string', 'title' => '', 'example' => 'source'], + 'DbEngine' => ['description' => 'The database engine of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'OB_MYSQL_PUBLIC'], + 'ConnectionInfo' => ['description' => 'The connection information of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Username' => ['description' => 'The username for the connection.', 'type' => 'string', 'title' => '', 'example' => 'oms931mys**'], + 'Version' => ['description' => 'The version of the database.', 'type' => 'string', 'title' => '', 'example' => '5.7.27'], + 'Timezone' => ['description' => 'The time zone of the database.', 'type' => 'string', 'title' => '', 'example' => 'UTC'], + 'Charset' => ['description' => 'The character encoding.', 'type' => 'string', 'title' => '', 'example' => 'utf8mb4'], + 'NlsLengthSemantics' => ['description' => 'The nlsLengthSemantics property. This parameter is valid only for Oracle data sources and OceanBase Database Oracle tenants.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OperatingSystem' => ['description' => 'The operating system. This parameter is not applicable to OceanBase Database.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'OcpName' => ['description' => 'The name of the OCP.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ConnExtraAttributes' => ['description' => 'The extended connection properties. For more information about the returned fields, see the "Appendix" section.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'Owner' => ['title' => 'owner', 'description' => 'The owner.', 'type' => 'string', 'example' => 'admin'], + 'ResourceOwner' => ['description' => 'The UID of the resource owner.', 'type' => 'string', 'title' => '', 'example' => '1325847***'], + 'Host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1'."\n", 'title' => ''], + 'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '2883', 'title' => ''], + ], + 'example' => '', + ], + 'SinkConnectInfo' => [ + 'title' => '', + 'description' => 'The connection information of the destination node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The connection ID.', 'type' => 'string', 'title' => '', 'example' => 'c_4w3akx***'], + 'EndpointName' => ['description' => 'The name of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'ation129***9apimysql5616****'], + 'EndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'title' => '', 'example' => 'e_4w3aic***'], + 'EndpointSide' => ['description' => 'The type of the endpoint. Valid values: `source` and `dest`.', 'type' => 'string', 'title' => '', 'example' => 'sink'], + 'DbEngine' => ['description' => 'The database engine of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'MYSQL_PUBLIC'], + 'ConnectionInfo' => ['description' => 'The connection information of the endpoint.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Username' => ['description' => 'The username for the connection.', 'type' => 'string', 'title' => '', 'example' => 'oms**obmys**'], + 'Version' => ['description' => 'The version of the database.', 'type' => 'string', 'title' => '', 'example' => '2.2.77'], + 'Timezone' => ['description' => 'The time zone of the database.', 'type' => 'string', 'title' => '', 'example' => '+08:00'], + 'Charset' => ['description' => 'The character encoding.', 'type' => 'string', 'title' => '', 'example' => 'utf8mb4'], + 'NlsLengthSemantics' => ['description' => 'The nlsLengthSemantics property. This parameter is valid only for Oracle data sources and OceanBase Database Oracle tenants.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OperatingSystem' => ['description' => 'The operating system. This parameter is not applicable to OceanBase Database.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'OcpName' => ['description' => 'The OCP name.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ConnExtraAttributes' => ['description' => 'The extended connection properties. For more information about the returned fields, see the "Appendix" section.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'Owner' => ['title' => 'owner', 'description' => 'The owner.', 'type' => 'string', 'example' => 'admin'], + 'ResourceOwner' => ['description' => 'The UID of the resource owner.', 'type' => 'string', 'title' => '', 'example' => '1325847***'], + 'Host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => 'xxx.xxx.xxx.1', 'title' => ''], + 'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '2883', 'title' => ''], + ], + 'example' => '', + ], + 'Steps' => [ + 'title' => '', + 'description' => 'The list of steps.', 'type' => 'array', 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '表ID', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ + 'type' => 'object', + 'properties' => [ + 'Order' => ['description' => 'The execution order of the step.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Name' => ['description' => 'The name of the step.', 'type' => 'string', 'title' => '', 'example' => 'TRANSFER_PRECHECK'], + 'Description' => ['description' => 'The description of the step. Examples: Precheck, Schema Migration, Schema Synchronization, Full Migration, Full Synchronization, Full Verification, Index Migration, Incremental Log Pulling, Incremental Synchronization, Incremental Verification, and Forward Switch.', 'type' => 'string', 'title' => '', 'example' => '预检查'], + 'Status' => ['description' => 'The status of the step. Valid values: INIT, RUNNING, FAILED, FINISHED, SUSPEND, and MONITORING (the continuous monitoring state for incremental synchronization and incremental verification).', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'The supplementary information in the JSON format.', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'The error details.', 'type' => 'array', 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to fill the placeholders in the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill the placeholders in the Message parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to fill the placeholders in the MessageMcmsKey parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to fill the placeholders in the MessageMcmsKey parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context of the cause of the error.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The new suggested solution.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context of the suggested solution.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context of the suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of the upstream error. This parameter is used to handle HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'INNER_ERROR'], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'ErrorParam' => [ + 'title' => '', + 'description' => 'The parameters related to the error.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The parameters related to the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', ], + 'FailedTime' => ['description' => 'The time when the error occurred.', 'type' => 'string', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], + 'StartTime' => ['description' => 'The start time. The time is displayed in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:04:18'], + 'FinishTime' => ['description' => 'The end time. The time is displayed in UTC+0.', 'type' => 'string', 'title' => '', 'example' => '2020-05-22T17:05:18'], + 'Progress' => ['description' => 'The progress of the step.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'StepInfo' => ['description' => 'The running details of each step.', 'type' => 'object', 'title' => '', 'example' => 'null'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '视图ID', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'This parameter is deprecated. We recommend that you call the `DescribeProject` operation.', + 'type' => 'object', + 'properties' => [ + 'RunningStep' => ['description' => 'The step that is in the RUNNING state.', 'type' => 'string', 'title' => '', 'example' => 'TRANSFER_PRECHECK'], + 'RunningProgress' => ['description' => 'The progress of the step that is in the RUNNING state.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], + 'MonitoringIncr' => ['description' => 'Indicates whether to start monitoring incremental data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Subtopics' => [ + 'title' => '', + 'description' => 'The list of subtopics in the Store associated with the task.', + 'type' => 'array', + 'items' => ['description' => 'A subtopic in the Store associated with the task.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'ReverseSubtopics' => [ + 'title' => '', + 'description' => 'The list of subtopics in the reverse Store associated with the task.', + 'type' => 'array', + 'items' => ['description' => 'A subtopic in the reverse Store associated with the task.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + 'LogServiceStartCheckpoint' => ['description' => 'The start offset.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689214358'], + 'SourceStoreKeptHour' => ['description' => 'The log retention period.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '24'], + 'SyncDelay' => ['description' => 'The incremental synchronization latency.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'SyncDelaySampleTimestamp' => ['description' => 'The timestamp when the synchronization latency was collected, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689214358'], + 'AccessObSource' => ['description' => 'Indicates whether the source OceanBase database can be directly connected.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'OverwriteConfig' => ['description' => 'Indicates whether to allow a full overwrite of the updated configuration.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IgnoreUnsupportDdl' => ['description' => 'Indicates whether to ignore unsupported DDL statements.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'SubDbs' => [ + 'title' => '', + 'description' => 'The table configurations for different downstream consumers. This is used for configuration merging when a synchronization task is reused.', + 'type' => 'object', + 'additionalProperties' => [ 'type' => 'array', 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'cluster_name', 'title' => ''], + 'TenantName' => ['description' => 'The name of the tenant.', 'type' => 'string', 'example' => 'tenant_name', 'title' => ''], + 'DatabaseId' => ['description' => 'The database ID. Currently, only logical databases have IDs. It is possible for databases in the same endpoint to have the same name but different IDs. This indicates different ID scenarios.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'MappingDatabaseName' => ['description' => 'The mapped name of the database.', 'type' => 'string', 'title' => '', 'example' => 'mapped_db'], + 'SourceClientId' => ['description' => 'Used to identify the source client that processes the DatabaseName.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Tables' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableId' => ['description' => 'The ID of the logical table.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Database' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'MappingTableName' => ['description' => 'The mapped name of the table.', 'type' => 'string', 'example' => 'mapped_name', 'title' => ''], + 'Instance' => ['description' => 'The ID of the migration instance.', 'type' => 'string', 'title' => '', 'example' => 'g_i4kat***'], + 'Columns' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'column_name'], + 'Position' => ['description' => 'The position of the field.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'ColumnType' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'RecordFieldType' => ['description' => 'The extension of the column type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'RawColumnType' => ['description' => 'The original string of the column type recorded in the database.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ColumnKey' => ['description' => 'The type of the index.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Nullable' => ['description' => 'Indicates whether the column can be empty.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'DataLength' => ['description' => 'The length of the column.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'DataPrecision' => ['description' => 'The precision of the column.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '64'], + 'DataScale' => ['description' => 'The decimal point.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'null'], + 'Encoding' => ['description' => 'The character encoding of the column.', 'type' => 'string', 'title' => '', 'example' => 'utf8'], + 'ColumnComment' => ['description' => 'The comment of the column.', 'type' => 'string', 'title' => '', 'example' => 'comments'], + 'IsGenerateField' => ['description' => 'Indicates whether the column is a hidden column.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of columns to be transferred.', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of tables to be transferred.', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The table configurations for different downstream consumers. This is used for configuration merging when a synchronization task is reused.', + 'title' => '', + 'example' => '', ], - 'ShardColumns' => [ - 'title' => '分片列', + 'example' => '', + ], + 'SubConds' => [ + 'description' => 'In a DataWorks synchronization scenario, this records the table configurations for different downstream consumers, used for configuration merging when a synchronization task is reused.', + 'type' => 'object', + 'additionalProperties' => [ 'type' => 'array', 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'TenantName' => ['description' => 'The name of the source tenant.', 'type' => 'string', 'title' => '', 'example' => 'tenant_name'], + 'Database' => ['description' => 'The name of the source database.', 'type' => 'string', 'title' => '', 'example' => 'db_name'], + 'DestDatabase' => ['description' => 'The name of the destination database.', 'type' => 'string', 'title' => '', 'example' => 'dest_db'], + 'TableName' => ['description' => 'The name of the source table.', 'type' => 'string', 'title' => '', 'example' => 'table_name'], + 'DestName' => ['description' => 'The name of the destination table.', 'type' => 'string', 'title' => '', 'example' => 'dest_name'], + 'WhereClause' => ['description' => 'The `WHERE `clause in a standard SQL statement, used to configure row filtering.', 'type' => 'string', 'title' => '', 'example' => 'id>1'], + 'FilterColumns' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A filtered column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'description' => 'The collection of filtered columns.', + 'example' => '', ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'ShardColumns' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A sharding column.', 'type' => 'string', 'example' => 'col', 'title' => ''], + 'description' => 'The collection of sharding columns.', + 'example' => '', ], + 'LogicTableId' => ['description' => 'The ID of the logical table.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SourceEndpointId' => ['description' => 'The endpointId passed for a physical table.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'SourceClientId' => ['title' => 'connector client id', 'description' => 'The ID of the connector client.', 'type' => 'string', 'example' => 'null'], ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'In a DataWorks synchronization scenario, this records the table configurations for different downstream consumers, used for configuration merging when a synchronization task is reused.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - 'TableAndViewWhiteList' => [ - 'title' => '匹配规则模式：表、视图的通配白名单', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'TableAndViewBlackList' => [ - 'title' => '匹配规则模式：表、视图的通配黑名单', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'WhiteTableRules' => [ - 'title' => '表白名单规则', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaMapping' => [ - 'title' => 'schema 映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', + 'SubIds' => [ + 'title' => '', + 'description' => 'The list of configuration object IDs.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The ID of the configuration object.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'example' => '', ], + 'MaxConnectorCount' => ['description' => 'The maximum number of connectors. A value of -1 indicates no limit.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '-1'], + 'StoreIncr' => ['description' => 'Indicates whether to save incremental data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'IncrSyncTimestamp' => ['description' => 'The current offset for incremental synchronization, which is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1689244596'], ], + 'example' => '', ], - 'ObjectMapping' => [ - 'title' => 'schema 下的对象映射', + 'AlarmStats' => [ + 'title' => '', + 'description' => 'The alert statistics.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', + 'Target' => ['description' => 'The target of the alert.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'Alarming' => ['description' => 'Indicates whether an alert is being triggered.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'RecentlyTriggerCount' => ['description' => 'The total number of recent alert messages.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'RuleToRecentlyTriggerCount' => [ + 'title' => '', + 'description' => 'The number of recent alert messages for each rule.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The number of recent alert messages for each rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'example' => '', ], + 'AlarmContent' => ['description' => 'The content of the most recent alert message.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'OpenMonitor' => ['description' => 'Indicates whether monitoring and alerting is enabled in the public cloud.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\",\\n \\"Name\\": \\"i5fu***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-01-28T15:07:44\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_4w****\\\\n\\",\\n \\"Type\\": \\"MIGRATION\\",\\n \\"Name\\": \\"project_name\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dfe****\\\\n\\",\\n \\"Name\\": \\"label_name\\",\\n \\"Creator\\": \\"admin\\",\\n \\"Type\\": 1,\\n \\"Count\\": 2\\n }\\n ],\\n \\"Owner\\": \\"admin\\",\\n \\"Importance\\": \\"MEDIUM\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T07:01:27\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T08:01:27\\",\\n \\"DestConnId\\": \\"null\\",\\n \\"IsMerging\\": false,\\n \\"IsModifying\\": false,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"MYSQL\\",\\n \\"SinkEndpointType\\": \\"OB_MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\"\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": false,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": false,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": false\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": false,\\n \\"FullTransferSpeedMode\\": \\"NORMAL\\",\\n \\"FullVerifySpeedMode\\": \\"NORMAL\\"\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1681004708,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_4w3aq****\\",\\n \\"EndpointName\\": \\"ration12****0obmysql4116892***\\",\\n \\"EndpointId\\": \\"e_4w3al***\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms931mys**\\",\\n \\"Version\\": \\"5.7.27\\",\\n \\"Timezone\\": \\"UTC\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"c_4w3akx***\\",\\n \\"EndpointName\\": \\"ation129***9apimysql5616****\\",\\n \\"EndpointId\\": \\"e_4w3aic***\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms**obmys**\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"TRANSFER_PRECHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:05:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"TRANSFER_PRECHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": true,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"null\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_name\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"column_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Paged query of job list', + 'responseParamsDescription' => '## Appendix'."\n" + ."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------------------------ | ---------------------- | --------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| username | string | The username. This parameter is required if you select PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512 as the authentication method. |'."\n" + .'| enableSSL | boolean | Specifies whether to enable SSL authentication. If enabled, you must upload a trusted certificate. |'."\n" + .'| enableSASL | boolean | Specifies whether to enable SASL authentication. |'."\n" + .'| saslMechanism | KafkaSaslMechanisnEnum | The encryption method. Valid values: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS. |'."\n" + .'| disableIdentificationAlgorithm | boolean | Specifies whether to enable hostname verification during SSL encryption. |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | --------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| project | string | The task name. |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | -------------------------- | --------------------------------- |'."\n" + .'| endpoint | string | The service endpoint. |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | The type of the service endpoint. |'."\n" + .'| version | CloudRocketMQInst.Version | The RocketMQ version. |'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| cluster | string | The cluster name. |'."\n" + .'| tenant | string | The tenant name. |'."\n" + .'| isLogicSource | boolean | Specifies whether the data source is a logical data source. |'."\n" + .'| useLogProxy | boolean | Specifies whether to use LogProxy. |'."\n" + .'| drcUser | string | The drc_user configuration. |'."\n" + .'| configUrl | string | Used to obtain the real IP address of the underlying OceanBase database server. |'."\n" + .'| logProxyIp | string | The IP address of the LogProxy service. |'."\n" + .'| logProxyPort | integer | The port of the LogProxy service. |'."\n" + .'| noUserAuth | boolean | For DataWorks synchronization APIs, the data source is automatically generated by OMS. If no username and password are provided, you cannot connect to your OceanBase database. |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------- | ------ | ---------------------------------------- |'."\n" + .'| kafkaId | string | The ID of the bound Kafka data source. |'."\n" + .'| kafkaTopic | string | The name of the bound Kafka topic. |'."\n" + .'| kafkaName | string | The name of the bound Kafka data source. |', + 'changeSet' => [ + ['createdAt' => '2024-03-20T02:08:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [], + ], + 'ListWorkerInstances' => [ + 'summary' => 'Returns a list of migration instances.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'Specs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'An array of instance specifications.', + 'type' => 'array', + 'items' => [ + 'description' => 'The specification of the worker instance.', + 'enumValueTitles' => ['oms.g2m.small' => 'oms.g2m.small', 'oms.g2m.medium' => 'oms.g2m.medium', 'oms.g2m.large' => 'oms.g2m.large', 'oms.g2m.xlarge' => 'oms.g2m.xlarge'], + 'type' => 'string', + 'enum' => [], + 'required' => false, + 'example' => 'oms.g2m.small', + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the worker instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'i4katz****'], + ], + [ + 'name' => 'SourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the source. Valid values are `OCEANBASE` for OceanBase, `KAFKA` for Kafka, `ROCKETMQ` for RocketMQ, `POLARDB_X_1` or `POLARDB_X_2` for PolarDB-X, and `TIDB` for TiDB.', + 'type' => 'string', + 'enum' => ['OCEANBASE', 'KAFKA', 'ROCKETMQ', 'POLARDB_X_1', 'TIDB', 'POLARDB_X_2'], + 'title' => '', + 'required' => false, + 'example' => 'OCEANBASE', + ], + ], + [ + 'name' => 'DestType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the destination. Valid values are `OCEANBASE` for OceanBase, `KAFKA` for Kafka, `ROCKETMQ` for RocketMQ, `POLARDB_X_1` or `POLARDB_X_2` for PolarDB-X, and `TIDB` for TiDB.', + 'type' => 'string', + 'enum' => ['OCEANBASE', 'KAFKA', 'ROCKETMQ', 'POLARDB_X_1', 'POLARDB_X_2', 'TIDB'], + 'title' => '', + 'required' => false, + 'example' => 'KAFKA', + ], + ], + [ + 'name' => 'OnlyBindable', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to list only bindable instances. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return per page for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details about the error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'FATAL'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'successful'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Parameters used to populate placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The localization key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Parameters used to populate placeholders in the message template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The localization key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Parameters used to populate placeholders in the reason template identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The recommended action to resolve the error.', 'type' => 'string', 'example' => 'null'."\n", 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The localization key for the recommended action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Parameters used to populate placeholders in the proposal template identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details about an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], - 'WhiteViewRules' => [ - 'title' => '视图白名单规则', + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], + 'Advice' => ['description' => 'The legacy recommended action.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '237'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '71'], + 'Data' => [ + 'title' => '', + 'description' => 'A list of worker instances.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SchemaMapping' => [ - 'title' => 'schema 映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], - ], + 'Id' => ['description' => 'The ID of the worker instance.', 'type' => 'string', 'title' => '', 'example' => 'g_i4katzv***'], + 'Spec' => [ + 'description' => 'The specification of the worker instance.', + 'enumValueTitles' => ['oms.g2m.small' => 'oms.g2m.small', 'oms.g2m.medium' => 'oms.g2m.medium', 'oms.g2m.large' => 'oms.g2m.large', 'oms.g2m.xlarge' => 'oms.g2m.xlarge'], + 'type' => 'string', + 'title' => '', + 'example' => 'oms.g2m.small', ], - 'ObjectMapping' => [ - 'title' => 'schema 下的对象映射', + 'Name' => ['description' => 'The name of the worker instance.', 'type' => 'string', 'title' => '', 'example' => 'i4wa71k****'], + 'Status' => ['description' => 'The status of the worker instance.', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'], + 'Region' => ['description' => 'The region where the worker instance resides.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'ProjectId' => ['description' => 'The ID of the project to which the worker instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'np_4kb18w****'], + 'ProjectName' => ['description' => 'The name of the project to which the worker instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'j_migration_cloud-kafkavpc-ob'], + 'ProjectType' => ['description' => 'The type of the project to which the worker instance belongs.', 'type' => 'string', 'title' => '', 'example' => 'MIGRATION'], + 'GmtCreate' => ['description' => 'The time when the worker instance was created. The time is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-07-14T20:49:53'."\n"], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Level\\": \\"FATAL\\",\\n \\"Message\\": \\"successful\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Advice\\": \\"null\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 237,\\n \\"Cost\\": \\"71\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"g_i4katzv***\\",\\n \\"Spec\\": \\"oms.g2m.small\\",\\n \\"Name\\": \\"i4wa71k****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"Region\\": \\"null\\",\\n \\"ProjectId\\": \\"np_4kb18w****\\",\\n \\"ProjectName\\": \\"j_migration_cloud-kafkavpc-ob\\",\\n \\"ProjectType\\": \\"MIGRATION\\",\\n \\"GmtCreate\\": \\"2023-07-14T20:49:53\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Migration Instance List', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ModifyDatabaseDescription' => [ + 'summary' => 'The return result of the request. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', 'description' => 'The description of the database. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyDatabaseDescription**. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the region. ', 'description' => 'Example 1', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sms_pre'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyDatabaseDescription'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&DatabaseName=sms_pre'."\n" + .'&Description=This is a test database'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Database description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'this is a test database'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'You can call this operation to modify the description of an OceanBase database. ', + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Modify Database Description', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyDatabaseDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyDatabaseUserRoles' => [ + 'summary' => 'Alibaba Cloud CLI', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sms_pre'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The role of the account. '."\n" + .'In MySQL mode, a role is a database-level role. Valid values:'."\n" + .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES.'."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" + .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', 'description' => 'A list of usernames and their respective roles. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****'], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => ['title' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyDatabaseUserRoles**. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"UserName":"oceanbase1","Role":"readwrite"},{"UserName":"oceanbase2","Role":"readonly"}]'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', 'description' => 'The account information. ', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The name of the account. ', + 'description' => 'The ID of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'TenantUser' => [ + 'title' => 'The ID of the region. ', + 'description' => 'The name of the database. ', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => ['title' => 'The request ID. ', 'description' => 'Example 1', 'type' => 'string', 'example' => 'sms_pre'], + 'Users' => [ + 'title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyDatabaseUserRoles'."\n" + .'&DatabaseName=sms_pre'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&Users=[{"UserName":"omstest","Role":"readwrite"}]'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', + 'description' => 'List of accounts granted permissions on the database. ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to modify the privileges of an account on a database. ', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], + 'Role' => ['title' => '', 'description' => 'Role permission assigned to the account for this database. '."\n" + .'For MySQL mode, roles are defined at the database level and include the following types: '."\n" + .'- ReadWrite: read-write permission, including ALL PRIVILEGES; '."\n" + .'- ReadOnly: read-only permission, including SELECT; '."\n" + .'- DDL: DDL permission, including CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW; '."\n" + .'- DML: DML permission, including SELECT, INSERT, UPDATE, DELETE, SHOW VIEW. ', 'type' => 'string', 'example' => 'ReadOnly'], + 'UserName' => ['title' => '', 'description' => 'Account name. ', 'type' => 'string', 'example' => 'user_pay_ro'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'TenantId' => ['title' => '', 'description' => 'Tenant ID. ', 'type' => 'string', 'example' => 't33h8y08k****'], + ], + 'example' => '', + ], + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TenantUser\\": {\\n \\"DatabaseName\\": \\"sms_pre\\",\\n \\"Users\\": [\\n {\\n \\"Role\\": \\"ReadOnly\\",\\n \\"UserName\\": \\"user_pay_ro\\"\\n }\\n ],\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Modify database user roles ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyDatabaseUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyInstanceName' => [ + 'summary' => 'You can call this operation to change the name of an OceanBase cluster. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', 'description' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob4prod'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The return result of the request. ', + 'description' => 'The name of the OceanBase cluster. '."\n" + .'It must be 1 to 20 characters in length. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyInstanceName**. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 9005 => [ + ['errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', 'description' => ''], + ], + [ + ['errorCode' => 'MissingInstanceName', 'errorMessage' => 'InstanceName is mandatory for this action.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ob4test\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'ModifyInstanceName', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}/*'], + ], + ], + ], + ], + ], + 'ModifyInstanceNodeNum' => [ + 'summary' => 'You can call this operation to modify the number of nodes in a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'NodeNum', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.', 'type' => 'string', 'required' => true, 'example' => '6'], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例节点数。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例节点数。', 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the number of nodes in the instance is not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: The actual request is sent and no dry run is performed. The number of nodes is changed if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Data' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['title' => '', 'description' => 'The ID of the order.', 'type' => 'string', 'example' => '21329031xxxxxxxx'], + 'DryRunResult' => ['title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', 'type' => 'boolean', 'example' => 'false'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ['errorCode' => 'InstanceDataSize.Invalid', 'errorMessage' => 'InstanceDataSize.Invalid', 'description' => ''], + ['errorCode' => 'InstanceClassSpecification.Invalid', 'errorMessage' => 'InstanceClassSpecification.Invalid', 'description' => ''], + ['errorCode' => 'InstanceLogSize.Invalid', 'errorMessage' => 'InstanceLogSize.Invalid', 'description' => ''], + ['errorCode' => 'Instance.ExpandLogDisk.Unsupport', 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', 'description' => ''], + ['errorCode' => 'InstanceOrder.NotAvailable', 'errorMessage' => 'InstanceOrder.NotAvailable', 'description' => ''], + ['errorCode' => 'InstanceNodeNum.Invalid', 'errorMessage' => 'InstanceNodeNum.Invalid', 'description' => ''], + ['errorCode' => 'InstanceStatus.Invalid', 'errorMessage' => 'InstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'InstanceName.ModifyFailed', 'errorMessage' => 'InstanceName.ModifyFailed', 'description' => ''], + ['errorCode' => 'InstanceClass.InvalidValue', 'errorMessage' => 'InstanceClass.InvalidValue', 'description' => ''], + ['errorCode' => 'InstanceType.Unsupport', 'errorMessage' => 'InstanceType.Unsupport', 'description' => ''], + ['errorCode' => 'InstanceId.Invalid', 'errorMessage' => 'InstanceId.Invalid', 'description' => ''], + ['errorCode' => 'InstanceId.Missing', 'errorMessage' => 'InstanceId.Missing', 'description' => ''], + ['errorCode' => 'Instance.Name.Missing', 'errorMessage' => 'Instance.Name.Missing', 'description' => ''], + ['errorCode' => 'ListCluster.Fail', 'errorMessage' => 'ListCluster.Fail', 'description' => ''], + ['errorCode' => 'GetCluster.Fail', 'errorMessage' => 'GetCluster.Fail', 'description' => ''], + ['errorCode' => 'ListClusterGroup.Fail', 'errorMessage' => 'ListClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'GetClusterGroup.Fail', 'errorMessage' => 'GetClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'ListInstance.Fail', 'errorMessage' => 'ListInstance.Fail', 'description' => ''], + ['errorCode' => 'GetInstance.Fail', 'errorMessage' => 'GetInstance.Fail', 'description' => ''], + ['errorCode' => 'ListTenant.Fail', 'errorMessage' => 'ListTenant.Fail', 'description' => ''], + ['errorCode' => 'GetTenant.Fail', 'errorMessage' => 'GetTenant.Fail', 'description' => ''], + ['errorCode' => 'Instance.ListAliyunInstance.Fail', 'errorMessage' => 'Instance.ListAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'Instance.GetAliyunInstance.Fail', 'errorMessage' => 'Instance.GetAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'ListZone.Fail', 'errorMessage' => 'ListZone.Fail', 'description' => ''], + ['errorCode' => 'GetObServer.Fail', 'errorMessage' => 'GetObServer.Fail', 'description' => ''], + ['errorCode' => 'CreateInstanceParameters.Error', 'errorMessage' => 'CreateInstanceParameters.Error', 'description' => ''], + ['errorCode' => 'CreateInstance.Fail', 'errorMessage' => 'CreateInstance.Fail', 'description' => ''], + ['errorCode' => 'StandbyInstance.StillOnline', 'errorMessage' => 'StandbyInstance.StillOnline', 'description' => ''], + ['errorCode' => 'InstanceServiceName.Missing', 'errorMessage' => 'InstanceServiceName.Missing', 'description' => ''], + ['errorCode' => 'PrimaryInstanceStatus.Invalid', 'errorMessage' => 'PrimaryInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstanceStatus.Invalid', 'errorMessage' => 'StandbyInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstance.NotSupport', 'errorMessage' => 'StandbyInstance.NotSupport', 'description' => ''], + ['errorCode' => 'StandbyInstance.Disconnect.NotAllowed', 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', 'description' => ''], + ['errorCode' => 'InstanceDiskSize.Invalid', 'errorMessage' => 'InstanceDiskSize.Invalid', 'description' => ''], + ['errorCode' => 'CreateInstance.Spec.NotSupport', 'errorMessage' => 'CreateInstance.Spec.NotSupport', 'description' => ''], + ['errorCode' => 'MissingParameterDiskSize', 'errorMessage' => 'MissingParameterDiskSize', 'description' => ''], + ['errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', 'description' => ''], + ['errorCode' => 'CreateInstance.DeployType.InvalidValue', 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', 'description' => ''], + ['errorCode' => 'AliyunInstance.NotExists', 'errorMessage' => 'AliyunInstance.NotExists', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', + 'title' => 'ModifyInstanceNodeNum', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceNodeNum', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyInstanceSSL' => [ + 'summary' => 'Modifies the SSL configuration of an instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase instance.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The action to perform on the SSL configuration. Valid values:'."\n" + ."\n" + .'- `open`: Enable SSL encryption.'."\n" + ."\n" + .'- `update`: Update the CA certificate.'."\n" + ."\n" + .'- `close`: Disable SSL encryption.', + 'type' => 'string', + 'title' => '', + 'required' => true, + 'example' => 'open', + 'enum' => [], + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'InstanceSSL' => [ + 'title' => 'job', + 'description' => 'The SSL configuration of the OceanBase instance.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the OceanBase instance.', 'type' => 'string', 'example' => 'ob317v4uif****', 'title' => ''], + 'EnableSSL' => ['description' => 'The SSL encryption status. Valid values:'."\n" + ."\n" + .'- `open`: SSL encryption is enabled.'."\n" + ."\n" + .'- `update`: The CA certificate is being updated.'."\n" + ."\n" + .'- `close`: SSL encryption is disabled.', 'type' => 'string', 'example' => 'open', 'title' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], - 'BlackTableRules' => [ - 'title' => '表黑名单规则', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaMapping' => [ - 'title' => 'schema 映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], - ], - ], - 'ObjectMapping' => [ - 'title' => 'schema 下的对象映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], - ], - ], - ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"open\\",\\n \\"TenantId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyInstanceSSL', + 'changeSet' => [ + ['createdAt' => '2025-02-13T13:01:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-06-06T11:29:31.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyInstanceSpec' => [ + 'summary' => 'Modify the cluster specifications and storage space.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The specifications of the cluster. You can specify one of the following four plans:'."\n" + .'- 8C32GB: indicates 8 CPU cores and 32 GB of memory.'."\n" + .'- 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" + .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory.'."\n" + .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', 'type' => 'string', 'required' => false, 'example' => '14C70GB'], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The size of the storage space, in GB. The required storage space varies based on the cluster specifications:'."\n" + .'- 8C32G: 100 GB to 10 TB.'."\n" + .'- 14C70G: 200 GB to 10 TB.'."\n" + .'- 30C180G: 400 GB to 10 TB.'."\n" + .'- 62C400G: 800 GB to 10 TB. The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例配置。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例配置。', 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the instance settings are not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'DiskType', + 'in' => 'formData', + 'schema' => ['title' => '存储类型', 'description' => 'Disk type.', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd_pl1'], + ], + [ + 'name' => 'UpgradeSpecNative', + 'in' => 'formData', + 'schema' => ['description' => 'Whether to perform an in-place upgrade/downgrade.', 'title' => 'Whether to Perform an In-Place Upgrade/Downgrade', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'Data' => [ + 'title' => '', + 'description' => 'The return data of the request.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['title' => '', 'description' => 'The ID of the order that you have placed.', 'type' => 'string', 'example' => '21329031xxxxxxx'], + 'DryRunResult' => ['title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '1234567890', ], - 'BlackViewRules' => [ - 'title' => '视图黑名单规则', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchemaMapping' => [ - 'title' => 'schema 映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], - ], - ], - 'ObjectMapping' => [ - 'title' => 'schema 下的对象映射', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '对象名称', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '映射对象名称', - 'type' => 'string', - ], - ], - ], - ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ['errorCode' => 'InstanceDataSize.Invalid', 'errorMessage' => 'InstanceDataSize.Invalid', 'description' => ''], + ['errorCode' => 'InstanceClassSpecification.Invalid', 'errorMessage' => 'InstanceClassSpecification.Invalid', 'description' => ''], + ['errorCode' => 'InstanceOrder.NotAvailable', 'errorMessage' => 'InstanceOrder.NotAvailable', 'description' => ''], + ['errorCode' => 'InstanceNodeNum.Invalid', 'errorMessage' => 'InstanceNodeNum.Invalid', 'description' => ''], + ['errorCode' => 'InstanceLogSize.Invalid', 'errorMessage' => 'InstanceLogSize.Invalid', 'description' => ''], + ['errorCode' => 'Instance.ExpandLogDisk.Unsupport', 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', 'description' => ''], + ['errorCode' => 'InstanceStatus.Invalid', 'errorMessage' => 'InstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'InstanceName.ModifyFailed', 'errorMessage' => 'InstanceName.ModifyFailed', 'description' => ''], + ['errorCode' => 'InstanceClass.InvalidValue', 'errorMessage' => 'InstanceClass.InvalidValue', 'description' => ''], + ['errorCode' => 'InstanceType.Unsupport', 'errorMessage' => 'InstanceType.Unsupport', 'description' => ''], + ['errorCode' => 'ZoneList.Unsupport', 'errorMessage' => 'ZoneList.Unsupport', 'description' => ''], + ['errorCode' => 'InstanceId.Invalid', 'errorMessage' => 'InstanceId.Invalid', 'description' => ''], + ['errorCode' => 'InstanceId.Missing', 'errorMessage' => 'InstanceId.Missing', 'description' => ''], + ['errorCode' => 'Instance.Name.Missing', 'errorMessage' => 'Instance.Name.Missing', 'description' => ''], + ['errorCode' => 'ListCluster.Fail', 'errorMessage' => 'ListCluster.Fail', 'description' => ''], + ['errorCode' => 'GetCluster.Fail', 'errorMessage' => 'GetCluster.Fail', 'description' => ''], + ['errorCode' => 'ListClusterGroup.Fail', 'errorMessage' => 'ListClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'GetClusterGroup.Fail', 'errorMessage' => 'GetClusterGroup.Fail', 'description' => ''], + ['errorCode' => 'ListInstance.Fail', 'errorMessage' => 'ListInstance.Fail', 'description' => ''], + ['errorCode' => 'GetInstance.Fail', 'errorMessage' => 'GetInstance.Fail', 'description' => ''], + ['errorCode' => 'ListTenant.Fail', 'errorMessage' => 'ListTenant.Fail', 'description' => ''], + ['errorCode' => 'GetTenant.Fail', 'errorMessage' => 'GetTenant.Fail', 'description' => ''], + ['errorCode' => 'Instance.ListAliyunInstance.Fail', 'errorMessage' => 'Instance.ListAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'Instance.GetAliyunInstance.Fail', 'errorMessage' => 'Instance.GetAliyunInstance.Fail', 'description' => ''], + ['errorCode' => 'ListZone.Fail', 'errorMessage' => 'ListZone.Fail', 'description' => ''], + ['errorCode' => 'GetObServer.Fail', 'errorMessage' => 'GetObServer.Fail', 'description' => ''], + ['errorCode' => 'CreateInstanceParameters.Error', 'errorMessage' => 'CreateInstanceParameters.Error', 'description' => ''], + ['errorCode' => 'CreateInstance.Fail', 'errorMessage' => 'CreateInstance.Fail', 'description' => ''], + ['errorCode' => 'StandbyInstance.StillOnline', 'errorMessage' => 'StandbyInstance.StillOnline', 'description' => ''], + ['errorCode' => 'InstanceServiceName.Missing', 'errorMessage' => 'InstanceServiceName.Missing', 'description' => ''], + ['errorCode' => 'PrimaryInstanceStatus.Invalid', 'errorMessage' => 'PrimaryInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstanceStatus.Invalid', 'errorMessage' => 'StandbyInstanceStatus.Invalid', 'description' => ''], + ['errorCode' => 'StandbyInstance.NotSupport', 'errorMessage' => 'StandbyInstance.NotSupport', 'description' => ''], + ['errorCode' => 'StandbyInstance.Disconnect.NotAllowed', 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', 'description' => ''], + ['errorCode' => 'InstanceDiskSize.Invalid', 'errorMessage' => 'InstanceDiskSize.Invalid', 'description' => ''], + ['errorCode' => 'CreateInstance.Spec.NotSupport', 'errorMessage' => 'CreateInstance.Spec.NotSupport', 'description' => ''], + ['errorCode' => 'MissingParameterDiskSize', 'errorMessage' => 'MissingParameterDiskSize', 'description' => ''], + ['errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', 'description' => ''], + ['errorCode' => 'CreateInstance.DeployType.InvalidValue', 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', 'description' => ''], + ['errorCode' => 'AliyunInstance.NotExists', 'errorMessage' => 'AliyunInstance.NotExists', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Instance.Order.CreateFailed', 'errorMessage' => 'Instance.Order.CreateFailed', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Modify Cluster Specifications and Storage Space', + 'changeSet' => [ + ['createdAt' => '2024-06-06T11:29:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-26T12:16:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-07T09:36:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-30T13:50:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-07-04T02:52:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-05-09T03:02:12.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-20T08:15:02.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyInstanceTags' => [ + 'summary' => 'You can call this operation to modify the tags of a cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tags.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Key": "xxx", "Value": "xxx"},{}]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Message' => ['title' => '', 'description' => 'The tag modification result.', 'type' => 'string', 'example' => 'add resource tag relation success'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"add resource tag relation success\\"\\n}","type":"json"}]', + 'title' => 'ModifyInstanceTags', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyInstanceTemporaryCapacity' => [ + 'summary' => 'Modify the temporary capacity of an OceanBase cluster.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specification.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oceanbase.cluster.i2.small'], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The disk size. Unit: GB.', 'type' => 'string', 'required' => false, 'example' => '400'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'Supported language. Valid values:'."\n" + .'- Chinese: zh-CN'."\n" + .'- English: en-US', 'type' => 'string', 'example' => 'zh-CN', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Modify cluster temporary capacity', + 'changeSet' => [ + ['createdAt' => '2023-12-26T12:16:21.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [], + ], + 'ModifyParameters' => [ + 'summary' => 'Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification. ', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', 'description' => 'Alibaba Cloud CLI', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => ['title' => 'Indicates whether the parameter has been modified. Valid values: '."\n" + .'true: The modification is successful. '."\n" + .'false: The modification failed. ', 'description' => 'The cause of the modification failure. ', 'type' => 'string', 'required' => false, 'example' => 't4qx8****'], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => ['title' => 'The modification results. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TENANT'], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The resource ID of the parameter type. '."\n" + .'You can leave this parameter unspecified when you call this operation to modify cluster parameters. In the case of tenant parameters, pass the tenant ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Name":"connect_timeout","Value":"20"}]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The type of the parameter. '."\n" + .'Valid values: CLUSTER and TENANT. ', + 'description' => 'The parameters. '."\n" + .'It is a JSON array. Each object in the array has two elements: Name and Value. '."\n" + ."\n" + .'>
The names and values of cluster parameters that can be modified are different from those of tenant parameters. For more information, see DescribeParameters. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyParameters**. ', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Results' => [ + 'title' => 'The ID of the region. ', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyParameters'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&DimensionValue=ob2mr3oae0****'."\n" + .'&Dimension=TENANT'."\n" + .'&Parameters=[{"Name":"connect_timeout","Value":"20"}]'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'Indicates whether the modification succeeded. '."\n" + .'- true: The modification succeeded. '."\n" + .'- false: The modification failed.', 'type' => 'boolean', 'example' => 'false'], + 'Message' => ['title' => 'You can call this operation to modify the parameters of a cluster or tenant. ', 'description' => 'The message indicating why the modification failed.', 'type' => 'string', 'example' => 'schedule timeout.'], ], + 'example' => '', ], - 'Schemas' => [ - 'title' => '精确库表对象设置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '库ID', - 'type' => 'string', - ], - 'Name' => [ - 'title' => '数据库名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '数据库映射名', - 'type' => 'string', - ], - 'ClusterName' => [ - 'title' => '映射对象集群（已废弃）', - 'type' => 'string', - ], - 'TenantName' => [ - 'title' => '映射对象租户（已废弃）', - 'type' => 'string', - ], - 'Tables' => [ - 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'title' => '表ID', - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], - 'ObkvPartitionConfig' => [ - 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', - 'type' => 'object', - 'properties' => [ - 'PartitionType' => [ - 'type' => 'string', - 'enum' => [ - 'KEY', - 'RANGE', - 'NONE', - ], - ], - 'VirtualColumn' => [ - 'type' => 'string', - ], - 'PartitionSize' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1024', - 'minimum' => '1', - ], - ], - ], - ], - ], - ], - 'Views' => [ - 'title' => '当前库下的传输视图对象配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'SpecificTables' => [ - 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '表映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'SpecificViews' => [ - 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视图名', - 'type' => 'string', - ], - 'MappedName' => [ - 'title' => '视图映射名', - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'WhereClause' => [ - 'title' => '行过滤，ETL语法', - 'type' => 'string', - ], - 'FilterColumns' => [ - 'title' => '过滤列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ShardColumns' => [ - 'title' => '分片列', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AdbTableSchema' => [ - 'title' => 'ADB 数据源的映射信息', - 'type' => 'object', - 'properties' => [ - 'PrimaryKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DistributedKeys' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PartitionStatement' => [ - 'type' => 'string', - ], - 'PartitionLifeCycle' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Results\\": {\\n \\"Success\\": false,\\n \\"Message\\": \\"schedule timeout.\\"\\n }\\n}","type":"json"}]', + 'title' => 'Modify Parameters', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifySecurityIps' => [ + 'summary' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" + .'It is a JSON array. Each object in the array is an IP address or CIDR block. You can specify at most 40 IP addresses or CIDR blocks. ', 'type' => 'string', 'required' => false, 'example' => '["192.168.0.0/20", "192.169.1.1"]'], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the region. ', 'description' => 'The information of the IP address whitelist group. ', 'type' => 'string', 'required' => false, 'example' => 'paytest'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The name of the IP address whitelist group. '."\n" + .'It must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters, digits, and underscores (_). ', + 'description' => 'The name of the security group. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" + .'The return values of SecurityIps are strings that are separated with commas (,). ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifySecurityIps**. ', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifySecurityIps'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&SecurityIps=["192.168.0.0/20","192.169.1.1"]'."\n" + .'&SecurityIpGroupName=paytest'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'SecurityIpGroupName' => ['title' => 'You can call this operation to modify the IP address list in a group. ', 'description' => 'Security group name.', 'type' => 'string', 'example' => 'online_paycore'], + 'SecurityIps' => ['title' => '', 'description' => 'IP address whitelist list. '."\n" + ."\n" + .'It is a JSON-formatted array.', 'type' => 'string', 'example' => '["192.***.1.2","192.***.1.1"]'], ], + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"online_paycore\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.2\\\\\\",\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'Modify IP List', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifySecurityIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTagName' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], + ], + [ + 'name' => 'NewKey', + 'in' => 'formData', + 'schema' => ['description' => 'The new name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 2', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', + 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', + 'Message' => ['description' => 'The tag group renaming result.', 'type' => 'string', 'example' => 'update tag name success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'Modify Tag Group Name ', + 'summary' => 'This API is used to modify the name of a tag group. ', + 'changeSet' => [ + ['createdAt' => '2024-06-06T11:29:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTagName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTagValueName' => [ + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签 1', 'title' => ''], + ], + [ + 'name' => 'NewValue', + 'in' => 'formData', + 'schema' => ['description' => 'The new name of the tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签 2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The tag renaming result.', 'type' => 'string', 'example' => 'update tag-value name success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag-value name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'ModifyTagValueName', + 'summary' => 'You can call this operation to rename a tag.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTagValueName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTenantEncryption' => [ + 'summary' => 'You can call this operation to enable transparent encryption for a tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 'ob2mr3oae0****', 'title' => ''], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The encryption type. Valid values: '."\n" + .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" + .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" + .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['INTERNAL' => 'INTERNAL', 'USER_KMS' => 'USER_KMS'], + 'example' => 'INTERNAL', + 'title' => '', + ], + ], + [ + 'name' => 'EncryptionKeyId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the key.', 'type' => 'string', 'required' => false, 'example' => 'key-shh322****470h8v0-g2ll85****'], + ], + ], + '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' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'TenantEncryption' => [ + 'title' => 'job', + 'description' => 'job', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'null', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'ProposalMcmsKey' => [ - 'description' => '', + 'InstanceId' => ['description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'example' => 'ob317v4uif****', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'example' => 'ob2mr3oae0****', 'title' => ''], + 'EncryptionType' => [ + 'description' => 'The encryption type. Valid values: '."\n" + .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" + .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" + .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', + 'enumValueTitles' => ['INTERNAL' => 'INTERNAL', 'USER_KMS' => 'USER_KMS'], + 'example' => 'INTERNAL', + 'title' => '', ], ], + 'example' => '', ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '28', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantEncryption\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"ob2mr3oae0****\\",\\n \\"EncryptionType\\": \\"INTERNAL\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyTenantEncryption', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantEncryption', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": 4\\n}","type":"json"}]', ], - 'UpdateProjectConfig' => [ - 'summary' => '更新项目配置 Action=UpdateProjectConfig', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyTenantPrimaryZone' => [ + 'summary' => 'Alibaba Cloud CLI', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np_fe****', - ], + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The return result of the request. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ - 'name' => 'CommonTransferConfig', + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['title' => 'The ID of the OceanBase cluster.', 'description' => 'The primary zone of the tenant. '."\n" + .'It is one of the zones in which the cluster is deployed. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => ['title' => 'The zone where the primary node is located.', 'description' => 'The ID of the vSwitch. ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'UserVSwitchId', + 'in' => 'formData', + 'schema' => ['title' => 'Random', 'description' => 'The request ID. ', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx'], + ], + [ + 'name' => 'MasterIntranetAddressZone', + 'in' => 'formData', + 'schema' => ['title' => '主内网地址可用区', 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyTenantPrimaryZone'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&PrimaryZone=cn-hangzhou-h'."\n" + .'&Common request parameters'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'TenantEndpointId', + 'in' => 'formData', + 'schema' => ['description' => 'Tenant endpoint ID.', 'title' => 'Tenant endpoint ID', 'type' => 'string', 'example' => 'obe-4tw51gp7****', 'required' => false], + ], + [ + 'name' => 'TenantEndpointDirectId', + 'in' => 'formData', + 'schema' => ['description' => 'Tenant direct connection endpoint ID.', 'title' => 'Tenant direct connection endpoint ID', 'type' => 'string', 'required' => false, 'example' => 'obe-***'], + ], + [ + 'name' => 'UserDirectVSwitchId', + 'in' => 'formData', + 'schema' => ['description' => 'The vSwitch ID for the tenant direct connection address.', 'title' => 'Tenant direct connection address vSwitch ID', 'type' => 'string', 'required' => false, 'example' => 'vsw-***'], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => ['description' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz9a8***********', 'title' => ''], + ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => ['description' => 'Owner ID of the user VPC.', 'title' => 'Owner ID of the user VPC', 'type' => 'string', 'required' => false, 'example' => 'vpc-********'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '高级配置', + 'title' => ' ', + 'description' => 'You can call this operation to switch the primary zone of the tenant. ', 'type' => 'object', 'properties' => [ - 'SinkStoreFormat' => [ - 'type' => 'string', - ], - 'SourceStoreFormat' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'ModifyTenantPrimaryZone', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Switch Tenant Primary Zone', + 'changeSet' => [ + ['createdAt' => '2024-04-15T11:26:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-02T12:38:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-26T12:16:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-04T02:52:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-28T06:07:39.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantPrimaryZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'ModifyTenantResource' => [ + 'summary' => 'You can call this operation to modify the specifications of a tenant in an OceanBase cluster. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FullTransferConfig', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TenantId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], + ], + [ + 'name' => 'Cpu', + 'in' => 'formData', + 'schema' => ['description' => 'The information about the CPU resources of the tenant. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => ['title' => 'The memory size of the tenant, in GB. ', 'description' => 'The memory size of the tenant, in GB. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'LogDisk', + 'in' => 'formData', + 'schema' => ['description' => 'The size of the log disk allocated to the tenant, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '128', 'title' => ''], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => ['title' => '创建只读副本的可用区,当传入多个可用区的时候，以逗号分隔', 'description' => 'Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro', 'deprecated' => true], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '全量传输配置', - 'description' => '', + 'title' => 'The return result of the request.', + 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ - 'WriteWorkerNum' => [ - 'title' => '写入并发数 null 未配置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'ReadWorkerNum' => [ - 'title' => '读取并发数 null 未配置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'MaxConcurrentIndexDDLs' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IndexDDLConcurrencyLimit' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'TenantId' => ['title' => 'The ID of the tenant. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't33h8y08k****'], + 'RequestId' => ['title' => 'The request ID. ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n t33h8y08k****\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'ModifyTenantResource', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'ModifyTenantSecurityIpGroup' => [ + 'summary' => 'You can call this operation to modify the information on the whitelist group of the tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IncrTransferConfig', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'example' => 't4louaeei****'], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'paytest'], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The list of IP addresses in the whitelist group.'."\n" + ."\n" + .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', 'type' => 'string', 'required' => true, 'example' => '["192.***.*.*"]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '增量传输配置', - 'description' => '', + 'title' => '', + 'description' => 'The returned result of the request.', 'type' => 'object', 'properties' => [ - 'IncrSyncThreadCount' => [ - 'title' => '写入并发数 null 未配置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - 'enum' => [ - 'HEARTBEAT', - 'INSERT', - 'UPDATE', - 'DELETE', - 'BEGIN', - 'COMMIT', - 'ROLLBACK', - 'DDL', - 'ROW', - ], - ], - 'required' => false, - ], - 'SupportDDLTypes' => [ - 'title' => '支持DDL类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CREATE_TABLE', - 'enum' => [ - 'CREATE_TABLE', - 'ALTER_TABLE', - 'DROP_TABLE', - 'RENAME_TABLE', - 'TRUNCATE_TABLE', - 'CREATE_INDEX', - 'DROP_INDEX', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'SecurityIpGroup' => [ + 'title' => '', + 'description' => 'The information of the IP address whitelist group. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'example' => 'ob317v4uif****'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'example' => 't4louaeei****'], + 'SecurityIpGroupName' => ['title' => '', 'description' => 'The name of the whitelist group. ', 'type' => 'string', 'example' => 'paytest'], + 'SecurityIps' => ['title' => '', 'description' => 'The list of IP addresses in the IP address whitelist group.'."\n" + ."\n" + .'It is a string separated by commas, and each object is an IP address or a CIDR block.', 'type' => 'string', 'example' => '["192.***.*.*"]'], ], - 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyTenantSecurityIpGroup', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTenantTags' => [ + 'summary' => 'You can call this operation to modify the tags of a tenant.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't33h8y08k****'], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tags.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Key": "xxx", "Value", "xxx"}]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'Message' => ['title' => '', 'description' => 'The tag modification result.', 'type' => 'string', 'example' => 'done'], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"done\\"\\n}","type":"json"}]', + 'title' => 'ModifyTenantTags', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTenantUserDescription' => [ + 'summary' => 'You can call this operation to modify the description of a specified account in a tenant. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'ReverseIncrTransferConfig', + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database account. '."\n" + .'You cannot use reserved keywords, such as SYS and root. ', 'description' => 'The description of the database. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyTenantUserDescription**. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'this is a test database'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '反向增量传输配置', - 'description' => '', + 'title' => 'The ID of the region. ', + 'description' => 'Example 1', 'type' => 'object', 'properties' => [ - 'IncrSyncThreadCount' => [ - 'title' => '写入并发数 null 未配置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'ThrottleRps' => [ - 'title' => '限制RPS null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'ThrottleIOPS' => [ - 'title' => '限制流量，单位字节 null 不限速', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'RecordTypeWhiteList' => [ - 'title' => '有增量同步阶段时，同步的增量数据类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INSERT', - 'enum' => [ - 'HEARTBEAT', - 'INSERT', - 'UPDATE', - 'DELETE', - 'BEGIN', - 'COMMIT', - 'ROLLBACK', - 'DDL', - 'ROW', - ], - ], - 'required' => false, - ], - 'SupportDDLTypes' => [ - 'title' => '支持DDL类型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CREATE_TABLE', - 'enum' => [ - 'CREATE_TABLE', - 'ALTER_TABLE', - 'DROP_TABLE', - 'RENAME_TABLE', - 'TRUNCATE_TABLE', - 'CREATE_INDEX', - 'DROP_INDEX', - ], - ], - 'required' => false, - ], + 'RequestId' => ['title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyTenantUserDescription'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&UserName=pay_test'."\n" + .'&Description=This is a test database'."\n" + .'&Common request parameters'."\n" + .'```', 'description' => 'You can call this operation to modify the description of a specified account in a tenant. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n","errorExample":""}]', + 'title' => 'ModifyTenantUserDescription', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + ], + 'ModifyTenantUserPassword' => [ + 'summary' => 'Modifies the logon password of a specified database account under a tenant.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the database account.'."\n" + .'Certain reserved keywords such as SYS and root cannot be used.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The logon password of the database account.'."\n" + .'The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password must be 10 to 32 characters in length. Supported special characters are: !@#$%^&* ()_ +-=.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '!Aliyun4Oceanbase'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The encryption method.', 'type' => 'string', 'required' => false, 'example' => 'RSA'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CM-RESOAT1111'."\n", - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'WARN', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Data' => [ - 'title' => '数据', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"WARN\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"请联系管理员\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'DeleteDataSource' => [ - 'summary' => '删除数据源', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Modify tenant user password', + 'changeSet' => [ + ['createdAt' => '2023-05-17T02:26:45.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyTenantUserRoles' => [ + 'summary' => 'Modifies the database permissions for a specified account in a tenant.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The name of the database account.
'."\n" + .'You cannot use reserved keywords, such as `SYS` or `root`.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['title' => 'Indicates whether the privilege was granted to the role. ', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4pnum****'], + ], + [ + 'name' => 'UserRole', + 'in' => 'formData', + 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The role information for the database account.'."\n" + ."\n" + .'- For a tenant in MySQL mode, you must pass all databases and their corresponding permissions. Permissions for any database not included in the request will be revoked. To revoke all permissions, pass an empty array (`[]`).'."\n" + ."\n" + .'- For a tenant in Oracle mode, specify only the databases, tables, and corresponding permissions that you want to modify.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '- OceanBase MySQL 模式：[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]'."\n" + .'- OceanBase Oracle 模式：[{"database":"xxx","table":"xxx","role":"readonly"}]'."\n" + .'并且 modifyType 需要传入相应的值'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => 'The role of the account. ', 'description' => 'The OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => ['title' => 'The name of the database account. '."\n" + .'You cannot use reserved keywords, such as SYS and root. ', 'description' => 'The type of permission modification.
'."\n" + .'This parameter is not required for a tenant in MySQL mode. For a tenant in Oracle mode, specify one of the following operations:
'."\n" + ."\n" + .'- Add: `ADD`.'."\n" + ."\n" + .'- Delete: `DELETE`.'."\n" + ."\n" + .'- Update: `UPDATE`.', 'type' => 'string', 'example' => 'UPDATE', 'required' => false], + ], + [ + 'name' => 'UserType', 'in' => 'formData', 'schema' => [ - 'title' => '数据源 ID', - 'description' => '', + 'title' => 'User type', + 'description' => 'The type of the user account. Valid values: `Normal` and `Admin`.', 'type' => 'string', - 'required' => true, - 'example' => 'e_5anwndq', + 'example' => 'Normal', + 'enum' => [], + 'required' => false, ], ], + [ + 'name' => 'GlobalPermissions', + 'in' => 'formData', + 'schema' => ['title' => 'Global permissions ', 'description' => 'Global permissions.', 'type' => 'string', 'required' => false, 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OmsApiReturnResult', - 'description' => '', + 'title' => 'The list of database accounts in the tenant. ', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', + 'TenantUser' => [ + 'title' => 'The name of the account. ', + 'description' => 'Information about the database account in the tenant.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'ExtraContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'MessageMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsContext' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', + 'UserRole' => [ + 'title' => 'The ID of the region. ', + 'description' => 'A list of database permissions for the account.'."\n" + ."\n" + .'- Admin: the privileged account.'."\n" + ."\n" + .'- Normal: a regular account.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a database permission.', + 'type' => 'object', + 'properties' => [ + 'Database' => ['title' => 'Example 1', 'description' => 'The database (schema) name.', 'type' => 'string', 'example' => 'db_pay1'], + 'Role' => ['title' => ' ', 'description' => 'The role assigned.', 'type' => 'string', 'example' => 'ReadOnly'], + 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'tbl_pay1', 'title' => ''], + 'IsSuccess' => ['description' => 'Indicates whether the authorization was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '账号具备的数据库权限信息列表。', ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], + 'UserName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'pay_test', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 't4pnum****', 'title' => ''], ], + 'example' => '', ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator. ', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '28', - ], - 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', - ], - 'CreateRdsPostgreSQLDataSource' => [ - 'summary' => '创建RDS PG 数据源', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TenantUser\\": {\\n \\"UserRole\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"IsSuccess\\": true\\n }\\n ],\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'Modify tenant user role ', + 'changeSet' => [ + ['createdAt' => '2025-02-13T13:01:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-04T02:53:05.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyTenantUserStatus' => [ + 'summary' => 'The status of the database account. Valid values: '."\n" + .'- LOCKED: The account is locked. '."\n" + .'- ONLINE: The account is unlocked. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'UserName', 'in' => 'formData', - 'schema' => [ - 'title' => '数据源名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'data_name', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['title' => 'The name of the database account. '."\n" + .'You cannot use reserved keywords, such as SYS and root. ', 'description' => 'The list of database accounts in the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], ], [ - 'name' => 'InstanceId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'g_abcdefj***'."\n", - ], + 'schema' => ['title' => 'The return result of the request. ', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ - 'name' => 'DatabaseName', + 'name' => 'UserStatus', 'in' => 'formData', - 'schema' => [ - 'title' => 'Database Name', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'db_name', - ], + 'schema' => ['title' => 'Locked', 'description' => 'The status of the database account. Valid values: '."\n" + .'- Locked: The account is locked. '."\n" + .'- Online: The account is unlocked. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LOCKED'], ], [ - 'name' => 'UserName', + 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['title' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyTenantUserStatus**. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_name', + 'title' => '$.parameters[5].schema.description', + 'description' => '$.parameters[5].schema.example', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '$.parameters[5].schema.enumValueTitles', 'description' => 'Example 1', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'TenantUser' => [ + 'title' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyTenantUserStatus'."\n" + .'&UserName=pay_test'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&UserStatus=Locked'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', + 'description' => 'List information of database accounts in the tenant. ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to lock or unlock a specified database account. ', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => ['title' => 'ModifyTenantUserStatus', 'description' => 'Status of the database account. '."\n" + .'- LOCKED: Locked. '."\n" + .'- ONLINE: Unlocked. ', 'type' => 'string', 'example' => 'LOCKED'], + 'UserName' => ['title' => '', 'description' => 'Account name. ', 'type' => 'string', 'example' => 'pay_test'], + 'TenantId' => ['title' => '', 'description' => 'Tenant ID. ', 'type' => 'string', 'example' => 't33h8y08k****'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUser\\": [\\n {\\n \\"UserStatus\\": \\"LOCKED\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Lock or unlock a specified database account ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Password', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pass_word', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ReleaseProject' => [ + 'summary' => 'Deletes a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Description', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '自定义描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test database', - ], + 'schema' => ['description' => 'The ID of the data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', - 'description' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否调用成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ErrorDetail' => [ - 'title' => '错误详情', - 'description' => '', + 'title' => '', + 'description' => 'The error details object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Level' => [ - 'title' => 'FATAL, ERROR, WARNING, CRITICAL', - 'description' => '', - 'type' => 'string', - 'example' => 'ERROR', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], 'ExtraContext' => [ - 'description' => '', + 'description' => 'The data for populating placeholders in the Message.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'null', - 'description' => '', - ], - ], - 'MessageMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'additionalProperties' => ['description' => 'The key-value pairs for populating placeholders in the Message.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'MessageMcmsContext' => [ - 'description' => '', + 'description' => 'The data for populating placeholders for the message identified by MessageMcmsKey.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Reason' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ReasonMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'additionalProperties' => ['description' => 'The key-value pairs for populating placeholders in the localized message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'ReasonMcmsContext' => [ - 'description' => '', + 'description' => 'The context of the error cause.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'null', - 'description' => '', - ], - ], - 'Proposal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'ProposalMcmsKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', + 'additionalProperties' => ['description' => 'The context of the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Proposal' => ['description' => 'The suggested resolution.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the proposal.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'ProposalMcmsContext' => [ - 'description' => '', + 'description' => 'The context of the proposal.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'null', - ], - ], - 'UpstreamErrorDetail' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'null', + 'additionalProperties' => ['description' => 'The context of the proposal.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Details about errors from upstream services.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'INNER_ERROR', - ], - 'Message' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => 'A system error occurred.', - ], - 'Advice' => [ - 'title' => '建议', - 'description' => '', - 'type' => 'string', - 'example' => 'Contact the administrator.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'PageNumber' => [ - 'title' => 'pageNumber', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'pageSize', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => 'TotalCount', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Data' => [ - 'title' => '数据源 ID', - 'description' => '', - 'type' => 'string', - 'example' => 'e_5anwndq', - ], + 'Code' => ['title' => 'code', 'description' => 'The error code for the legacy API version. This parameter is deprecated.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message for the legacy API version. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggested resolution for the legacy API version. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'."\n"], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'Cost' => ['description' => 'The time taken for the request to be processed, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The data returned.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"e_5anwndq\\"\\n}","type":"json"}]', - ], - 'DescribeBackupSetDownloadLink' => [ - 'summary' => 'You can call this operation to query the link for downloading a backup set of OceanBase Database.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\\\n\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Release Job', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:ReleaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ReleaseWorkerInstance' => [ + 'summary' => 'Use this API to release a transmission instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'DownloadTaskId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the download task corresponding to the target backup set.', - 'type' => 'string', - 'required' => true, - 'example' => '1000002', - ], + 'schema' => ['description' => 'The ID of the worker instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'g_abcdefj***'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The API response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The returned data.', + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details about the error, if one occurred.', 'type' => 'object', 'properties' => [ - 'DownloadTaskId' => [ - 'description' => 'The ID of the download task corresponding to the target backup set.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000002', - ], - 'DownloadTaskStatus' => [ - 'description' => 'The status of the download task corresponding to the target backup set.', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'DownloadTaskCreateTime' => [ - 'description' => 'The time when the download task corresponding to the target backup set was created.', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'BackupRestorableTime' => [ - 'description' => 'The restorable time of the backup set.', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'BackupSetId' => [ - 'description' => 'The ID of the target backup set.', - 'type' => 'string', - 'example' => 'bak-4n****gacpa8', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Used to populate placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Key-value pairs for placeholders in the `Message` string.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'InternalUrl' => [ - 'description' => 'The internal URL.', - 'type' => 'string', - 'example' => 'http://bucket.oss-region-internal.aliyuncs.com/xxxxx', + 'MessageMcmsKey' => ['description' => 'The localization key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The context for the localized message.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Key-value pairs for placeholders in the localized message string.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'UrlExpiredTime' => [ - 'description' => 'The expiration time of the URL.', - 'type' => 'string', - 'example' => '2024-01-04 17:39:49', + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The localization key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Key-value pairs for placeholders in the localized reason string.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'UrlAliveTime' => [ - 'description' => 'The validity period of the URL, in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', + 'Proposal' => ['description' => 'A suggested action to resolve the error.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The localization key for the proposal.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the proposal.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Key-value pairs for placeholders in the localized proposal string.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'Details of an error from an upstream service, typically for debugging nested HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code, for backward compatibility.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message, for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggested action, for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number of the returned results. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of matching entries. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The time taken to process the request, in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => ['description' => 'The data payload returned by the call.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Release a transmission instance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:ReleaseWorkerInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 1000002,\\n \\"DownloadTaskStatus\\": \\"RUNNING\\",\\n \\"DownloadTaskCreateTime\\": \\"2020-05-22T17:04:18\\",\\n \\"BackupRestorableTime\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"BackupSetId\\": \\"bak-4n****gacpa8\\",\\n \\"InternalUrl\\": \\"http://bucket.oss-region-internal.aliyuncs.com/xxxxx\\",\\n \\"UrlExpiredTime\\": \\"2024-01-04 17:39:49\\",\\n \\"UrlAliveTime\\": 3600\\n }\\n}","type":"json"}]', - 'title' => 'DescribeBackupSetDownloadLink', ], - 'DescribeDataBackupSet' => [ - 'summary' => 'You can call this operation to query the information about the backup sets of an OceanBase cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveStandbyInstance' => [ + 'summary' => 'You can call this operation to decouple a standby instance from its primary instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '集群ID', - 'description' => 'The ID of the OceanBase cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'title' => '按照备份集状态查询', - 'description' => 'The status of the backup sets to be queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'DONE', - 'enum' => [ - 'BEGINNING', - 'DOING', - 'DONE', - 'FAILED', - 'OVERDUE', - 'UNKNOWN', - ], - ], - ], - [ - 'name' => 'BackupObjectType', - 'in' => 'formData', - 'schema' => [ - 'title' => '按照备份对象类型查询', - 'description' => 'The object type of the backup sets to be queried.', - 'type' => 'string', - 'required' => false, - 'example' => 'tenant', - 'enum' => [ - 'cluster', - 'tenant', - 'table', - 'database', - ], - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The backup start time, in the format of *yyyy-MM-dd* T *HH:mm:ss* Z (UTC time).', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-12-27T16:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The backup end time.', - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-06T15:59:59Z', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number, which takes effect in a pagination query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the primary instance.', 'type' => 'string', 'required' => true, 'example' => 'ob608fgj1q****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of rows to return on each page.'."\n" - .'- Maximum value: 100.'."\n" - .'- Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total count. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of backup sets.', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The backup end time.', - 'type' => 'string', - 'example' => '2023-04-13T03:38:10Z', - ], - 'Status' => [ - 'description' => 'The status of the backup set.', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Type' => [ - 'description' => 'The backup type.', - 'type' => 'string', - 'example' => 'manual', - ], - 'StartTime' => [ - 'description' => 'The backup start time.', - 'type' => 'string', - 'example' => '2020-05-22T17:04:18', - ], - 'DataSize' => [ - 'description' => 'The size of the backup set.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '31457280', - ], - 'Policy' => [ - 'description' => 'The backup strategy.', - 'type' => 'string', - 'example' => 'automated', - ], - 'SetId' => [ - 'description' => 'The ID of the backup set.', - 'type' => 'string', - 'example' => 'imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70', - ], - 'Method' => [ - 'description' => 'The backup method.', - 'type' => 'string', - 'example' => 'logical', - ], - 'Checkpoint' => [ - 'description' => 'The checkpoint.', - 'type' => 'string', - 'example' => '2023-05-15T07:11:08Z', - ], - 'DataVersion' => [ - 'description' => 'The data version.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1678847020352', - ], - 'BackupObjectType' => [ - 'title' => '备份对象类型', - 'description' => 'The backup object type.', - 'type' => 'string', - 'example' => 'cluster', - ], - 'BackupObjects' => [ - 'title' => '备份对象列表', - 'description' => 'The backup objects.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of backup objects.', - 'type' => 'object', - 'properties' => [ - 'ClusterName' => [ - 'description' => 'The name of the cluster.', - 'type' => 'string', - 'example' => 'test-****way', - ], - 'TenantName' => [ - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'ob2mr3oae0****', - ], - 'DatabaseTablesList' => [ - 'description' => 'The databases and tables in the backup set.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of databases and tables in the backup set.', - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'sms_pre', - ], - 'Tables' => [ - 'description' => 'The tables.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of tables.', - 'type' => 'string', - 'example' => '{\'Tables\': []}', - ], - ], - ], - ], - ], - ], - ], - ], - 'BackupResults' => [ - 'title' => '备份结果', - 'description' => 'The backup results.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of backup results.', - 'type' => 'object', - 'properties' => [ - 'ClusterName' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'container-opa-****-02', - ], - 'TenantName' => [ - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'ob2mr3oae0****'."\n", - ], - 'TableBackupResults' => [ - 'description' => 'The table backup results.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of table backup results.', - 'type' => 'object', - 'properties' => [ - 'Database' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'order_ce****_online', - ], - 'Table' => [ - 'description' => 'The name of the table.', - 'type' => 'string', - 'example' => 'tr_sale_order_****', - ], - 'Status' => [ - 'description' => 'The backup status.', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Message' => [ - 'description' => 'The error description.', - 'type' => 'string', - 'example' => 'Create tag success', - ], - ], - ], - ], - ], - ], - ], - 'DownloadTaskStatus' => [ - 'title' => '目标备份集所对应的备份任务状态', - 'description' => 'The status of the download task corresponding to the target backup set.', - 'type' => 'string', - 'example' => 'not_exist', - ], - 'DownloadTaskId' => [ - 'title' => '目标备份集所对应的备份任务ID', - 'description' => 'The ID of the download task corresponding to the target backup set.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100***012', - ], - 'Validity' => [ - 'title' => '有效性，可空；', - 'description' => 'The validity, which can be left empty.', - 'type' => 'string', - 'example' => 'VALID', - 'enum' => [ - 'VALID', - 'INVALID', - ], - ], - 'Progress' => [ - 'title' => '备份进度', - 'description' => 'The backup progress.', - 'type' => 'string', - 'example' => '52', - ], - 'StorageClass' => [ - 'title' => '备份集类型，standard：一级备份、'."\n" - .'archive：归档（二级）备份', - 'description' => 'The type of the backup set. Valid values: '."\n" - .'* standard: level-1 backup '."\n" - .'* archive: second backup', - 'type' => 'string', - 'example' => 'standard', - ], - ], - ], - ], + 'name' => 'TargetInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the standby instance to be decoupled.', 'type' => 'string', 'required' => true, 'example' => 'ob4bv8o7sp****', 'title' => ''], + ], + [ + 'name' => 'Forced', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to forcibly decouple the standby instance.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'RemoveStandbyInstance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:RemoveStandbyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2023-04-13T03:38:10Z\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Type\\": \\"manual\\",\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"DataSize\\": 31457280,\\n \\"Policy\\": \\"automated\\",\\n \\"SetId\\": \\"imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70\\",\\n \\"Method\\": \\"logical\\",\\n \\"Checkpoint\\": \\"2023-05-15T07:11:08Z\\",\\n \\"DataVersion\\": 1678847020352,\\n \\"BackupObjectType\\": \\"cluster\\",\\n \\"BackupObjects\\": [\\n {\\n \\"ClusterName\\": \\"test-****way\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\",\\n \\"DatabaseTablesList\\": [\\n {\\n \\"Database\\": \\"sms_pre\\",\\n \\"Tables\\": [\\n \\"{\'Tables\': []}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"BackupResults\\": [\\n {\\n \\"ClusterName\\": \\"container-opa-****-02\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\\\n\\",\\n \\"TableBackupResults\\": [\\n {\\n \\"Database\\": \\"order_ce****_online\\",\\n \\"Table\\": \\"tr_sale_order_****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Message\\": \\"Create tag success\\"\\n }\\n ]\\n }\\n ],\\n \\"DownloadTaskStatus\\": \\"not_exist\\",\\n \\"DownloadTaskId\\": 0,\\n \\"Validity\\": \\"VALID\\",\\n \\"Progress\\": \\"52\\",\\n \\"StorageClass\\": \\"standard\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDataBackupSet', ], - 'CreateBackupSetDownloadLink' => [ - 'summary' => 'You can call this operation to create a backup set download link in OceanBase Database.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResumeProject' => [ + 'summary' => 'Resumes a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '目标备份集所属Oceanbase集群ID', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-bp67acfmxazb4p****', - ], - ], - [ - 'name' => 'BackupSetId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '目标备份集ID', - 'description' => 'The ID of the target backup set.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'bak-6f****', - ], + 'schema' => ['description' => 'The ID of a data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Data' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', 'type' => 'object', 'properties' => [ - 'DownloadTaskId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The ID of the download task corresponding to the target backup set.', - 'example' => '100***012', + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Populates placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Used to populate placeholders in the message identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Used to populate placeholders in the reason identified by `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The new suggestion.', 'type' => 'string', 'example' => 'Contact the administrator.', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Used to populate placeholders in the suggestion identified by `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of a placeholder parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'UpstreamErrorDetail' => ['description' => 'The upstream error detail returned when an HTTP request fails.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], - 'description' => 'The returned data.'."\n", + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code. This parameter is deprecated.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The legacy suggestion. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total count of entries for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'Cost' => ['description' => 'The request processing time in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The returned data. This field is empty for this operation.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'The return result of the request.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Restore Job', + 'changeSet' => [], + 'ramActions' => [], ], - 'DescribeRestorableTenants' => [ - 'summary' => 'Queries information about restorable OceanBase Database tenants.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RetryProjectModifyRecords' => [ + 'summary' => 'This API retries a modification by its record ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'The modification record ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Oceanbase集群ID。', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + 'title' => 'OmsApiReturnResult', + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details about the error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The new error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values are `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The new error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Contains key-value pairs to populate placeholders in `Message`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Contains key-value pairs to populate placeholders in `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Contains key-value pairs to populate placeholders in `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The new suggestion.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggestion content.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Contains key-value pairs to populate placeholders in `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details about an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The legacy suggestion.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => ['description' => 'The response data.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'IsRemote', - 'in' => 'formData', - 'schema' => [ - 'title' => '为兼容老版本，可以为空', - 'description' => 'This parameter is provided for compatibility with earlier versions and can be left empty.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Retry the modification operation', + 'description' => 'You can only retry modification records that have a `FAILED` status.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:RetryProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'StartProject' => [ + 'summary' => 'Starts a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SetId', - 'in' => 'formData', - 'schema' => [ - 'title' => '备份集ID', - 'description' => 'The ID of the backup set.', - 'type' => 'string', - 'required' => false, - 'example' => 'bak-xxxxx', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'RestoreMode', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '恢复方式', - 'description' => 'The restore method. This parameter is required when `IsRemote` is set to `true`, and is optional otherwise.', - 'type' => 'string', - 'required' => false, - 'example' => 'from_time_point', - 'enum' => [ - 'from_backup_set', - 'from_time_point', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'Details about the error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Key-value pairs for populating placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to populate placeholders in the `Message` parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Values to populate placeholders in the message template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Used to populate placeholders in the message specified by the `MessageMcmsKey` parameter.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'A brief description of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error reason.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested action to resolve the error.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the suggested action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the suggested action.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The context for the suggested action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of the error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The legacy error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The legacy error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The legacy suggestion for resolving the error.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'XCVSADG****DSGDS'."\n"], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. This parameter is returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'."\n"], + 'Cost' => ['description' => 'The time taken to process the request, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The returned data. This parameter is null for this API call.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\\\n\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Start Job', + 'changeSet' => [], + 'ramActions' => [], + ], + 'StartProjectsByLabel' => [ + 'summary' => 'This API starts all unstarted data migration or data synchronization tasks under a specific tag.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Method', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'l_****'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '备份类型', - 'description' => 'The backup method.', - 'type' => 'string', - 'required' => false, - 'example' => 'native_logical', - 'enum' => [ - 'logical', - 'physical', - 'native_logical', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Specifies data for the placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The data for a placeholder in the `Message` parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The MCMS key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Specifies data for placeholders in the message template identified by `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The data for a placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key for the error cause.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The context for the error cause.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The data for a placeholder in the reason template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested solution.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key for the proposal content.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The context for the proposal content.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The data for a placeholder in the proposal template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The details of an error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'A legacy error code for backward compatibility.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'A legacy error message for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'A legacy suggestion for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '79'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'Details about the projects.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of projects processed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'SucceedProjectIds' => [ + 'title' => '', + 'description' => 'A list of IDs of projects that were successfully started.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a project that was successfully started.', 'type' => 'string', 'example' => 'np_4w****'."\n", 'title' => ''], + 'example' => '', + ], + 'FailedProjectIds' => [ + 'title' => '', + 'description' => 'A list of IDs of projects that failed to start.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a project that failed to start.', 'type' => 'string', 'example' => 'np_3w****'."\n", 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], ], + 'example' => '', ], ], - [ - 'name' => 'IsOnline', - 'in' => 'formData', - 'schema' => [ - 'title' => '目标解析集群是否在线。为兼容旧版本可以不填，不填时值为对isRemote取反', - 'description' => 'Specifies whether the target cluster is online. '."\n" - ."\n" - .'**Note** This parameter is used for compatibility with earlier versions and can be left empty. When left empty, it specifies negation for the value of `isRemote`.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 79,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 20,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\\\n\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Start all jobs under the specified label that have not been started ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StartProjectsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'StopProject' => [ + 'summary' => 'Use this API to pause a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'RestoreObjectType', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '恢复对象类型', - 'description' => 'The type of the restore object.', - 'type' => 'string', - 'required' => false, - 'example' => 'tenant', - 'enum' => [ - 'cluster', - 'tenant', - 'database', - 'table', - 'serverless', - ], - ], + 'schema' => ['description' => 'The ID of the data migration or synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', - ], - 'Tenants' => [ - 'description' => 'The information about the tenants.', - 'type' => 'array', - 'items' => [ - 'description' => 'The list of tenant information.', - 'type' => 'object', - 'properties' => [ - 'TenantName' => [ - 'description' => 'The name of the tenant.', - 'type' => 'string', - 'example' => 'sbtest1', - ], - 'Method' => [ - 'description' => 'The backup method.', - 'type' => 'string', - 'enumValueTitles' => [ - 'native_logical：库表逻辑备份' => '', - 'physical：物理备份' => '', - 'logical：逻辑备份（OB2276及以下）' => '', - ], - 'example' => 'logical', - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'example' => 'ob317v4uif****', - ], - 'TimeIntervalList' => [ - 'description' => 'The list of restorable periods of the tenant.', - 'type' => 'array', - 'items' => [ - 'description' => 'Information about the restorable periods.', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the restorable period.', - 'type' => 'string', - 'example' => '2023-01-20T16:00:00Z', - ], - 'EndTime' => [ - 'description' => 'The end time of the restorable period.', - 'type' => 'string', - 'example' => '2023-03-13T02:43:03Z', - ], - 'FromArchive' => [ - 'title' => '是否属于归档恢复', - 'description' => 'Indicates whether the restore is based on archiving.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StorageType' => [ - 'description' => 'The storage type of backup data.', - 'type' => 'string', - 'enumValueTitles' => [ - 'standard：标准存储' => '', - 'archive：归档存储' => '', - ], - 'example' => 'standard', - ], - ], - ], - ], - 'ClusterId' => [ - 'title' => '集群ID', - 'description' => 'The ID of the cluster.', - 'type' => 'string', - 'example' => 'objnf3b2****', - ], - 'ObRpmVersion' => [ - 'title' => 'OB RPM版本号', - 'description' => 'The version of the OceanBase Database RPM package.', - 'type' => 'string', - 'example' => '3.2.3.1-2022080510****', - ], - 'ObVersion' => [ - 'title' => 'OB 大版本号', - 'description' => 'The major version of OceanBase Database.', - 'type' => 'string', - 'example' => '3.2.3.1', - ], - 'SourceRegion' => [ - 'title' => '集群所属地域', - 'description' => 'The region of the cluster.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TenantAlias' => [ - 'title' => '租户别名', - 'description' => 'The alias of the tenant.', - 'type' => 'string', - 'example' => 'aaa', - ], - 'CpuNum' => [ - 'title' => '租户cpu规格', - 'description' => 'The number of CPU cores. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MemoryNum' => [ - 'title' => '租户memory规格', - 'description' => 'The size of memory for the tenant.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'BackupBucketName' => [ - 'title' => '备份目录名', - 'description' => 'The name of the backup directory.', - 'type' => 'string', - 'example' => 'backup', - ], - 'ObTenantId' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 'tvd43v****', - ], - 'ClusterName' => [ - 'title' => '集群名', - 'description' => 'The name of the cluster.', - 'type' => 'string', - 'example' => 'testCluster', - ], - 'BackupSets' => [ - 'description' => 'The list of backup sets.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the backupsets.', - 'type' => 'object', - 'properties' => [ - 'Checkpoint' => [ - 'title' => '备份集的快照点', - 'description' => 'The checkpoint of the backup set.', - 'type' => 'string', - 'example' => '2024-01-01\'T\'12:10:10.000\'Z\'', - ], - 'SetId' => [ - 'title' => '备份集ID', - 'description' => 'The ID of the backup set.', - 'type' => 'string', - 'example' => 'bak-xxxxx', - ], - 'BackupSetId' => [ - 'description' => 'The ID of the full backup set used for restore.', - 'type' => 'string', - 'example' => 'bak-4n****gacpa8', - ], - 'TenantId' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant.', - 'type' => 'string', - 'example' => 't5********', - ], - ], - ], - ], - 'UsedDisk' => [ - 'title' => '租户磁盘大小', - 'description' => 'The size of disk space for the tenant.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'UnitNum' => [ - 'title' => '租户节点数', - 'description' => 'The number of nodes of the tenant.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TenantMode' => [ - 'title' => '租户模式', - 'description' => 'The mode of the tenant.', - 'type' => 'string', - 'example' => 'Oracle', - ], - 'TenantDataBackupRemainDays' => [ - 'title' => '租户备份数据剩余有效天数', - 'description' => 'The remaining validity period, in days, of the backup data of the tenant.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The details of the error.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.'."\n", 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The values for placeholders in the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the Message parameter.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Contains placeholder values for the message identified by MessageMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the message identified by MessageMcmsKey.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'Contains placeholder values for the error reason identified by ReasonMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the error reason identified by ReasonMcmsKey.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggestion.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'Contains placeholder values for the suggestion identified by ProposalMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the suggestion identified by ProposalMcmsKey.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of an error from an upstream service. This parameter is relevant for errors that originate from upstream HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This parameter is deprecated.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'."\n"], + 'Advice' => ['description' => 'The suggestion. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '473469**-AA6F-4D**-B3DB-A***********'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. Available only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries per page. Available only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. Available only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request duration.', 'type' => 'string', 'title' => '', 'example' => '27 ms'], + 'Data' => ['description' => 'This parameter is unused and is always null.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 6,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Tenants\\": [\\n {\\n \\"TenantName\\": \\"sbtest1\\",\\n \\"Method\\": \\"logical\\",\\n \\"TenantId\\": \\"ob317v4uif****\\",\\n \\"TimeIntervalList\\": [\\n {\\n \\"StartTime\\": \\"2023-01-20T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-03-13T02:43:03Z\\",\\n \\"FromArchive\\": true,\\n \\"StorageType\\": \\"standard\\"\\n }\\n ],\\n \\"ClusterId\\": \\"objnf3b2****\\",\\n \\"ObRpmVersion\\": \\"3.2.3.1-2022080510****\\",\\n \\"ObVersion\\": \\"3.2.3.1\\",\\n \\"SourceRegion\\": \\"cn-hangzhou\\",\\n \\"TenantAlias\\": \\"aaa\\",\\n \\"CpuNum\\": 1,\\n \\"MemoryNum\\": 100,\\n \\"BackupBucketName\\": \\"backup\\",\\n \\"ObTenantId\\": \\"tvd43v****\\",\\n \\"ClusterName\\": \\"testCluster\\",\\n \\"BackupSets\\": [\\n {\\n \\"Checkpoint\\": \\"2024-01-01\'T\'12:10:10.000\'Z\'\\",\\n \\"SetId\\": \\"bak-xxxxx\\",\\n \\"BackupSetId\\": \\"bak-4n****gacpa8\\",\\n \\"TenantId\\": \\"t5********\\"\\n }\\n ],\\n \\"UsedDisk\\": 50,\\n \\"UnitNum\\": 2,\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantDataBackupRemainDays\\": 7\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRestorableTenants', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27 ms\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Pause Job', + 'changeSet' => [], + 'ramActions' => [], ], - 'DescribeAnomalySQLList' => [ - 'summary' => 'You can call this operation to obtain the list of SQL statements that may have performance problems according to the diagnostic system. ', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopProjectModifyRecords' => [ + 'summary' => 'This API stops a modification operation based on the modification record\'s ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => 'OceanBase集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'obsd23j4f****', - ], + 'schema' => ['description' => 'The ID of the modification record.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], ], - [ - 'name' => 'TenantId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code. This parameter is deprecated.', 'type' => 'string', 'example' => 'INNER_ERROR', 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message. This parameter is deprecated.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'A key-value map for placeholders in the `Message` parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The template key for the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'A key-value map for placeholders in the `MessageMcmsKey` template.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The template key for the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'A key-value map for placeholders in the `ReasonMcmsKey` template.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'A suggested action.', 'type' => 'string', 'example' => 'Contact the administrator.', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The template key for the suggested action.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'A key-value map for placeholders in the `ProposalMcmsKey` template.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a specific placeholder in the template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of the error from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This parameter is deprecated.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This parameter is deprecated.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'A suggested action.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request processing time, in seconds.', 'type' => 'string', 'title' => '', 'example' => '30'], + 'Data' => ['description' => 'The requested data.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '起始时间', - 'description' => 'The start time of the time range for querying suspicious SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Stop modification operation ', + 'description' => 'You can only stop modification records in the RUNNING or FAILED state. This action is irreversible.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StopProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'StopProjectsByLabel' => [ + 'summary' => 'This API pauses all running data migration or data synchronization tasks with a specified tag.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time of the time range for querying suspicious SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13T15:40:43Z', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'DbName', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'l_****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '数据库名称', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity of the error. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.', 'type' => 'string', 'example' => 'ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'Contains values for the placeholders in the `Message` field.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the `Message` field.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The lookup key for the error message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'Contains values for the placeholders in the message template that corresponds to `MessageMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the message template that corresponds to `MessageMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The lookup key for the error cause template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'An object that contains values for the placeholders in the reason template that corresponds to the `ReasonMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the reason template that corresponds to the `ReasonMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'The suggested solution.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The lookup key for the suggested solution template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'An object that contains values for the placeholders in the proposal template that corresponds to the `ProposalMcmsKey`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A value for a placeholder in the proposal template that corresponds to the `ProposalMcmsKey`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'Details of an error from an upstream service. This is used to handle HTTP requests.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code. This is a legacy field.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message. This is a legacy field.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'The suggested solution. This is a legacy field.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The unique identifier for the request. If you need to contact support, provide this ID.', 'type' => 'string', 'example' => 'A595F34C-XXXX-5D0C-8DA8-B3ED76'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '140'], + 'Cost' => ['description' => 'The time, in seconds, it took to process the request.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => 'The results of the batch stop operation.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of projects processed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '16'], + 'SucceedProjectIds' => [ + 'title' => '', + 'description' => 'The IDs of projects that were successfully stopped.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a project that was successfully stopped.', 'type' => 'string', 'example' => 'np_4w****', 'title' => ''], + 'example' => '', + ], + 'FailedProjectIds' => [ + 'title' => '', + 'description' => 'The IDs of projects that failed to stop.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a project that failed to stop.', 'type' => 'string', 'example' => 'np_3w****', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'formData', - 'schema' => [ - 'title' => '关键字查询', - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"A595F34C-XXXX-5D0C-8DA8-B3ED76\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 140,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 16,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Pause all running Jobs under the specified label', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StopProjectsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'SwitchoverInstance' => [ + 'summary' => 'You can call this operation to switch between the primary and standby instances of OceanBase.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SearchParameter', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数查询', - 'description' => 'The search parameter. ', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'SearchRule', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '查询规则', - 'description' => 'The search rule. '."\n" - .'Valid values: "=", ">", ">=", "<", and "<="', - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID of the primary/standby instance. You can set the default value to the instance ID of the instance to be switched to the primary instance.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ - 'name' => 'SearchValue', + 'name' => 'TargetInstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '查询值', - 'description' => 'The search value. ', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID of the instance to be switched to the primary instance.', 'type' => 'string', 'required' => true, 'example' => 'ob4bv8o7sp****'], ], [ - 'name' => 'SQLId', + 'name' => 'Forced', 'in' => 'formData', + 'schema' => ['description' => 'Whether to force the switchover.'."\n" + .'- true: Force the switchover.'."\n" + .'- false: Do not force the switchover.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'SQLID', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + 'title' => 'Schema of Response', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469**-AA6F-4D**-B3DB-A***********'], + 'Data' => [ + 'description' => 'The list of data for the switchover.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The message of the switchover.', 'type' => 'string', 'example' => 'delete tag-value success', 'title' => ''], + 'Success' => ['description' => 'Whether the switchover is successful.'."\n" + .'- true: the switchover succeeded.'."\n" + .'- false: the switchover failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'NodeIp', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点ip', - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp19y05uq6xpacyqnlrc', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"Data\\": {\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + 'title' => 'SwitchoverInstance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:SwitchoverInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateProjectConfig' => [ + 'summary' => 'This API updates the configuration of a data migration or data synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100 '."\n" - .'- Default value: 10 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], [ - 'name' => 'PageNumber', + 'name' => 'CommonTransferConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Advanced settings.', + 'title' => 'Advanced configuration', + 'type' => 'object', + 'properties' => [ + 'SinkStoreFormat' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'SourceStoreFormat' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '1', + 'example' => '', ], ], [ - 'name' => 'FilterCondition', + 'name' => 'FullTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The filter condition. '."\n" - .'>
- All fields in OceanBase Database support filtering.
- You can write the key-value pair of a parameter in a JSON string in the JSON format to filter the parameter. ', + 'title' => '', + 'description' => 'The settings for full data transfer.', 'type' => 'object', - 'required' => false, - 'enumValueTitles' => [ - 'UserName' => 'UserName', - 'Event' => 'Event', - 'SQLType' => 'SQLType', - 'ClientIp' => 'ClientIp', + 'properties' => [ + 'WriteWorkerNum' => ['description' => 'The write concurrency.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '64'], + 'ReadWorkerNum' => ['description' => 'The read concurrency.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '64'], + 'ThrottleRps' => ['description' => 'The maximum transfer rate for the full data transfer phase, in records per second (RPS). If you set this parameter to `null`, the RPS is not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'The maximum I/O operations per second (IOPS) for the full data transfer phase. If you set this parameter to `null`, the IOPS are not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'MaxConcurrentIndexDDLs' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'IndexDDLConcurrencyLimit' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - 'example' => '{'."\n" - .' "UserName":testUser'."\n" - .'}', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'SortColumn', + 'name' => 'IncrTransferConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '排序列', - 'description' => 'The sorted column. ', - 'type' => 'string', + 'title' => '', + 'description' => 'The settings for incremental data transfer.', + 'type' => 'object', + 'properties' => [ + 'IncrSyncThreadCount' => ['description' => 'The number of threads for incremental data transfer.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '64'], + 'ThrottleRps' => ['description' => 'The maximum transfer rate for the incremental data transfer phase, in records per second (RPS). If you set this parameter to `null`, the RPS is not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'The maximum I/O operations per second (IOPS) for the incremental data transfer phase. If you set this parameter to `null`, the IOPS are not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'RecordTypeWhiteList' => [ + 'title' => '', + 'description' => 'The types of incremental data to synchronize during the incremental data transfer phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'A type of incremental data to synchronize.', + 'type' => 'string', + 'example' => 'INSERT', + 'enum' => ['HEARTBEAT', 'INSERT', 'UPDATE', 'DELETE', 'BEGIN', 'COMMIT', 'ROLLBACK', 'DDL', 'ROW'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SupportDDLTypes' => [ + 'title' => '', + 'description' => 'The DDL types to synchronize during the incremental data transfer phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'A DDL type to synchronize.', + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => ['CREATE_TABLE', 'ALTER_TABLE', 'DROP_TABLE', 'RENAME_TABLE', 'TRUNCATE_TABLE', 'CREATE_INDEX', 'DROP_INDEX'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'cputime', + 'example' => '', ], ], [ - 'name' => 'SortOrder', + 'name' => 'ReverseIncrTransferConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '排序规则', - 'description' => 'The sorting rule. ', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '{ "dbname":test, "SQLType":null }' => '{ "dbname":test, "SQLType":null }', + 'title' => '', + 'description' => 'The settings for reverse incremental data transfer.', + 'type' => 'object', + 'properties' => [ + 'IncrSyncThreadCount' => ['description' => 'The number of threads for reverse incremental data transfer.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '64'], + 'ThrottleRps' => ['description' => 'The maximum transfer rate for the reverse incremental data transfer phase, in records per second (RPS). If you set this parameter to `null`, the RPS is not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'ThrottleIOPS' => ['description' => 'The maximum I/O operations per second (IOPS) for the reverse incremental data transfer phase. If you set this parameter to `null`, the IOPS are not limited.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => 'null'], + 'RecordTypeWhiteList' => [ + 'title' => '', + 'description' => 'The types of incremental data to synchronize during the reverse incremental data transfer phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'A type of incremental data to synchronize.', + 'type' => 'string', + 'example' => 'INSERT', + 'enum' => ['HEARTBEAT', 'INSERT', 'UPDATE', 'DELETE', 'BEGIN', 'COMMIT', 'ROLLBACK', 'DDL', 'ROW'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + 'SupportDDLTypes' => [ + 'title' => '', + 'description' => 'The DDL types to synchronize during the reverse incremental data transfer phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'A DDL type to synchronize.', + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => ['CREATE_TABLE', 'ALTER_TABLE', 'DROP_TABLE', 'RENAME_TABLE', 'TRUNCATE_TABLE', 'CREATE_INDEX', 'DROP_INDEX'], + 'required' => false, + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], ], - 'example' => 'desc', + 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language of the returned data. '."\n" - .'Default value: CN for a China site and EN for an International site. ', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', + 'title' => 'OmsApiReturnResult', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The error details.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'CM-RESOAT1111'."\n", 'title' => ''], + 'Level' => ['title' => 'FATAL, ERROR, WARNING, CRITICAL', 'description' => 'The severity level of the error. Valid values are FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'WARN'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], + 'ExtraContext' => [ + 'description' => 'The values for the placeholders in the Message parameter.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a single placeholder.', 'type' => 'any', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MessageMcmsKey' => ['description' => 'The key of the error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'MessageMcmsContext' => [ + 'description' => 'The values for the placeholders in the message template referenced by MessageMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a single placeholder in the message template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => 'The cause of the error.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsKey' => ['description' => 'The key of the error reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ReasonMcmsContext' => [ + 'description' => 'The values for the placeholders in the reason template referenced by ReasonMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a single placeholder in the reason template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Proposal' => ['description' => 'A suggested action to resolve the error.', 'type' => 'string', 'example' => '请联系管理员', 'title' => ''], + 'ProposalMcmsKey' => ['description' => 'The key of the suggestion message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ProposalMcmsContext' => [ + 'description' => 'The values for the placeholders in the suggestion template referenced by ProposalMcmsKey.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value for a single placeholder in the suggestion template.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UpstreamErrorDetail' => ['description' => 'The error details from an upstream service.', 'type' => 'any', 'example' => 'null', 'title' => ''], + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'INNER_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'A system error occurred.'], + 'Advice' => ['description' => 'A suggested action to resolve the error.', 'type' => 'string', 'title' => '', 'example' => 'Contact the administrator. '], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], + 'PageNumber' => ['title' => 'pageNumber', 'description' => 'The page number. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'pageSize', 'description' => 'The page size. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => 'TotalCount', 'description' => 'The total number of entries. Returned only for paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Cost' => ['description' => 'The request duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Data' => ['description' => 'The data returned by the request.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => '总数量', - 'description' => 'The total count. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'AnomalySQLList' => [ - 'title' => '可疑SQL列表', - 'description' => 'The list of suspicious SQL statements. ', - 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '返回数据序号', - 'description' => 'The sequence number of the returned SQL statement.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DiagnosisRule' => [ - 'title' => '诊断规则', - 'description' => 'The diagnostic rule.', - 'type' => 'string', - 'example' => 'Utilization above threshold', - ], - 'SQLText' => [ - 'title' => 'sql文本', - 'description' => 'The SQL text. ', - 'type' => 'string', - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], - 'Suggestion' => [ - 'title' => '建议', - 'description' => 'The suggestions. ', - 'type' => 'string', - 'example' => 'Check your business scenarios, data distribution changes, request surges, and execution plan changes.', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'database1', - ], - 'RequestTimeUTCString' => [ - 'title' => '请求时间（零时区）', - 'description' => 'The request time in UTC +0. ', - 'type' => 'string', - 'example' => '2022-01-11T07:08:00Z', - ], - 'CpuTime' => [ - 'title' => '平均CPU时间（ms）', - 'description' => 'The average CPU time, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.13', - ], - 'SQLId' => [ - 'title' => 'SQLID', - 'description' => 'SQLID.', - 'type' => 'string', - 'example' => '99E9D3BF****B486239E6C7BC79B****', - ], - 'Diagnosis' => [ - 'title' => '诊断信息', - 'description' => 'The diagnosis information. ', - 'type' => 'string', - 'example' => 'Total number of executions = 80199, Average CPU time = 6.8 ms, Overall CPU utilization = 87%', - ], - 'RequestTime' => [ - 'title' => '请求时间', - 'description' => 'The request time, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.00', - ], - 'Executions' => [ - 'title' => '执行次数', - 'description' => 'The number of executions. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89043', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The username. ', - 'type' => 'string', - 'example' => 'tester', - ], - ], - ], - ], - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"WARN\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"请联系管理员\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Update Job Configuration', + 'description' => 'This interface uses a full replacement update:'."\n" + ."\n" + .'- **Overwrite all:** When you call this interface, you must provide a complete configuration set.'."\n" + ."\n" + .'- **Omitted items are deleted:** The system deletes any existing configuration item not included in the new configuration set.'."\n" + ."\n" + .'- **Existing items updated:** The system replaces the values of existing configuration items with the new values you provide.', + 'changeSet' => [ + ['createdAt' => '2024-10-17T02:36:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-26T06:28:48.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.ap-southeast-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.ap-southeast-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.ap-southeast-3.aliyuncs.com', 'endpoint' => 'oceanbasepro.ap-southeast-3.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.ap-southeast-5.aliyuncs.com', 'endpoint' => 'oceanbasepro.ap-southeast-5.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-beijing.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-beijing.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-hangzhou.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-hangzhou.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-hongkong.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-hongkong.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-qingdao.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-qingdao.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-shanghai.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-shanghai.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-shenzhen.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-shenzhen.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oceanbasepro.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oceanbasepro.us-west-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.us-west-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oceanbasepro.us-east-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.us-east-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oceanbasepro.eu-central-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.eu-central-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'oceanbasepro.me-central-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.me-central-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oceanbasepro.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oceanbasepro.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oceanbasepro.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oceanbasepro.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'oceanbasepro.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'oceanbasepro-vpc.cn-beijing-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Code', 'message' => 'Message.', 'http_code' => 200, 'description' => 'No permission'], + ['code' => 'E001R000', 'message' => 'A server error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'Instance.Order.CreateFailed', 'message' => 'Failed to create instance order', 'http_code' => 200, 'description' => ''], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnknownError', 'message' => 'Unknown Error', 'http_code' => 500, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2026-05-21T10:21:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2026-05-21T10:21:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackupSetDownloadLink'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeProxyService'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2026-02-11T03:27:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackupSetDownloadLink'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeProxyService'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2026-01-16T07:29:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackupSetDownloadLink'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeProxyService'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2026-01-16T07:29:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceSSL'], + ], + 'createdAt' => '2025-10-21T14:03:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOasAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSlowSQLList'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeOasSQLPlans'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasTopSQLList'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeOutlineBinding'], + ], + 'createdAt' => '2025-09-23T12:31:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateBackupSetDownloadLink'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProxyService'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTenantMetrics'], + ], + 'createdAt' => '2025-08-05T16:00:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOasAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProcessStatsComposition'], + ], + 'createdAt' => '2025-07-11T06:42:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ], + 'createdAt' => '2025-07-09T06:07:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOasAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSlowSQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSQLHistoryList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasTopSQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProcessStatsComposition'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSampleSqlRawTexts'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLTuningAdvices'], + ], + 'createdAt' => '2025-07-08T12:09:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricsData'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeSqlAuditStat'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenants'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTenantResource'], + ], + 'createdAt' => '2025-07-03T13:55:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2025-06-05T16:12:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchKillProcessList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDataBackupSet'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSQLPlans'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeOasTopSQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOutlineBinding'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeProcessStatsComposition'], + ], + 'createdAt' => '2025-04-22T14:07:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProjectModifyRecords'], + ], + 'createdAt' => '2025-04-01T06:47:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTenantUser'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceCreatableZone'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstanceSSL'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenantUsers'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyInstanceSSL'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTenantUserRoles'], + ], + 'createdAt' => '2025-02-13T13:02:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceSSL'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceSummary'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSQLHistoryList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeParametersHistory'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSampleSqlRawTexts'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2024-10-29T14:01:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ['description' => 'Request parameters changed', 'api' => 'CreateProjectModifyRecords'], + ['description' => 'Request parameters changed', 'api' => 'UpdateProjectConfig'], + ], + 'createdAt' => '2024-10-17T02:37:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeInstance'], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], + 'createdAt' => '2024-09-19T11:03:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeRestorableTenants'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AnomalySQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"DiagnosisRule\\": \\"全表扫描有索引未用\\",\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"Suggestion\\": \\"请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况\\",\\n \\"DbName\\": \\"database1\\",\\n \\"RequestTimeUTCString\\": \\"2022-01-11T07:08:00Z\\",\\n \\"CpuTime\\": 50.13,\\n \\"SQLId\\": \\"99E9D3BF****B486239E6C7BC79B****\\",\\n \\"Diagnosis\\": \\"全表扫描有索引未用\\",\\n \\"RequestTime\\": 50,\\n \\"Executions\\": 89043,\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 1\\n 整体占比超过百分比\\n SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\n 请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况\\n database1\\n 2022-01-11T07:08:00Z\\n 99E9D3BF****B486239E6C7BC79B****\\n 总执行次数=80199,平均CPU耗时=6.8毫秒,整体CPU消耗占比87%\\n 1641884880000\\n 89043\\n tester\\n \\n","errorExample":""}]', - 'title' => 'DescribeAnomalySQLList', + 'createdAt' => '2024-09-02T02:47:33.000Z', + 'description' => '', ], - 'DescribeSQLDetails' => [ - 'summary' => 'You can call this operation to query the SQL text of an SQL statement based on the SQL ID. ', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-08-19T06:11:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeTenantMetrics'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-08-16T03:49:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Request parameters changed', 'api' => 'DescribeOasSQLDetails'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSQLPlans'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTenantMetrics'], + ], + 'createdAt' => '2024-08-15T13:02:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2024-08-01T13:31:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + 'createdAt' => '2024-07-16T11:28:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ], + 'createdAt' => '2024-07-04T06:32:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateMySqlDataSource'], + ], + 'createdAt' => '2024-06-26T06:30:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProject'], + ['description' => 'Request parameters changed', 'api' => 'UpdateProjectConfig'], + ], + 'createdAt' => '2024-06-26T06:29:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTag'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTagValue'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteTag'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteTagValue'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSlowSQLList'], + ], + 'createdAt' => '2024-06-06T11:31:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeProcessStatsComposition'], + ], + 'createdAt' => '2024-05-27T11:47:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenant'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeAvailableZone'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricsData'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSlowSQLList'], + ['description' => 'Request parameters changed', 'api' => 'DescribeOasSQLPlans'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasTopSQLList'], + ], + 'createdAt' => '2024-04-15T11:48:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProject'], + ], + 'createdAt' => '2024-04-08T12:03:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProject'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListProjects'], + ], + 'createdAt' => '2024-03-20T02:09:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableCpuResource'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDataBackupSet'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOasSQLHistoryList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenants'], + ], + 'createdAt' => '2024-02-02T12:40:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ], + 'createdAt' => '2024-01-10T06:43:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ], + 'createdAt' => '2024-01-09T07:07:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'DeleteOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'DescribeOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'DescribeOmsOpenAPIProjectSteps'], + ['description' => 'Request parameters changed', 'api' => 'ReleaseOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'ResetOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'ResumeOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'SearchOmsOpenAPIMonitorMetric'], + ['description' => 'Request parameters changed', 'api' => 'StartOmsOpenAPIProject'], + ['description' => 'Request parameters changed', 'api' => 'StopOmsOpenAPIProject'], + ], + 'createdAt' => '2024-01-02T03:59:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Response parameters changed', 'api' => 'CreateTenantUser'], + ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableSpec'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeMetricsData'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], + ], + 'createdAt' => '2023-12-27T07:18:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ], + 'createdAt' => '2023-12-11T13:14:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], + ], + 'createdAt' => '2023-12-07T09:37:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenant'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ], + 'createdAt' => '2023-11-20T11:34:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableSpec'], + ], + 'createdAt' => '2023-11-07T07:39:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenant'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableMemResource'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDatabases'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstanceSecurityConfigs'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLSamples'], + ], + 'createdAt' => '2023-10-30T13:54:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2023-08-25T09:01:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2023-08-22T09:21:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2023-08-09T02:30:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2023-07-13T11:21:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDatabase'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenantReadOnlyConnection'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTenantUser'], + ['description' => 'Error codes changed', 'api' => 'DeleteInstances'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAnomalySQLList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableCpuResource'], + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'DescribeDatabases'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2023-07-04T02:58:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeCharset'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOutlineBinding'], + ['description' => 'Response parameters changed', 'api' => 'DescribeParameters'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTenantUserPassword'], + ], + 'createdAt' => '2023-05-17T02:27:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2023-05-09T06:36:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifyInstanceNodeNum'], + ['description' => 'Error codes changed', 'api' => 'ModifyInstanceSpec'], + ], + 'createdAt' => '2023-05-09T03:02:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2023-04-11T03:00:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTenantUser'], + ], + 'createdAt' => '2023-04-06T10:08:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2023-03-24T08:24:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ModifyInstanceSpec'], + ], + 'createdAt' => '2023-03-24T08:21:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2023-03-24T08:20:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSlowSQLHistoryList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ], + 'createdAt' => '2022-12-01T06:09:36.000Z', + 'description' => '202211迭代', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2022-11-15T03:15:35.000Z', + 'description' => 'CreateInstance接口出参结构变更Array->Object原版SDK调试代码变更，增加endpoint，无需手动设置', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDatabase'], + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeCharset'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDatabases'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTopology'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenant'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenants'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTenantPrimaryZone'], + ], + 'createdAt' => '2022-09-28T06:07:59.000Z', + 'description' => '公有云8月迭代', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsOpenAPIProjectSteps'], + ['description' => 'OpenAPI offline', 'api' => 'ReleaseOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'ResetOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'ResumeOmsOpenAPIProject'], + ['description' => 'OpenAPI offline', 'api' => 'SearchOmsOpenAPIMonitorMetric'], + ['description' => 'OpenAPI offline', 'api' => 'SearchOmsOpenAPIProjects'], + ['description' => 'OpenAPI offline', 'api' => 'StartOmsOpenAPIProject'], + ], + 'createdAt' => '2022-08-19T09:19:59.000Z', + 'description' => '新增 OMS 同步项目管理的相关 OpenAPI 若干，包括创建项目、启动项目、暂停项目、恢复项目、重置项目、释放项目、删除项目、查询指定项目的项目详情、查询指定项目的步骤详情、查询指定项目的监控指标和模糊搜索项目', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceTenantModes'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTenantUsers'], + ], + 'createdAt' => '2022-08-16T02:17:00.000Z', + 'description' => '8月迭代API变更', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTenantReadOnlyConnection'], + ['description' => 'Response parameters changed', 'api' => 'DescribeAnomalySQLList'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeZones'], + ], + 'createdAt' => '2022-07-05T07:32:42.000Z', + 'description' => '新增部分API，对已发布API做部分调整', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateSecurityIpGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenant'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenantUser'], + ['description' => 'Request parameters changed', 'api' => 'DeleteSecurityIpGroup'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAvailableMemResource'], + ['description' => 'Request parameters changed', 'api' => 'DescribeNodeMetrics'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSecurityIpGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSlowSQLHistoryList'], + ], + 'createdAt' => '2022-05-17T08:15:45.000Z', + 'description' => '变更入参必填属性与文档必填属性保持一致', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOmsMysqlDataSource'], + ], + 'createdAt' => '2022-04-19T03:32:48.000Z', + 'description' => 'OceanBase数据传输服务发布MySQL数据源OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTenantUser'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSqlAudits'], + ], + 'createdAt' => '2022-03-25T03:48:15.000Z', + 'description' => '新增部分api，优化往期api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenant'], + ['description' => 'Response parameters changed', 'api' => 'DeleteTenants'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDatabases'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], + ['description' => 'Request parameters changed', 'api' => 'DescribeNodeMetrics'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeSQLHistoryList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSQLPlans'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeTenantMetrics'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTenants'], + ], + 'createdAt' => '2022-03-17T07:58:10.000Z', + 'description' => '完善出入参覆盖率', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2021-11-25T08:31:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2021-11-25T05:53:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ValidateOmsEndpointConnectionByIdV2'], + ['description' => 'Response parameters changed', 'api' => 'ValidateOmsEndpointConnectionByInfoV2'], + ], + 'createdAt' => '2021-11-03T13:44:29.000Z', + 'description' => '增加数据源测试返回信息', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOmsEndpointV2'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOmsEndpoints'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsEndpointsV2'], + ['description' => 'OpenAPI offline', 'api' => 'ListOmsKafkaEndpoints'], + ['description' => 'Response parameters changed', 'api' => 'ListOmsSyncProjects'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyOmsEndpointV2'], + ['description' => 'OpenAPI offline', 'api' => 'ValidateOmsEndpointConnectionByIdV2'], + ['description' => 'OpenAPI offline', 'api' => 'ValidateOmsEndpointConnectionByInfoV2'], + ], + 'createdAt' => '2021-11-03T13:44:26.000Z', + 'description' => 'OceanBase数据迁移传输服务服务升级上线。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTenantRestoreTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateTenants'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAvailableCpuResource'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeAvailableMemResource'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeBackupStrategy'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeInstance'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeInstanceTopology'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenant'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeTenants'], + ], + 'createdAt' => '2021-08-19T11:05:17.000Z', + 'description' => 'ob公有云7月迭代接口发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOmsEndpoint'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOmsObSyncDatahubProject'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMigrationWorkerInstances'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsEndpoints'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsMigrationMonitor'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeOmsSyncMonitor'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTenantMetrics'], + ['description' => 'OpenAPI offline', 'api' => 'ListOmsSyncProjects'], + ['description' => 'OpenAPI offline', 'api' => 'ListOmsSyncScenarios'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyOmsEndpoint'], + ], + 'createdAt' => '2021-07-01T05:16:42.000Z', + 'description' => 'OceanBase迁移服务数据同步发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetOdcInfo'], + ], + 'createdAt' => '2021-05-13T14:02:41.000Z', + 'description' => 'ODC2.4.1进行公有云上线', + ], + ], + 'ram' => [ + 'productCode' => 'OceanBase', + 'productName' => 'ApsaraDB for OceanBase', + 'ramCodes' => ['oceanbase'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ModifyTenantEncryption', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantEncryption', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'The SQL text. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + [ + 'apiName' => 'CreateTag', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The name of the database. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeSQLDetails**. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'SQLDetails' => [ - 'title' => 'SQL详情', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeSQLDetails'."\n" - .'&TenantId=t2mr3oae0****'."\n" - .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'SQLText' => [ - 'title' => 'SQL文本', - 'description' => '{"name":"DescribeSQLDetails","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeSQLDetails\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"t2mr3oae0****\\"},{\\"name\\":\\"SQLId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"SQLID\\",\\"description\\":\\"SQLID。\\",\\"example\\":\\"8D6E84****0B8FB1823D199E2CA1****\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"},{\\"name\\":\\"SQLDetails\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Array\\",\\"subType\\":\\"Object\\",\\"description\\":\\" \\",\\"children\\":[{\\"name\\":\\"SQLText\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\"},{\\"name\\":\\"DbName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"testdb\\"},{\\"name\\":\\"UserName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tester\\"}],\\"title\\":\\"\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', - 'type' => 'string', - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => '', - 'type' => 'string', - 'example' => 'testdb', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => '', - 'type' => 'string', - 'example' => 'tester', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteTenantSecurityIpGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSlowSQLList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSlowSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSQLSamples', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLSamples', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLDetails\\": [\\n {\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\n testdb\\n tester\\n \\n","errorExample":""}]', - 'title' => 'DescribeSQLDetails', - ], - 'DescribeSQLPlans' => [ - 'summary' => 'You can call this operation to query the information about the SQL execution plans stored in the diagnostic system based on an SQL ID. ', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeSecurityIpGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSecurityIpGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeTenantUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeProxyService', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProxyService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeOasTopSQLList', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasTopSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + [ + 'apiName' => 'ModifyTagValueName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTagValueName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + [ + 'apiName' => 'DescribeSqlAuditStat', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSqlAuditStat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'SQLPlans' => [ - 'title' => '执行计划信息', - 'description' => 'The information about the execution plan. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the execution plan. ', - 'type' => 'object', - 'properties' => [ - 'HitCount' => [ - 'title' => '命中次数', - 'description' => 'The number of hits. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'OutlineData' => [ - 'title' => 'Outline数据', - 'description' => 'The outline data. ', - 'type' => 'string', - 'example' => '/*+ BEGIN_OUTLINE_DATA FULL(@\\"SEL$1\\" \\"testdb1.bmsql_order_line\\"@\\"SEL$1\\") END_OUTLINE_DATA*/', - ], - 'AvgExecutionMS' => [ - 'title' => '平均执行时间 (ms)', - 'description' => 'The average execution duration, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'PlanUnionHash' => [ - 'title' => 'SQL执行计划在诊断系统内部的唯一标识', - 'description' => 'The unique identifier of the SQL execution plan in the diagnostic system. ', - 'type' => 'string', - 'example' => '859ef7ee****b23ac98cdeb2476f****', - ], - 'OutlineId' => [ - 'title' => 'OutlineID', - 'description' => 'OutlineID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'AvgExecutionTimeMS' => [ - 'title' => '平均执行时间', - 'description' => 'The average execution duration when the database uses this execution plan, in ms. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '288', - ], - 'PlanId' => [ - 'title' => 'SQL执行计划在数据库内部的ID', - 'description' => 'The ID of the SQL execution plan in the database. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9114', - ], - 'OutlineTime' => [ - 'title' => '绑定时间', - 'description' => 'The time when the plan was bound. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641492303000', - ], - 'OutlineTimeUTCString' => [ - 'title' => '绑定时间(零时区)', - 'description' => 'The time when the plan was bound, in UTC +0. ', - 'type' => 'string', - 'example' => '2022-01-06T18:05:03Z', - ], - 'PlanFull' => [ - 'title' => 'SQL的完整执行计划', - 'description' => 'The complete execution plan of the SQL statement. ', - 'type' => 'string', - 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', - ], - 'NodeIp' => [ - 'title' => '节点ip', - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'example' => 'i-bp16niirq4zdmgvm****', - ], - 'MergedVersion' => [ - 'title' => '合并版本', - 'description' => 'The major compaction version. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '132', - ], - 'QuerySQL' => [ - 'title' => '查询sql', - 'description' => 'The query SQL statement. ', - 'type' => 'string', - 'example' => 'SELECT ol_i_id, ***, *** FROM aaa', - ], - 'FirstLoadTimeUTCString' => [ - 'title' => '首次加载时间(零时区)', - 'description' => 'The time when the plan was loaded for the first time, in UTC +0. ', - 'type' => 'string', - 'example' => '2022-01-06T18:05:03Z', - ], - 'FirstLoadTime' => [ - 'title' => '首次加载时间', - 'description' => 'The time when the plan was loaded for the first time, . ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641492303000', - ], - 'PlanInfo' => [ - 'title' => '计划信息', - 'description' => 'The information about the plan. ', - 'type' => 'string', - 'example' => 'PHY_TABLE_SCAN', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListProjectFullVerifyResult', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:ListProjectFullVerifyResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + [ + 'apiName' => 'DescribeNodeMetrics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeNodeMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SQLPlans\\": [\\n {\\n \\"HitCount\\": 3,\\n \\"OutlineData\\": \\"/*+ BEGIN_OUTLINE_DATA FULL(@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"testdb1.bmsql_order_line\\\\\\\\\\\\\\"@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\\\\\") END_OUTLINE_DATA*/\\",\\n \\"AvgExecutionMS\\": 1,\\n \\"PlanUnionHash\\": \\"859ef7ee****b23ac98cdeb2476f****\\",\\n \\"OutlineId\\": -1,\\n \\"AvgExecutionTimeMS\\": 288,\\n \\"PlanId\\": 9114,\\n \\"OutlineTime\\": 1641492303000,\\n \\"OutlineTimeUTCString\\": \\"2022-01-06T18:05:03Z\\",\\n \\"PlanFull\\": \\"PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\",\\n \\"NodeIp\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"MergedVersion\\": 132,\\n \\"QuerySQL\\": \\"SELECT ol_i_id, ***, *** FROM aaa\\",\\n \\"FirstLoadTimeUTCString\\": \\"2022-01-06T18:05:03Z\\",\\n \\"FirstLoadTime\\": 1641492303000,\\n \\"PlanInfo\\": \\"PHY_TABLE_SCAN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n 3\\n /*+ BEGIN_OUTLINE_DATA FULL(@\\\\\\"SEL$1\\\\\\" \\\\\\"testdb1.bmsql_order_line\\\\\\"@\\\\\\"SEL$1\\\\\\") END_OUTLINE_DATA*/\\n 1\\n 859ef7ee****b23ac98cdeb2476f****\\n -1\\n 288\\n 9114\\n 1641492303000\\n 2022-01-06T18:05:03Z\\n PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\n i-bp16niirq4zdmgvm****\\n 132\\n SELECT ol_i_id, ***, *** FROM aaa\\n 2022-01-06T18:05:03Z\\n 1641492303000\\n PHY_TABLE_SCAN\\n \\n","errorExample":""}]', - 'title' => 'DescribeSQLPlans', - ], - 'DescribeSQLHistoryList' => [ - 'summary' => 'You can call this operation to query the execution history of an SQL statement in a specified period based on an SQL ID. ', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'StopProjectModifyRecords', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StopProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ReleaseWorkerInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:ReleaseWorkerInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeInstanceTenantModes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTenantModes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', + [ + 'apiName' => 'ReleaseProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:ReleaseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + [ + 'apiName' => 'DeleteDataSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数历史查看的起始时间。', - 'description' => 'The start time of the time range for querying the SQL execution history. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', + ], + [ + 'apiName' => 'DescribeParameters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数历史查看的结束时间。', - 'description' => 'The end time of the time range for querying the SQL execution history. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13T15:40:43Z', + ], + [ + 'apiName' => 'CreateRdsPostgreSQLDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateRdsPostgreSQLDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + [ + 'apiName' => 'ModifyInstanceSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '页码', - 'description' => 'The page number. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ModifyTenantSecurityIpGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '每页数量', - 'description' => 'The number of entries returned on each page. '."\n" - .'Default value: 10. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DescribeInstanceCreatableZone', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceCreatableZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'SQLHistoryList' => [ - 'title' => 'SQL历史信息', - 'description' => 'The execution history of the SQL statement. ', - 'type' => 'object', - 'properties' => [ - 'List' => [ - 'title' => '列表', - 'description' => ' ', - 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'ExecPerSecond' => [ - 'title' => '每秒次数', - 'description' => 'The number of executions per second. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '163.0', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'description' => 'The maximum CPU time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '257.967', - ], - 'BlockCacheHit' => [ - 'title' => 'BlockCache命中次数', - 'description' => 'The number of block cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'DecodeTime' => [ - 'title' => '解码等待', - 'description' => 'The time to wait for decoding. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'RemotePlans' => [ - 'title' => '远程计划数', - 'description' => 'The number of remote plans. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RPCCount' => [ - 'title' => 'RPC次数', - 'description' => 'The number of RPCs. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetWaitTime' => [ - 'title' => '网络等待', - 'description' => 'The network latency. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'DiskRead' => [ - 'title' => '物理读', - 'description' => 'The number of physical reads. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NodeIp' => [ - 'title' => '节点IP', - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'example' => 'i-bp18qljorblo8es*****', - ], - 'ConcurrencyWaitTime' => [ - 'title' => '并发等待', - 'description' => 'The wait time in concurrent execution. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'testdb', - ], - 'MemstoreReadRowCount' => [ - 'title' => '读内存行数', - 'description' => 'The number of rows read from the memory. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '527', - ], - 'AppWaitTime' => [ - 'title' => '客户端等待', - 'description' => 'The wait time of the client. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'ElapsedTime' => [ - 'title' => '平均响应时间', - 'description' => 'The average response time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '76.382', - ], - 'MissPlans' => [ - 'title' => '未命中计划次数', - 'description' => 'The number of plan misses. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AffectedRows' => [ - 'title' => '影响行数', - 'description' => 'The number of rows affected. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ScheduleTime' => [ - 'title' => '调度时间', - 'description' => 'The scheduling duration. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'Event' => [ - 'title' => '等待事件', - 'description' => 'The wait event. ', - 'type' => 'string', - 'example' => 'mysql response wait client', - ], - 'TotalWaitTime' => [ - 'title' => '内部等待', - 'description' => 'The internal wait time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '10.966', - ], - 'ReturnRows' => [ - 'title' => '返回行数', - 'description' => 'The number of rows returned. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecuteTime' => [ - 'title' => '内部执行时间', - 'description' => 'The internal execution time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '61.044', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The username. ', - 'type' => 'string', - 'example' => 'tester', - ], - 'Executions' => [ - 'title' => '执行次数', - 'description' => 'The number of executions. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89403', - ], - 'GetPlanTime' => [ - 'title' => '硬解析时间', - 'description' => 'The time spent in hard parsing. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.052', - ], - 'CpuTime' => [ - 'title' => '平均CPU时间', - 'description' => 'The average CPU time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.13', - ], - 'MaxElapsedTime' => [ - 'title' => '最大响应时间', - 'description' => 'The maximum response time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '260.44', - ], - 'BlockIndexCacheHit' => [ - 'title' => 'BlockIndexCache命中次数', - 'description' => 'The number of block index cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'EndTimeUTCString' => [ - 'title' => '结束时间（零时区）', - 'description' => 'The end time in UTC +0. ', - 'type' => 'string', - 'example' => '2021-12-28T02:08:18Z', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => 'The end time. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-12-28T02:08:18Z', - ], - 'RetryCount' => [ - 'title' => '重试次数', - 'description' => 'The number of retries. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ClientIp' => [ - 'title' => '客户端IP', - 'description' => 'The IP address of the client. ', - 'type' => 'string', - 'example' => '1*2.***.1*3.***', - ], - 'BloomFilterCacheHit' => [ - 'title' => 'BloomFilterCache命中次数', - 'description' => 'The number of Bloom filter cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'IOWaitTime' => [ - 'title' => 'IO等待', - 'description' => 'The I/O wait time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'FailTimes' => [ - 'title' => '失败次数', - 'description' => 'The number of failures. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueTime' => [ - 'title' => '队列等待', - 'description' => 'The queuing time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '15.275', - ], - 'RowCacheHit' => [ - 'title' => 'RowCache命中次数', - 'description' => 'The number of row cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LogicalRead' => [ - 'title' => '逻辑读', - 'description' => 'The number of logical reads. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'SsstoreReadRowCount' => [ - 'title' => '读磁盘行数', - 'description' => 'The number of rows read from the disk. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43086', - ], - ], - ], - ], - 'Count' => [ - 'title' => '数量', - 'description' => 'The quantity. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], + [ + 'apiName' => 'ModifyInstanceNodeNum', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceNodeNum', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyTenantTags', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceSSL', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTagValue', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTagValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeOasSQLDetails', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeOasSQLHistoryList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLHistoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyTenantUserStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyTenantResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + [ + 'apiName' => 'DescribeOasSlowSQLList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSlowSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLHistoryList\\": {\\n \\"List\\": [\\n {\\n \\"ExecPerSecond\\": 163,\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"DbName\\": \\"testdb\\",\\n \\"MemstoreReadRowCount\\": 527,\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.44,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"EndTimeUTCString\\": \\"2021-12-28T02:08:18Z\\",\\n \\"EndTime\\": 0,\\n \\"RetryCount\\": 0,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ],\\n \\"Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n \\n 257.967\\n 14\\n 0\\n 0\\n 0\\n 0\\n 0\\n i-bp18qljorblo8es*****\\n 0\\n testdb\\n 527\\n 0\\n 76.382\\n 0\\n 0\\n 0\\n mysql response wait client\\n 10.966\\n 1\\n 61.044\\n tester\\n 89403\\n 0.052\\n 50.13\\n 260.44\\n 4\\n 2021-12-28T02:08:18Z\\n 0\\n 1*2.***.1*3.***\\n 0\\n 0\\n 0\\n 15.275\\n 0\\n 19\\n 43086\\n \\n 1\\n \\n","errorExample":""}]', - 'title' => 'DescribeSQLHistoryList', - ], - 'DescribeTopSQLList' => [ - 'summary' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system. ', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListProjectModifyRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:ListProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateBackupSetDownloadLink', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateBackupSetDownloadLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', + [ + 'apiName' => 'DescribeOutlineBinding', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOutlineBinding', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The average CPU time, in ms. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + [ + 'apiName' => 'DescribeDataBackupSet', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeDataBackupSet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '起始时间。', - 'description' => 'The maximum response time, in ms. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', + ], + [ + 'apiName' => 'DescribeInstanceSSL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间。', - 'description' => 'The SQL type. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13T15:40:43Z', + ], + [ + 'apiName' => 'CreateTenantUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称', - 'description' => 'The number of block index cache hits. ', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testdb', + ], + [ + 'apiName' => 'DeleteTag', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'formData', - 'schema' => [ - 'title' => '关键字查询', - 'description' => 'The number of retries. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', + ], + [ + 'apiName' => 'DescribeSessionList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSessionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchParameter', - 'in' => 'formData', - 'schema' => [ - 'title' => '参数查询', - 'description' => 'SQLID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', + ], + [ + 'apiName' => 'DeleteSecurityIpGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchRule', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询规则', - 'description' => 'The IP address of the client.', - 'type' => 'string', - 'required' => false, - 'example' => '>', + ], + [ + 'apiName' => 'CreateSecurityIpGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchValue', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询值', - 'description' => 'The number of Bloom filter cache hits.', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', + ], + [ + 'apiName' => 'DescribeRestorableTenants', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeRestorableTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQLID', - 'description' => 'The I/O wait time, in ms. ', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + [ + 'apiName' => 'DeleteTenantUsers', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenantUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NodeIp', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点ip', - 'description' => 'The number of failures. ', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp19y05uq6xpacyqnlrc', + ], + [ + 'apiName' => 'CreateTenant', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenant', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询的页码。 起始值：1 默认值：1', - 'description' => 'The queuing time, in ms. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeInstanceSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', - 'description' => 'The number of row cache hits. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyTenantUserDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FilterCondition', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The average number of logical reads of the SQL statement during the specified period of time. '."\n" - .'The value covers the numbers of reads of different caches and the number of disk I/Os. It is an important metric for measuring the SQL filtering performance. '."\n" - ."\n" - .'>
A higher ratio of the number of logical reads to the number of returned rows indicates poorer filtering performance. General causes include non-standard content written by SQL statements, non-standard table indexes created, and non-standard SQL execution plans. ', - 'type' => 'object', - 'required' => false, - 'example' => '[dbName:sys]', + ], + [ + 'apiName' => 'CreateTenantSecurityIpGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantSecurityIpGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortColumn', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序列', - 'description' => 'The number of rows read from the disk. ', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', + ], + [ + 'apiName' => 'DescribeAnomalySQLList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAnomalySQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortOrder', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序规则', - 'description' => 'The list of top SQL statements.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', + ], + [ + 'apiName' => 'DescribeDatabases', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system.', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => '总数量', - 'description' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Alibaba Cloud CLI', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'TopSQLList' => [ - 'title' => 'TOPSQL列表', - 'description' => 'The I/O wait time, in ms. ', - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the node. ', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '返回数据序号', - 'description' => 'The name of the database. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecPerSecond' => [ - 'title' => '每秒次数', - 'description' => 'The operation that you want to perform. '."\n" - .'Set the value to **DescribeTopSQLList**. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '163.0', - ], - 'SQLText' => [ - 'title' => 'sql文本', - 'description' => 'The list of top SQL statements. ', - 'type' => 'string', - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], - 'MaxCpuTime' => [ - 'title' => '最大CPU时间', - 'description' => 'SQLID.', - 'type' => 'number', - 'format' => 'float', - 'example' => '257.967', - ], - 'BlockCacheHit' => [ - 'title' => 'BlockCache命中次数', - 'description' => 'The average CPU time, in ms. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'DecodeTime' => [ - 'title' => '解码等待', - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100 '."\n" - .'- Default value: 10 ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'RemotePlans' => [ - 'title' => '远程计划数', - 'description' => 'The return result of the request. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RPCCount' => [ - 'title' => 'RPC次数', - 'description' => 'The start time of the time range for querying TOP SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetWaitTime' => [ - 'title' => '网络等待', - 'description' => 'The end time of the time range for querying TOP SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'DiskRead' => [ - 'title' => '物理读', - 'description' => 'The IP address of the client. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NodeIp' => [ - 'title' => '节点IP', - 'description' => 'The username. ', - 'type' => 'string', - 'example' => 'i-bp18qljorblo8es*****', - ], - 'ConcurrencyWaitTime' => [ - 'title' => '并发等待', - 'description' => 'The number of rows returned. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'MemstoreReadRowCount' => [ - 'title' => '读内存行数', - 'description' => 'The name of the database. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '527', - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => 'The number of remote plans. ', - 'type' => 'string', - 'example' => 'testdb', - ], - 'AppWaitTime' => [ - 'title' => '客户端等待', - 'description' => 'The wait time in concurrent execution, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'ElapsedTime' => [ - 'title' => '平均响应时间', - 'description' => 'The sorting rule. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '76.382', - ], - 'MissPlans' => [ - 'title' => '未命中计划次数', - 'description' => 'The total count. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AffectedRows' => [ - 'title' => '影响行数', - 'description' => 'The internal wait time, in ms. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ScheduleTime' => [ - 'title' => '调度时间', - 'description' => 'The search keyword. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'Event' => [ - 'title' => '等待事件', - 'description' => 'The number of rows read from the disk. ', - 'type' => 'string', - 'example' => 'mysql response wait client', - ], - 'TotalWaitTime' => [ - 'title' => '内部等待', - 'description' => '-', - 'type' => 'number', - 'format' => 'float', - 'example' => '10.966', - ], - 'ReturnRows' => [ - 'title' => '返回行数', - 'description' => 'The wait event. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecuteTime' => [ - 'title' => '内部执行时间', - 'description' => 'The number of rows read from the memory. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '61.044', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => 'The number of Bloom filter cache hits. ', - 'type' => 'string', - 'example' => 'tester', - ], - 'Executions' => [ - 'title' => '执行次数', - 'description' => 'The number of executions per second. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89403', - ], - 'GetPlanTime' => [ - 'title' => '硬解析时间', - 'description' => 'The queuing time, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.052', - ], - 'CpuTime' => [ - 'title' => '平均CPU时间', - 'description' => 'The maximum CPU time, in ms. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.13', - ], - 'MaxElapsedTime' => [ - 'title' => '最大响应时间', - 'description' => 'The sequence number of the returned SQL statement. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '260.044', - ], - 'SQLType' => [ - 'title' => 'sql类型', - 'description' => 'The request ID. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BlockIndexCacheHit' => [ - 'title' => 'BlockIndexCache命中次数', - 'description' => '$.parameters[16].schema.example', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'RetryCount' => [ - 'title' => '重试次数', - 'description' => '$.parameters[13].schema.description', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SQLId' => [ - 'title' => 'SQLID', - 'description' => '$.parameters[13].schema.example', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'ClientIp' => [ - 'title' => '客户端IP', - 'description' => '$.parameters[14].schema.description', - 'type' => 'string', - 'example' => '1*2.***.1*3.***', - ], - 'BloomFilterCacheHit' => [ - 'title' => 'BloomFilterCache命中次数', - 'description' => '$.parameters[14].schema.enumValueTitles', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'IOWaitTime' => [ - 'title' => 'IO等待', - 'description' => '$.parameters[15].schema.example', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'FailTimes' => [ - 'title' => '失败次数', - 'description' => '$.parameters[12].schema.description', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueTime' => [ - 'title' => '队列等待', - 'description' => '$.parameters[12].schema.enumValueTitles', - 'type' => 'number', - 'format' => 'float', - 'example' => '15.275', - ], - 'RowCacheHit' => [ - 'title' => 'RowCache命中次数', - 'description' => '```'."\n" - .'http(s)://[Endpoint]/?Action=DescribeTopSQLList'."\n" - .'&TenantId=t2mr3oae0****'."\n" - .'&StartTime=2021-06-13 15:40:43'."\n" - .'&EndTime=2021-09-13 15:40:43'."\n" - .'&DbName=testdb'."\n" - .'&SearchKeyWord=update'."\n" - .'&SearchParameter=cputime'."\n" - .'&SearchRule=>'."\n" - .'&SearchValue=0.01'."\n" - .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" - .'&NodeIp=i-bp19y05uq6xpacyqnlrc'."\n" - .'&PageNumber=1'."\n" - .'&PageSize=10'."\n" - .'&SortColumn=cputime'."\n" - .'&SortOrder=desc'."\n" - .'&Common request parameters'."\n" - .'```', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LogicalRead' => [ - 'title' => '逻辑读', - 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'SsstoreReadRowCount' => [ - 'title' => '读磁盘行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43086', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyTenantUserPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAvailableSpec', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAvailableSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeTenants', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeProjectSteps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProjectSteps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateOmsMysqlDataSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateOmsMysqlDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeTenant', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenant', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeProcessStatsComposition', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProcessStatsComposition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'StartProjectsByLabel', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StartProjectsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeOasSQLPlans', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasSQLPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeMetricsData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeMetricsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 2014 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + [ + 'apiName' => 'DescribeSampleSqlRawTexts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSampleSqlRawTexts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TopSQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"ExecPerSecond\\": 163,\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"DbName\\": \\"testdb\\",\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"SQLType\\": 1,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"RetryCount\\": 0,\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 1\\n 163\\n SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\n 257.967\\n 14\\n 0\\n 0\\n 0\\n 0\\n 0\\n i-bp18qljorblo8es*****\\n 0\\n 527\\n testdb\\n 0\\n 76.382\\n 0\\n 0\\n 0\\n mysql response wait client\\n 10.966\\n 1\\n 61.044\\n tester\\n 89403\\n 0.052\\n 50.13\\n 260.044\\n 1\\n 4\\n 0\\n 8D6E84****0B8FB1823D199E2CA1****\\n 1*2.***.1*3.***\\n 0\\n 0\\n 0\\n 15.275\\n 0\\n 19\\n 43086\\n \\n","errorExample":""}]', - 'title' => 'DescribeTopSQLList', - ], - 'DescribeSlowSQLList' => [ - 'summary' => 'You can call this operation to query the list of slow SQL statements ', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DescribeInstanceAvailableZones', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceAvailableZones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeTenantUserRoles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSlowSQLHistoryList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSlowSQLHistoryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeOasAnomalySQLList', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeOasAnomalySQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户ID', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't2mr3oae0****', + [ + 'apiName' => 'DescribeAvailableMemResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeAvailableMemResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'The start time of the time range for querying slow SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T15:40:43Z', + ], + [ + 'apiName' => 'ModifySecurityIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifySecurityIps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time of the time range for querying slow SQL statements. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-13T15:40:43Z', + ], + [ + 'apiName' => 'DeleteInstances', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*'], ], ], - [ - 'name' => 'DbName', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据库名称', - 'description' => 'The name of the database. ', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', + ], + [ + 'apiName' => 'ModifyInstanceName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}/*'], ], ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询关键字', - 'description' => 'The search keyword. ', - 'type' => 'string', - 'required' => false, - 'example' => 'update', + ], + [ + 'apiName' => 'DescribeTagValues', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTagValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchParameter', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询参数', - 'description' => 'The search parameter. ', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', + ], + [ + 'apiName' => 'ModifyTenantPrimaryZone', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantPrimaryZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchRule', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询规则', - 'description' => 'The search rule. ', - 'type' => 'string', - 'required' => false, - 'example' => '>', + ], + [ + 'apiName' => 'DescribeTenantEncryption', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantEncryption', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchValue', - 'in' => 'formData', - 'schema' => [ - 'title' => '查询值', - 'description' => 'The search value. ', - 'type' => 'string', - 'required' => false, - 'example' => '0.01', + ], + [ + 'apiName' => 'ModifyTagName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTagName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQL唯一标识', - 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', - 'type' => 'string', - 'required' => false, - 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + [ + 'apiName' => 'DescribeInstanceSecurityConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceSecurityConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NodeIp', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点ip', - 'description' => 'The IP address of the database node. ', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp18qljorblo8es*****', + ], + [ + 'apiName' => 'DescribeInstanceTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '页码', - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100 '."\n" - .'- Default value: 10 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DescribeTenantMetrics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '页大小', - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeSQLTuningAdvices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLTuningAdvices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FilterCondition', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The filter condition. ', - 'type' => 'object', - 'required' => false, - 'example' => '[dbName:sys]', + ], + [ + 'apiName' => 'DescribeTenantSecurityIpGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantSecurityIpGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortColumn', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序列', - 'description' => 'The sorted column. ', - 'type' => 'string', - 'required' => false, - 'example' => 'cputime', + ], + [ + 'apiName' => 'ModifyInstanceTags', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyInstanceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortOrder', - 'in' => 'formData', - 'schema' => [ - 'title' => '排序顺序', - 'description' => 'The sorting rule. ', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', + ], + [ + 'apiName' => 'DescribeTenantSecurityConfigs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantSecurityConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => '总数量', - 'description' => 'The total count. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'SlowSQLList' => [ - 'title' => '慢SQL列表信息', - 'description' => 'The list of slow SQL statements. ', - 'type' => 'array', - 'items' => [ - 'description' => ' ', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The sequence number of the returned SQL statement. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecPerSecond' => [ - 'description' => 'The number of executions per second. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '163.0', - ], - 'SQLText' => [ - 'description' => 'The SQL text. ', - 'type' => 'string', - 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', - ], - 'MaxCpuTime' => [ - 'description' => 'The maximum CPU time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '257.967', - ], - 'BlockCacheHit' => [ - 'description' => 'The number of block cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'DecodeTime' => [ - 'description' => 'The time to wait for decoding. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'RemotePlans' => [ - 'description' => 'The number of remote plans. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RPCCount' => [ - 'description' => 'The number of RPCs. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetWaitTime' => [ - 'description' => 'The network latency. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'DiskRead' => [ - 'description' => 'The number of physical reads. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NodeIp' => [ - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'example' => 'i-bp18qljorblo8es*****', - ], - 'ConcurrencyWaitTime' => [ - 'description' => 'The wait time in concurrent execution. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'MemstoreReadRowCount' => [ - 'description' => 'The number of rows read from the memory. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '527', - ], - 'DbName' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'testdb', - ], - 'AppWaitTime' => [ - 'description' => 'The wait time of the client. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'ElapsedTime' => [ - 'description' => 'The average response time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '76.382', - ], - 'MissPlans' => [ - 'description' => 'The number of plan misses. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AffectedRows' => [ - 'description' => 'The number of rows affected. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ScheduleTime' => [ - 'description' => 'The scheduling duration. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'Event' => [ - 'description' => 'The wait event. ', - 'type' => 'string', - 'example' => 'mysql response wait client', - ], - 'TotalWaitTime' => [ - 'description' => 'The internal wait time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '10.966', - ], - 'ReturnRows' => [ - 'description' => 'The number of rows returned. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecuteTime' => [ - 'description' => 'The internal execution time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '61.044', - ], - 'UserName' => [ - 'description' => 'The username. ', - 'type' => 'string', - 'example' => 'tester', - ], - 'Executions' => [ - 'description' => 'The number of executions. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89403', - ], - 'GetPlanTime' => [ - 'description' => 'The time spent in hard parsing. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.052', - ], - 'CpuTime' => [ - 'description' => 'The average CPU time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.13', - ], - 'MaxElapsedTime' => [ - 'description' => 'The maximum response time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '260.044', - ], - 'SQLType' => [ - 'description' => 'The SQL type. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BlockIndexCacheHit' => [ - 'description' => 'The number of block index cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'RetryCount' => [ - 'description' => 'The number of retries. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SQLId' => [ - 'description' => 'SQLID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client. ', - 'type' => 'string', - 'example' => '1*2.***.1*3.***', - ], - 'BloomFilterCacheHit' => [ - 'description' => 'The number of Bloom filter cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'IOWaitTime' => [ - 'description' => 'The I/O wait time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'FailTimes' => [ - 'description' => 'The number of failures. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueTime' => [ - 'description' => 'The queuing time. ', - 'type' => 'number', - 'format' => 'float', - 'example' => '15.275', - ], - 'RowCacheHit' => [ - 'description' => 'The number of row cache hits. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LogicalRead' => [ - 'description' => 'The number of logical reads. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'SsstoreReadRowCount' => [ - 'description' => 'The number of rows read from the disk. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43086', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeTenantTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTenantTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SlowSQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"ExecPerSecond\\": 163,\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"DbName\\": \\"testdb\\",\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"SQLType\\": 1,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"RetryCount\\": 0,\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 1\\n 163\\n SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\n 257.967\\n 14\\n 0\\n 0\\n 0\\n 0\\n 0\\n i-bp18qljorblo8es*****\\n 0\\n 527\\n testdb\\n 0\\n 76.382\\n 0\\n 0\\n 0\\n mysql response wait client\\n 10.966\\n 1\\n 61.044\\n tester\\n 89403\\n 0.052\\n 50.13\\n 260.044\\n 1\\n 4\\n 0\\n 8D6E84****0B8FB1823D199E2CA1****\\n 1*2.***.1*3.***\\n 0\\n 0\\n 0\\n 15.275\\n 0\\n 19\\n 43086\\n \\n","errorExample":""}]', - 'title' => 'DescribeSlowSQLList', - ], - 'DescribeSlowSQLHistoryList' => [ - 'summary' => 'You can call this operation to query the execution history of an SQL statement by SQL ID that is determined as a slow SQL statement during a specified period of time. ', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetUploadOssUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:GetUploadOssUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupSetDownloadLink', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeBackupSetDownloadLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDatabaseUserRoles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyDatabaseUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + [ + 'apiName' => 'CreateDatabase', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDatabases', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDatabaseDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyDatabaseDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SwitchoverInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:SwitchoverInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateTenantReadOnlyConnection', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTenantReadOnlyConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeParametersHistory', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeParametersHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'title' => '租户名', - 'description' => 'The ID of the tenant. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 't384tolsj****', + [ + 'apiName' => 'DeleteTenants', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'oceanbase:DeleteTenants', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'The start time of the time range for querying the execution history of the slow SQL statement. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-12-14T02:34:49Z', + ], + [ + 'apiName' => 'ModifyTenantUserRoles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyTenantUserRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time of the time range for querying the execution history of the slow SQL statement. '."\n" - .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-12-14T08:34:49Z', + ], + [ + 'apiName' => 'DescribeSQLPlans', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SQLId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'SQL唯一标识', - 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8D6E84735C0****1823D199E2CA1****', + ], + [ + 'apiName' => 'CancelProjectModifyRecord', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:CancelProjectModifyRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return. '."\n" - .'- Start value: 1 '."\n" - .'- Default value: 1 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeInstanceTopology', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeInstanceTopology', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of rows to return on each page. '."\n" - .'- Maximum value: 100 '."\n" - .'- Default value: 10 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DescribeTopSQLList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeTopSQLList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request. ', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'SlowSQLHistoryList' => [ - 'title' => '慢SQL历史列表', - 'description' => 'The execution history of the slow SQL statement. ', - 'type' => 'object', - 'properties' => [ - 'List' => [ - 'description' => 'The return result of the request.', - 'type' => 'array', - 'items' => [ - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'SqlId' => [ - 'description' => 'SQLID.', - 'type' => 'string', - 'example' => '8D6E84****0B8FB1823D199E2CA1****', - ], - 'SqlType' => [ - 'description' => 'The SQL type. ', - 'type' => 'string', - 'example' => '1', - ], - 'TenantName' => [ - 'description' => 'The name of the tenant. ', - 'type' => 'string', - 'example' => 'pay_online', - ], - 'UserName' => [ - 'description' => 'The username. ', - 'type' => 'string', - 'example' => 'tester', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client. ', - 'type' => 'string', - 'example' => '1*2.***.1*3.***', - ], - 'DbName' => [ - 'description' => 'The name of the database. ', - 'type' => 'string', - 'example' => 'testdb', - ], - 'Event' => [ - 'description' => 'The wait event. ', - 'type' => 'string', - 'example' => 'mysql response wait client', - ], - 'NodeIp' => [ - 'description' => 'The IP address of the node. ', - 'type' => 'string', - 'example' => 'i-bp18qljorblo8es*****', - ], - 'AffectedRows' => [ - 'description' => 'The number of rows affected. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'BlockCacheHit' => [ - 'description' => 'The number of block cache hits. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '14', - ], - 'BlockIndexCacheHit' => [ - 'description' => 'The number of block index cache hits. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'BloomFilterCacheHit' => [ - 'description' => 'The number of Bloom filter cache hits. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'Executions' => [ - 'description' => 'The number of executions. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '89403', - ], - 'FailTimes' => [ - 'description' => 'The number of failures. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RPCCount' => [ - 'description' => 'The number of RPCs. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemotePlans' => [ - 'description' => 'The number of remote plans. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MissPlans' => [ - 'description' => 'The number of plan misses. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'ReturnRows' => [ - 'description' => 'The number of rows returned. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'LogicalRead' => [ - 'description' => 'The number of logical reads. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '19', - ], - 'RetryCount' => [ - 'description' => 'The number of retries. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RowCacheHit' => [ - 'description' => 'The number of row cache hits. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DiskRead' => [ - 'description' => 'The number of physical reads. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'MemstoreReadRowCount' => [ - 'description' => 'The number of rows read from the memory. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '527', - ], - 'SsstoreReadRowCount' => [ - 'description' => 'The number of rows read from the disk. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '43086', - ], - 'ExecPerSecond' => [ - 'description' => 'The number of executions per second. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '163.0', - ], - 'AppWaitTime' => [ - 'description' => 'The wait time of the client. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'ElapsedTime' => [ - 'description' => 'The average response time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '76.382', - ], - 'ExecuteTime' => [ - 'description' => 'The internal execution time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '61.044', - ], - 'QueueTime' => [ - 'description' => 'The queuing time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '15.275', - ], - 'ConcurrencyWaitTime' => [ - 'description' => 'The wait time in concurrent execution. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'CpuTime' => [ - 'description' => 'The average CPU time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '50.13', - ], - 'DecodeTime' => [ - 'description' => 'The time to wait for decoding. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'NetWaitTime' => [ - 'description' => 'The wait time for network.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'IOWaitTime' => [ - 'description' => 'The I/O wait time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'GetPlanTime' => [ - 'description' => 'Hard parsing time.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.052', - ], - 'MaxElapsedTime' => [ - 'description' => 'The maximum response time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '260.044', - ], - 'TotalWaitTime' => [ - 'description' => 'The internal wait time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '10.966', - ], - 'ScheduleTime' => [ - 'description' => 'The scheduling duration. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'MaxCpuTime' => [ - 'description' => 'The maximum CPU time. ', - 'type' => 'number', - 'format' => 'double', - 'example' => '257.967', - ], - 'EndTimeUTCString' => [ - 'description' => 'The end time. ', - 'type' => 'string', - 'example' => '2021-12-28T02:08:18Z', - ], - ], - ], - ], - 'Count' => [ - 'description' => 'The quantity. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeRecommendIndex', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeRecommendIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SlowSQLHistoryList\\": {\\n \\"List\\": [\\n {\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"SqlType\\": \\"1\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"UserName\\": \\"tester\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"AffectedRows\\": 0,\\n \\"BlockCacheHit\\": 14,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"BloomFilterCacheHit\\": 0,\\n \\"Executions\\": 89403,\\n \\"FailTimes\\": 0,\\n \\"RPCCount\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"ReturnRows\\": 1,\\n \\"LogicalRead\\": 19,\\n \\"RetryCount\\": 0,\\n \\"RowCacheHit\\": 0,\\n \\"DiskRead\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"SsstoreReadRowCount\\": 43086,\\n \\"ExecPerSecond\\": 163,\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"ExecuteTime\\": 61.044,\\n \\"QueueTime\\": 15.275,\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"CpuTime\\": 50.13,\\n \\"DecodeTime\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"GetPlanTime\\": 0.052,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"TotalWaitTime\\": 10.966,\\n \\"ScheduleTime\\": 0,\\n \\"MaxCpuTime\\": 257.967,\\n \\"EndTimeUTCString\\": \\"2021-12-28T02:08:18Z\\"\\n }\\n ],\\n \\"Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\n \\n \\n 8D6E84****0B8FB1823D199E2CA1****\\n 1\\n pay_online\\n tester\\n 1*2.***.1*3.***\\n testdb\\n mysql response wait client\\n i-bp18qljorblo8es*****\\n 0\\n 14\\n 4\\n 0\\n 89403\\n 0\\n 0\\n 0\\n 0\\n 1\\n 19\\n 0\\n 0\\n 0\\n 527\\n 43086\\n 163\\n 0\\n 76.382\\n 61.044\\n 15.275\\n 0\\n 50.13\\n 0\\n 0\\n 0\\n 0.052\\n 260.044\\n 10.966\\n 0\\n 257.967\\n 2021-12-28T02:08:18Z\\n \\n 1\\n \\n","errorExample":""}]', - 'title' => 'DescribeSlowSQLHistoryList', - ], - 'DescribeProxyService' => [ - 'summary' => 'You can call this operation to query proxy service information of OceanBase Database.', - 'methods' => [ - 'post', + [ + 'apiName' => 'StopProjectsByLabel', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:StopProjectsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RemoveStandbyInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:RemoveStandbyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RetryProjectModifyRecords', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:RetryProjectModifyRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeSQLDetails', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeSQLDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集群id', - 'description' => 'The ID of the OceanBase cluster. ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ob317v4uif****', + [ + 'apiName' => 'CreateTagValue', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'oceanbase:CreateTagValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '请求的返回结果', - 'description' => 'The return result of the request.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', - ], - 'Data' => [ - 'description' => 'The data list.', - 'type' => 'object', - 'properties' => [ - 'ProxyClusterId' => [ - 'title' => '代理集群id', - 'description' => 'The ID of the proxy cluster.', - 'type' => 'string', - 'example' => 'proxy-3t****zrieasg', - ], - 'ProxyMode' => [ - 'title' => '代理模式', - 'description' => 'The proxy mode.', - 'type' => 'string', - 'example' => 'shared', - ], - 'Zone' => [ - 'title' => '可用区', - 'description' => 'The zone.', - 'type' => 'string', - 'example' => 'cn-shanghai-e,cn-shanghai-f', - ], - 'UnitSpec' => [ - 'title' => '单元规格', - 'description' => 'Thsa config.', - 'type' => 'string', - 'example' => '4C8GB', - ], - 'UnitNum' => [ - 'title' => '单元数量', - 'description' => 'The number of resource units in the tenant. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CurrentEndpointNum' => [ - 'title' => '当前地址数', - 'description' => 'The current number of endpoints.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'EndpointNumQuota' => [ - 'title' => '地址数量配额', - 'description' => 'The endpoint quota.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the proxy cluster was created.', - 'type' => 'string', - 'example' => '2023-07-05T08:23:10Z', - ], - 'Status' => [ - 'title' => '代理状态', - 'description' => 'The status of the proxy service.', - 'type' => 'string', - 'example' => 'ONLINE', - 'enum' => [ - 'ONLINE：运行中', - 'CREATING：创建中', - 'DELETING：关闭中', - 'DELETED：已关闭', - ], - ], - 'ProxyServiceVersion' => [ - 'title' => '代理服务版本', - 'description' => 'The version of the proxy service.', - 'type' => 'string', - 'example' => '1.0', - ], - 'ExpireTime' => [ - 'title' => '到期时间', - 'description' => 'The expiration time.', - 'type' => 'string', - 'example' => '2123-07-05T16:00:00', - ], - 'UnitNumLimit' => [ - 'title' => '单元数量上限', - 'description' => 'The maximum number of units.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'ProxyVersion' => [ - 'description' => 'The version of the database proxy.', - 'type' => 'string', - 'example' => '4.3.1.0-xxxxxxxxx', - ], - 'DeployMode' => [ - 'type' => 'string', - 'description' => 'Deployment mode.', - 'example' => 'share', - ], - 'ServerNumLimit' => [ - 'title' => '节点数量上限值', - 'description' => 'The maximum number of nodes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AllowModifyServerNum' => [ - 'title' => 'true：允许修改，且显示当前节点数量'."\n" - .'false：不允许修改，且不显示当前节点数量', - 'description' => 'Indicates whether the number of nodes can be changed. Valid values: `true` and `false`. The current number of nodes is displayed if the number of nodes can be changed, and is not displayed if otherwise.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SharedUnitNumLimit' => [ - 'title' => 'K8S 共享模式代理服务的单元数量上限', - 'description' => 'The maximum number of units of the proxy service in Kubernetes in shared mode.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExclusiveUnitNumLimit' => [ - 'title' => 'K8S 独占模式代理服务的单元数量上限', - 'description' => 'The maximum number of units of the proxy service in Kubernetes in exclusive mode.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], + [ + 'apiName' => 'ModifyParameters', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'oceanbase:ModifyParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeProjectStepMetric', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'oceanbase:DescribeProjectStepMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"ProxyClusterId\\": \\"proxy-3t****zrieasg\\",\\n \\"ProxyMode\\": \\"shared\\",\\n \\"Zone\\": \\"cn-shanghai-e,cn-shanghai-f\\",\\n \\"UnitSpec\\": \\"4C8GB\\",\\n \\"UnitNum\\": 1,\\n \\"CurrentEndpointNum\\": 1,\\n \\"EndpointNumQuota\\": 3,\\n \\"CreateTime\\": \\"2023-07-05T08:23:10Z\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"ProxyServiceVersion\\": \\"1.0\\",\\n \\"ExpireTime\\": \\"2123-07-05T16:00:00\\",\\n \\"UnitNumLimit\\": 4,\\n \\"ProxyVersion\\": \\"4.3.1.0-xxxxxxxxx\\",\\n \\"DeployMode\\": \\"\\",\\n \\"ServerNumLimit\\": 0,\\n \\"AllowModifyServerNum\\": true,\\n \\"SharedUnitNumLimit\\": 0,\\n \\"ExclusiveUnitNumLimit\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'DescribeProxyService', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'oceanbasepro.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'oceanbasepro.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'oceanbasepro.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'oceanbasepro.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'oceanbasepro.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'oceanbasepro.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'oceanbasepro.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'oceanbasepro.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'oceanbasepro.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'oceanbasepro.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'oceanbasepro.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'oceanbasepro.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'oceanbasepro.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'oceanbasepro.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'oceanbasepro.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'oceanbasepro.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'oceanbasepro.cn-beijing-finance-1.aliyuncs.com', ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'oceanbasepro.me-central-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:oceanbase:{#regionId}:{#accountId}:instance/*'], ], ], ]; -- cgit v1.2.3