'1.0', 'info' => ['style' => 'RPC', 'product' => 'OceanBasePro', 'version' => '2019-09-01'], 'directories' => [ [ 'children' => ['ModifyTagName'], 'type' => 'directory', 'title' => 'Tag management', ], [ 'children' => ['CreateInstance', 'DescribeInstance', 'DescribeInstances', 'DescribeInstanceTopology', 'DescribeAvailableSpec', 'DescribeAvailableZone', 'DescribeInstanceCreatableZone', 'ModifyInstanceSpec', 'ModifyInstanceTemporaryCapacity', 'RemoveStandbyInstance', 'DescribeStandbyCreateMode'], 'type' => 'directory', 'title' => 'Cluster management', ], [ 'children' => ['CreateTenantReadOnlyConnection', 'DescribeTenants', 'DescribeInstanceTenantModes', 'DescribeTenant', 'DescribeAvailableCpuResource', 'DescribeCharset', 'DescribeInstanceAvailableZones', 'DescribeTenantZonesRead', 'DescribeTimeZones', 'DescribeZones', 'ModifyTenantPrimaryZone', 'DeleteTenants'], 'type' => 'directory', 'title' => 'Tenant management', ], [ 'children' => ['CreateTenantUser', 'DescribeTenantUsers', 'ModifyTenantUserPassword', 'ModifyTenantUserRoles'], 'type' => 'directory', 'title' => 'Tenant account management', ], [ 'children' => ['CreateDatabase', 'ModifyDatabaseDescription', 'ModifyTenantUserStatus', 'ModifyDatabaseUserRoles', 'DeleteDatabases'], 'type' => 'directory', 'title' => 'Database management', ], [ 'children' => ['DescribeParameters', 'ModifyParameters'], 'type' => 'directory', 'title' => 'Parameter management', ], [ 'children' => ['BatchKillProcessList', 'DescribeProcessStatsComposition'], 'type' => 'directory', 'title' => 'Session connection', ], [ 'children' => ['DescribeOasAnomalySQLList', 'DescribeSampleSqlRawTexts', 'DescribeOasSQLDetails', 'DescribeOasSQLPlans', 'DescribeSQLSamples', 'DescribeOasTopSQLList', 'DescribeOasSlowSQLList', 'DescribeOutlineBinding', 'DescribeRecommendIndex', 'DescribeSQLTuningAdvices', 'DescribeSqlAuditStat', 'CreateOasOutlineTask'], 'type' => 'directory', 'title' => 'Diagnostics management', ], [ 'children' => ['ModifyInstanceSSL', 'DescribeInstanceSSL', 'CreateSecurityIpGroup', 'DescribeSecurityIpGroups', 'DescribeTenantEncryption', 'ModifySecurityIps', 'ModifyTenantEncryption', 'DeleteSecurityIpGroup', 'DescribeBackupEncryptedString'], 'type' => 'directory', 'title' => 'Security settings', ], [ 'children' => ['DescribeMetricsDataV2', 'DescribeMetricsData', 'DescribeNodeMetrics', 'DescribeTenantMetrics'], 'type' => 'directory', 'title' => 'Monitoring management', ], [ 'children' => [ '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', ], [ 'children' => ['DescribeBackupSetDownloadLink', 'DescribeDataBackupSet', 'CreateBackupSetDownloadLink', 'DescribeRestorableTenants'], 'type' => 'directory', 'title' => 'Backup and recovery', ], [ 'children' => ['DescribeAnomalySQLList', 'DescribeSQLDetails', 'DescribeSQLHistoryList', 'DescribeTopSQLList'], 'type' => 'directory', 'title' => 'Untranslated (other)', ], [ 'children' => ['DescribeProxyService', 'DescribeTenantAddressProxyInfo'], 'type' => 'directory', 'title' => 'Other', ], [ 'children' => [ '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' => [ 'BatchKillProcessList' => [ 'summary' => 'BatchKillProcessList', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], '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 sessions to close.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"ProxySessId":"752113700739156671","SessionId":3221555062,"ServerIp":"10.***.**.***"}] ', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', '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' => [ 200 => [ 'schema' => [ 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ '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' => [ 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 \\"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' => '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' => ''], ], [ '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' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', 'title' => 'BatchKillSessionList', 'changeSet' => [], 'ramActions' => [], ], 'CancelProjectModifyRecord' => [ 'summary' => 'This API cancels a modification by its record ID.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the modification record.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', 'description' => 'The response data.', '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' => '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'CreateBackupSetDownloadLink' => [ 'summary' => 'You can call this operation to create a backup set download link in OceanBase Database.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp67acfmxazb4p****'], ], [ 'name' => 'BackupSetId', 'in' => 'formData', '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' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'DatabaseName', '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' => 'sms_pre'], ], [ '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****'], ], [ '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'], ], [ 'name' => 'Collation', 'in' => 'formData', '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' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => 'The description of the database.', 'description' => 'The collation.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'ClientToken', 'in' => 'formData', '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' => [ 'title' => 'The ID of the OceanBase cluster.', 'description' => 'Example 1', 'type' => 'object', 'properties' => [ '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.', 'description' => ''], ], ], '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'], ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ '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, 'enumValueTitles' => ['PrePay' => 'PrePay', 'PostPay' => 'PostPay'], 'example' => 'PrePay', 'enum' => ['PrePay', 'PostPay'], ], ], [ 'name' => 'Series', 'in' => 'formData', 'schema' => [ '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' => true, 'docRequired' => true, 'example' => 'normal', 'enum' => ['normal', 'normal_ssd', 'history', 'normal_kv', 'normal_hg'], ], ], [ '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'], ], [ 'name' => 'InstanceClass', 'in' => 'formData', 'schema' => [ '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, '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' => 'DiskSize', 'in' => 'formData', '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'], ], [ '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'], ], [ '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'], ], [ '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' => '集群的存储类型。仅在标准集群版(云盘)下生效。当前支持两种类型:- 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'], ], ], [ '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' => '全功能型副本数。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' => '3', 'enum' => ['3', '2'], ], ], [ 'name' => 'IsolationOptimization', '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'], ], ], [ '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' => 'The return result of the request.', 'description' => 'The request ID. ', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => ''], ], 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/*'], ], ], ], ], ], 'CreateLabel' => [ 'summary' => 'This API creates a tag.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the label.', 'type' => 'string', 'required' => true, 'example' => 'test', '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 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 \\"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' => [], ], 'CreateMySqlDataSource' => [ 'summary' => 'Use this API to create a MySQL data source.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'example' => 'source_name'], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ '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, 'enum' => ['INTERNET', 'VPC', 'RDS', 'DG', 'POLARDB'], 'title' => '', 'example' => 'VPC', ], ], [ 'name' => 'VpcId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1d2q3mhg9i23ofi****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => false, 'example' => 'rm-t4****', 'title' => ''], ], [ 'name' => 'DgInstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the Database Gateway (DG) instance.', 'type' => 'string', 'required' => false, 'example' => 'dg-x****', 'title' => ''], ], [ 'name' => 'Ip', 'in' => 'formData', 'schema' => ['description' => 'The IP address of the database host.', 'type' => 'string', 'required' => false, 'example' => 'xxx.xxx.xxx.1', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'formData', 'schema' => ['description' => 'The port of the database host.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2883', 'title' => ''], ], [ 'name' => 'Schema', 'in' => 'formData', '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' => 'UserName', 'in' => 'formData', 'schema' => ['description' => 'The username of the database user for data migration or data synchronization.', 'type' => 'string', 'required' => true, 'example' => 'user_name', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded password for the database user.', 'type' => 'string', 'required' => true, 'example' => 'cGFzc193b3JK', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'A description for the data source, limited to 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'UseSsl', 'in' => 'formData', 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], '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' => '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' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', '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****', 'title' => ''], ], [ 'name' => 'SqlText', 'in' => 'formData', 'schema' => ['title' => '', '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' => '', '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' => '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'], ], 'example' => '', ], ], ], '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"}]', ], 'CreateOceanBaseDataSource' => [ 'summary' => 'This API creates an OceanBase data source.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ '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' => [ '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, 'title' => '', 'example' => 'OB_MYSQL_VPC', ], ], [ 'name' => 'Tenant', 'in' => 'formData', 'schema' => ['description' => 'The name of the OceanBase tenant.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tenant_name'], ], [ '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', 'additionalProperties' => ['description' => 'A key-value pair 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' => 'Populates placeholders in the message template identified by `MessageMcmsKey`.', 'type' => 'object', 'additionalProperties' => ['description' => 'A key-value pair for a placeholder in the localized message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'title' => '', 'example' => '', ], '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', 'additionalProperties' => ['description' => 'A key-value pair for a placeholder in the localized reason.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'title' => '', 'example' => '', ], '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', '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' => '[{"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' => [], ], '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' => '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' => true, 'docRequired' => true, 'example' => 'oms-mysql', 'enum' => [], ], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ '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' => true, 'docRequired' => true, 'example' => 'INTERNET', 'enum' => [], ], ], [ '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' => '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' => 'pc-12ab34cd56******', 'enum' => [], ], ], [ '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' => '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' => [ [ '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' => '', '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' => true, 'example' => 'MIGRATION', 'enum' => ['MIGRATION', 'SYNC'], ], ], [ 'name' => 'LabelIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => 'MIGRATION', ], ], [ 'name' => 'WorkerGradeId', 'in' => 'formData', '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***'], ], [ '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' => 'Mapping information of transfer objects.', 'type' => 'object', 'properties' => [ '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' => [ 'type' => 'object', 'properties' => [ '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' => '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' => '', ], 'ShardColumns' => [ 'title' => '', 'description' => '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 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' => ''], ], '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' => '', ], ], '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' => '', ], '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' => '', ], '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' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], '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' => [ 'PrimaryKeys' => [ 'description' => 'A collection of primary key columns. ', 'type' => 'array', 'items' => ['description' => 'Primary key column.', 'type' => 'string', 'required' => false, 'example' => '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\')'."\n", 'title' => ''], 'PartitionLifeCycle' => ['description' => 'Table lifecycle.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], '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' => [ '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\')'."\n", '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], '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' => '', ], ], [ 'name' => 'CommonTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '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' => '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'], ], 'required' => false, 'example' => '', ], ], [ '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' => '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' => '', ], ], [ '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' => '', 'description' => 'Configuration for incremental synchronization.', 'type' => 'object', 'properties' => [ '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' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ReverseIncrTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', 'description' => 'Return Result. ', 'type' => 'object', 'properties' => [ 'Success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true'], 'ErrorDetail' => [ 'title' => '', 'description' => 'Error Details. ', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => [], ], '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' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], [ 'name' => 'Databases', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '', ], ], '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' => '', ], ], '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' => '', ], ], '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' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'TransferMapping', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => [ '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', 'required' => false, 'example' => 'SPCEIFIC', 'enum' => ['SPECIFIC', 'WILDCARD', 'COMPLEX'], ], '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' => '', ], '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' => '', ], ], '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' => '', ], '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' => '', ], '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' => [ '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], ], 'required' => false, 'example' => '', ], ], ], '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 (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' => '', ], ], ], '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'], ], 'ramActions' => [], ], 'CreateRdsPostgreSQLDataSource' => [ 'summary' => 'Use this API to create an RDS PostgreSQL data source.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', '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' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'g_abcdefj***'."\n"], ], [ 'name' => 'DatabaseName', 'in' => 'formData', 'schema' => ['title' => 'Database Name', 'description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'db_name'], ], [ 'name' => 'UserName', 'in' => 'formData', 'schema' => ['description' => 'The name of the database user.', 'type' => 'string', 'required' => true, 'example' => 'user_name', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'formData', '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' => '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' => '', ], ], ], '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' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => 'Alibaba Cloud CLI', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'SecurityIps', 'in' => 'formData', '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' => 'SecurityIpGroupName', 'in' => 'formData', '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' => 'The information of the whitelist group. ', 'description' => 'The ID of the region. ', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'CreateTag' => [ 'methods' => ['post', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Key', 'in' => 'formData', 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], ], [ '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' => [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Value', 'in' => 'formData', 'schema' => ['description' => 'The name of the tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签 1', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'formData', 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 1', 'title' => ''], ], [ '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' => [ 'description' => 'The return result of the request.', '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' => ''], ], '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 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' => '*'], ], ], ], ], ], 'CreateTenant' => [ 'summary' => 'You can call this operation to create a tenant. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, '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' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'UserVpcId', 'in' => 'formData', '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' => 'UserVSwitchId', 'in' => 'formData', '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' => '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' => '创建租户时,初始化参数', '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' => 'The return result of the request.', 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'ZoneId', 'in' => 'formData', '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' => 'VpcId', 'in' => 'formData', 'schema' => ['description' => 'Virtual private cloud (VPC) ID.', 'title' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-bp1d2q3mhg9i23ofi****'], ], [ 'name' => 'VSwitchId', 'in' => 'formData', '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' => 'Return Result of the request.', 'type' => 'object', 'properties' => [ '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 \\"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'], ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], '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'], ], [ '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' => 'The returned result of the request.', 'type' => 'object', 'properties' => [ '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.***.*.*"]'], ], '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' => '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], '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 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' => '', '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' => 'OmsApiReturnResult', 'description' => 'The response payload.', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ErrorDetail' => [ 'title' => '', 'description' => 'Contains 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' => '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' => '', ], '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' => '', ], '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' => '', ], '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', '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' => '[{"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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => ' ', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ 'name' => 'DatabaseNames', 'in' => 'formData', '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' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Return result of the request.', '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' => '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'formData', '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' => 'BackupRetainMode', 'in' => 'formData', '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' => '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' => '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data migration or synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', 'description' => 'The response body.', '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 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' => '', ], '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' => '', ], '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' => '', ], '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' => '[{"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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', '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' => 'SecurityIpGroupName', 'in' => 'formData', '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' => 'The name of the deleted IP address whitelist group. ', 'description' => 'The request ID. ', 'type' => 'object', 'properties' => [ '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" .'```', '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' => '', ], ], ], '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 \\"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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Key', 'in' => 'formData', 'schema' => ['description' => 'The name of the tag group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '标签组 2', 'title' => ''], ], ], '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' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], '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' => '标签 2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], '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' => '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'], ], ], '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'], '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'], ], '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', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteTenantSecurityIpGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteTenantUsers' => [ 'summary' => 'You can call this operation to delete one or more database accounts. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], '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' => 't4pnum****'], ], [ 'name' => 'Users', 'in' => 'formData', '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' => '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'], ], '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-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' => '*'], ], ], ], ], ], 'DeleteTenants' => [ 'summary' => 'The request ID. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TenantIds', 'in' => 'formData', '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' => 'InstanceId', 'in' => 'formData', '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' => [ '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' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], 'TenantIds' => [ 'title' => '', 'description' => 'List of tenant IDs.', 'type' => 'array', 'items' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 'tjd3da45kc****', '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 \\"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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'obsd23j4f****'], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****'], ], [ 'name' => 'StartTime', 'in' => 'formData', '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' => 'EndTime', 'in' => 'formData', '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' => 'DbName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], [ 'name' => 'SearchKeyWord', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Keyword query.', 'type' => 'string', 'required' => false, 'example' => 'update'], ], [ 'name' => 'SearchParameter', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Parameter query.', 'type' => 'string', 'required' => false, 'example' => 'cputime'], ], [ 'name' => 'SearchRule', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Query rule. '."\n" .'Valid values of this parameter: “=”, “>”, “>=”, “<”, “<=”.', 'type' => 'string', 'required' => false, 'example' => '>'], ], [ 'name' => 'SearchValue', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Query value.', 'type' => 'string', 'required' => false, 'example' => '0.01'], ], [ 'name' => 'SQLId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], ], [ 'name' => 'NodeIp', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Node IP.', 'type' => 'string', 'required' => false, 'example' => 'i-bp19y05****pacyqnlrc'], ], [ 'name' => 'PageSize', 'in' => 'formData', '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' => 'PageNumber', 'in' => 'formData', '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' => 'FilterCondition', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => 'SortColumn', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Sort column.', 'type' => 'string', 'example' => 'cputime', 'required' => false], ], [ 'name' => 'SortOrder', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Sort order.', 'enumValueTitles' => ['{ "dbname":test, "SQLType":null }' => '{ "dbname":test, "SQLType":null }'], 'type' => 'string', 'example' => 'desc', 'required' => false, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'formData', '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 response.', 'type' => 'object', 'properties' => [ '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' => [ 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' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DescribeAvailableCpuResource' => [ 'summary' => 'The ID of the tenant. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', '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' => 'The request ID. ', 'description' => 'The operation that you want to perform. '."\n" .'Set the value to **DescribeAvailableCpuResource**. ', 'type' => 'string', 'required' => false, 'example' => 't4pnum**** '], ], [ 'name' => 'ModifyType', 'in' => 'formData', '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' => 'You can call this operation to query the CPU resources available for a tenant. ', 'type' => 'object', 'properties' => [ '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 \\"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' => [], ], ], '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 OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'TenantId', 'in' => 'formData', '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' => 'The return result of the request. ', 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'DescribeAvailableSpec' => [ 'summary' => 'Queries the available configurations for specification changes of an OceanBase cluster.', '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' => 'ob317v4uif****'], ], [ 'name' => 'UpgradeType', 'in' => 'formData', 'schema' => [ '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' => 'upgradespec', ], ], [ 'name' => 'Spec', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The node specifications.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The instance type.', 'enumValueTitles' => ['cluster' => 'cluster'], 'type' => 'string', 'required' => true, 'example' => 'cluster', ], ], [ 'name' => 'Series', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The series.', 'type' => 'string', 'example' => 'normal', 'required' => false], ], [ 'name' => 'DeployType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The deployment plan.', 'type' => 'string', 'example' => 'multiple', 'required' => false], ], [ 'name' => 'Spec', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The node plan.', 'type' => 'string', 'example' => 'oceanbase.cluster.cd8.xlarge', 'required' => false], ], [ 'name' => 'ObVersion', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The OceanBase version number.', 'type' => 'string', 'example' => '3.2.4.4', 'required' => false], ], [ 'name' => 'CpuArch', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The CPU architecture.', 'type' => 'string', 'required' => false, 'example' => 'x86'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', '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'], ], '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' => '', ], 'CpuArch' => ['title' => '', 'description' => 'The CPU architecture.', 'type' => 'string', 'example' => 'x86'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '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' => 'Query available configurations for cluster creation', 'changeSet' => [ ['createdAt' => '2024-04-15T11:26:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'ramActions' => [], ], 'DescribeBackupEncryptedString' => [ 'summary' => 'DescribeBackupEncryptedString', '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 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' => [ [ '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' => 'DownloadTaskId', 'in' => 'formData', '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' => '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 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' => '', ], ], ], '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' => '[{"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"}]', ], 'DescribeCharset' => [ 'summary' => 'Queries the character set information of an OceanBase tenant.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TenantMode', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The tenant mode.'."\n" .'Valid values: Oracle and MySQL. '."\n" .'For more information, see DescribeInstanceTenantModes.', 'type' => 'string', '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****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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 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' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], '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'], ], 'ramActions' => [], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', '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', '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' => [ 'description' => 'The return result of the request.', 'type' => 'object', 'properties' => [ '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.', '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' => '*'], ], ], ], ], ], 'DescribeDatabases' => [ 'summary' => 'You can call this operation to query databases in a tenant. ', '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' => false, 'docRequired' => true, 'example' => 't4pnum****'], ], [ 'name' => 'PageNumber', 'in' => 'formData', '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' => 'PageSize', 'in' => 'formData', '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' => 'DatabaseName', 'in' => 'formData', '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' => 'SearchKey', 'in' => 'formData', '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' => 'The return result of the request. ', 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'DescribeInstance' => [ 'summary' => 'Queries the details of an OceanBase cluster.', 'methods' => ['get', 'post'], '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' => 'PageNumber', 'in' => 'formData', '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'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'The return result of the request. ', 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ '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' => [ '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'], ], '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'], ], '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'], ], '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' => '', ], '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' => '', ], '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' => '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' => '', ], ], 'example' => '', ], ], ], '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}'], ], ], ], ], ], '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' => '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' => ''], ], ], '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', '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' => '', ], ], ], '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' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the zone. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'The return result of the request. ', 'description' => 'The list of zones. ', 'type' => 'object', 'properties' => [ '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.', 'description' => ''], ], ], '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'], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => 'OceanBase tenant ID', 'description' => 'The OceanBase tenant ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => [ [ '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' => [ [ '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' => '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' => '', '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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' => '', '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' => '', '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' => '', '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' => '', ], ], ], '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The list of cluster IDs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["ob3za5w73as8rk"]'], ], [ '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 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' => '', ], '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' => 'DescribeInstanceTags', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeInstanceTenantModes' => [ 'summary' => 'The return result of the request. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', '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' => 'The list of tenant modes. ', 'description' => 'Example 1', 'type' => 'object', 'properties' => [ '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 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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'DescribeInstanceTopology' => [ 'summary' => 'Query the topology information 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' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], 'InstanceTopology' => [ 'title' => '', 'description' => 'The topology of the cluster.', 'type' => 'object', 'properties' => [ 'Tenants' => [ 'title' => '', 'description' => 'The list of tenants.', 'type' => 'array', 'items' => [ 'description' => 'The details of a tenant.', 'type' => 'object', 'properties' => [ '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' => '', ], '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', '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' => '', ], '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' => '', ], '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' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'DescribeInstances' => [ 'summary' => 'Retrieves a list of OceanBase clusters.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ob317v4uif****'], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', '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' => 'PageSize', 'in' => 'formData', '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' => 'PageNumber', 'in' => 'formData', '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' => 'InstanceName', 'in' => 'formData', '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' => 'SearchKey', 'in' => 'formData', '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' => 'WithOBCloudInstances', 'in' => 'formData', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'The return result of the request. ', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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' => [ '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], ], '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'DescribeMetricsData' => [ 'summary' => 'This API retrieves single- or multi-dimensional monitoring metrics for an OceanBase cluster.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the OceanBase cluster.', 'type' => 'string', 'required' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ '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' => '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' => [ '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' => false, 'enum' => ['FULL', 'READONLY'], 'example' => 'FULL', 'title' => '', ], ], [ 'name' => 'MetricScope', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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' => '', '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' => '', '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' => [ 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.', 'title' => ''], 'example' => '', ], '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'], '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"}]', ], 'DescribeNodeMetrics' => [ 'summary' => 'The operation that you want to perform. '."\n" .'Set the value to **DescribeNodeMetrics**. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', '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' => 'The list of nodes. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The ID of the tenant. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => 'The request ID. ', 'description' => '$.parameters[6].schema.description', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => '$.parameters[6].schema.example', 'description' => '$.parameters[6].schema.enumValueTitles', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tfafd34fs****'], ], [ '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'], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['title' => '$.parameters[9].schema.enumValueTitles', 'description' => '$.parameters[7].schema.description', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-13T15:40:43Z'], ], [ 'name' => 'Metrics', 'in' => 'formData', 'schema' => ['title' => '$.parameters[7].schema.example', 'description' => '$.parameters[7].schema.enumValueTitles', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tps'], ], [ 'name' => 'NodeName', 'in' => 'formData', 'schema' => ['title' => '$.parameters[8].schema.description', 'description' => '$.parameters[8].schema.example', 'type' => 'string', 'required' => false, 'example' => 'i-bp16niirq4zdmgvm****'], ], [ 'name' => 'NodeIdList', 'in' => 'formData', 'schema' => ['title' => '$.parameters[8].schema.enumValueTitles', 'description' => '$.parameters[10].schema.description', 'type' => 'string', 'required' => false, 'example' => '[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '$.parameters[10].schema.example', 'description' => '$.parameters[10].schema.enumValueTitles', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the OceanBase instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', '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' => 'EndTime', 'in' => 'formData', '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' => 'DbName', 'in' => 'formData', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'db_****', 'title' => ''], ], [ 'name' => 'SearchKeyWord', 'in' => 'formData', 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'update', 'title' => ''], ], [ 'name' => 'SearchParam', 'in' => 'formData', 'schema' => ['description' => 'The performance metric to search by.', 'type' => 'string', 'required' => false, 'example' => 'cputime', 'title' => ''], ], [ 'name' => 'SearchRule', 'in' => 'formData', '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' => ['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 response to the request.', 'type' => 'object', 'properties' => [ 'Data' => [ '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' => '', ], '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' => '', ], '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' => ''], ], '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' => '', ], ], ], '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' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', '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****', 'title' => ''], ], [ 'name' => 'SqlId', 'in' => 'formData', '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' => ['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' => '', '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', '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****', 'title' => ''], ], [ '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', 'title' => ''], ], [ 'name' => 'EndTime', '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', 'title' => ''], ], [ 'name' => 'DbName', 'in' => 'formData', 'schema' => ['description' => 'The name of the database. ', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ 'name' => 'SqlId', 'in' => 'formData', 'schema' => ['description' => 'SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, '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' => 'AcceptLanguage', 'in' => 'formData', 'schema' => ['description' => 'The language of the response. Valid values:'."\n" .'- zh: Chinese'."\n" .'- en: English', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], [ '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' => [ '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' => [ [ '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****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', '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' => 'EndTime', 'in' => 'formData', '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' => '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' => 'AcceptLanguage', 'in' => 'formData', '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 SQL statement is a dynamic SQL.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'PlanUnionHash', 'in' => 'formData', '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' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ 'description' => 'A list of SQL execution plans.', 'type' => 'array', 'items' => [ 'description' => 'An SQL execution plan.', 'type' => 'object', 'properties' => [ '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 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' => '', ], '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' => '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' => '', ], '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' => '', ], '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\\": 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'], ], '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' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', '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' => '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' => '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' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ 'name' => 'NodeIp', 'in' => 'formData', 'schema' => ['description' => 'Database node IP address.', 'type' => 'string', 'required' => false, 'example' => 'i-bp18qljorblo8es*****', 'title' => ''], ], [ 'name' => 'FilterCondition', 'in' => 'formData', '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' => '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' => '', 'description' => 'Response to the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ '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'], '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' => '*'], ], ], ], ], ], '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' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'OceanBase cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob317v4uif****', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['description' => 'Tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't4louaeei****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', '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' => 'Database name.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ 'name' => 'SearchKeyWord', 'in' => 'formData', 'schema' => ['description' => 'Keyword query.', 'type' => 'string', 'required' => false, 'example' => 'update', 'title' => ''], ], [ 'name' => 'SearchParam', 'in' => 'formData', 'schema' => ['description' => 'Parameter query.', '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' => 'SQL ID.', 'type' => 'string', 'required' => false, 'example' => '8D6E84****0B8FB1823D199E2CA1****', 'title' => ''], ], [ 'name' => 'NodeIp', 'in' => 'formData', 'schema' => ['description' => 'Node IP.', 'type' => 'string', 'required' => false, 'example' => 'i-bp18l4****str4uk03', 'title' => ''], ], [ 'name' => 'FilterCondition', 'in' => 'formData', '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' => 'Language for returned information:'."\n" ."\n" .'- zh: Chinese'."\n" ."\n" .'- en: English', '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' => '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' => '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' => 'CustomColumns', 'in' => 'formData', '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' => 'Response to the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C'], 'Data' => [ 'description' => 'List of TopSQL information.', 'type' => 'array', 'items' => [ 'description' => 'TopSQL information.', 'type' => 'object', 'properties' => [ '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' => 'Response to the request.', 'type' => 'object', 'properties' => [ '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' => '', ], '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' => [ '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' => '', ], '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 \\"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'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't2mr3oae0****'], ], [ 'name' => 'TableName', '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. 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' => 'DatabaseName', 'in' => 'formData', 'schema' => ['title' => 'The name of the database.', 'description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb'], ], [ 'name' => 'SQLId', 'in' => 'formData', 'schema' => ['title' => 'SQLID', 'description' => 'The SQL ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8D6E84****0B8FB1823D199E2CA1****'], ], [ 'name' => 'IsConcurrentLimit', 'in' => 'formData', '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' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the OceanBase cluster. ', 'description' => 'The OceanBase instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ob317v4uif****'], ], [ 'name' => 'DynamicSql', 'in' => 'formData', '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' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'], 'Parameters' => [ 'title' => '', 'description' => 'The parameter list.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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' => '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' => '', ], 'AcceptableValue' => [ 'title' => '', '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' => '', ], ], ], '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 \\"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'], ], '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'], '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 type of the parameter. '."\n" .'Valid values: CLUSTER and TENANT. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TENANT'], ], [ 'name' => 'DimensionValue', 'in' => 'formData', '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' => 'StartTime', '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'], ], [ '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-13 15:40:43'], ], [ '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' => true, 'docRequired' => true, 'maximum' => '999999', 'minimum' => '1', 'example' => '10'], ], [ 'name' => 'PageNumber', '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' => true, 'docRequired' => true, 'maximum' => '999999', 'minimum' => '1', 'example' => '1'], ], ], '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'], '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' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], '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', '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'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the OceanBase cluster. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob********'], ], [ 'name' => 'UId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user identifier (UID) of the OceanBase database.', 'type' => 'string', 'required' => false, 'example' => '139*************'], ], [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the tenant. ', 'type' => 'string', 'required' => false, 'example' => 't********'], ], [ 'name' => 'SqlText', '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'], ], [ 'name' => 'ClientIp', 'in' => 'formData', 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '127.*.*.*', 'title' => ''], ], [ 'name' => 'ServerIp', 'in' => 'formData', 'schema' => ['description' => 'The IP address of the server.', 'type' => 'string', 'required' => false, 'example' => '127.*.*.*', 'title' => ''], ], [ 'name' => 'Users', 'in' => 'formData', 'schema' => ['description' => 'The username of the database.', 'type' => 'string', 'required' => false, 'example' => '["test_user"]', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => ['description' => 'The status of the session.', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE', 'title' => ''], ], [ 'name' => 'MergeDynamicSql', 'in' => 'formData', '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' => 'The return result of the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', 'title' => ''], 'Data' => [ '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' => '', 'example' => '', ], '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' => ''], ], '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' => ''], ], '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' => '', ], ], '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 \\"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'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data migration or data synchronization task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], ], '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.'."\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' => [ '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' => '', 'example' => '', ], 'example' => '', ], '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', 'title' => '', 'example' => 'OB_MYSQL', ], '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', ], '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', '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' => [ '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' => '', ], 'DistributedKeys' => [ 'description' => 'The distribution key column collection.', 'type' => 'array', 'items' => ['description' => 'The 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 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' => '', ], 'DistributedKeys' => [ 'description' => 'The distribution key column collection.', 'type' => 'array', 'items' => ['description' => 'The distribution key column.', 'type' => 'string', 'example' => 'col2', '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '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' => '', ], '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' => [ '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' => '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' => ''], ], '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' => [ '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' => '', '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' => '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' => '', ], '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' => '', ], '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' => '', ], ], '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' => [ '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' => ['description' => 'Zone accessible through the tenant connection.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'example' => '["cn-hangzhou-i", "cn-hangzhou-j"]', ], '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' => ['description' => 'Information about the logical zone where the endpoint resides.', 'type' => 'string', 'example' => 'cn-bejing-3-z0,cn-bejing-4-z0', 'title' => ''], 'title' => '', 'example' => '', ], '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' => [ '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' => ''], ], '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' => [ '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' => '', ], ], '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' => [ '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' => [ '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' => '', ], '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' => [ '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', ], 'Role' => [ 'description' => 'The data source role. Valid values: `MASTER` and `SLAVE`.', 'type' => 'string', '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' => '', ], ], [ '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' => '', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'description' => 'The status of the data migration task.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['RUNNING', 'ERROR', 'FINISHED', 'SUSPEND'], 'title' => '', 'required' => false, ], ], [ 'name' => 'PageNumber', 'in' => 'formData', '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' => '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', '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' => ''], ], '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' => '', ], ], '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\\",\\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', 'additionalProperties' => ['description' => 'The context 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' => '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' => '', ], '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' => '', ], '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' => '', ], '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' => ''], ], 'example' => '', ], 'Databases' => [ 'title' => '', 'description' => 'The removed objects (synchronization).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ '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' => '', 'title' => '', 'example' => '', ], 'example' => '', ], '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' => '', 'title' => '', 'example' => '', ], 'example' => '', ], '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' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], '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' => '', ], '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' => '', ], 'example' => '', ], 'Views' => [ 'title' => '', 'description' => 'The list of views 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' => 'view_name'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ViewsBlack' => [ 'title' => '', 'description' => 'The blacklist of views 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' => 'view_name'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], 'example' => '', ], 'ViewMappings' => [ 'title' => '', 'description' => 'The list of view mapping information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ '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' => '', ], 'TableEtlList' => [ 'title' => '', 'description' => 'The ETL information of removed objects (migration).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ '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' => '', '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' => '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' => '', ], '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' => [ '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' => '', ], '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', ], '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', ], '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', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], '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' => [ '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' => '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' => '', ], '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' => '', ], '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' => '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' => '', ], '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' => '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' => '', ], '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'], ], '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' => '', ], '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' => '', ], 'AlarmStats' => [ 'title' => '', 'description' => 'The alert statistics.', 'type' => 'object', 'properties' => [ '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' => '', ], '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' => [ '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', ], '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' => [ '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' => '', ], ], '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', ], ], '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' => '', ], ], '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' => '', ], ], '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' => [ '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' => ''], ], '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' => [ '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', 'enumValueTitles' => ['INTERNAL' => 'INTERNAL', 'USER_KMS' => 'USER_KMS'], 'example' => 'INTERNAL', '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 \\"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' => '*'], ], ], ], ], ], 'ModifyTenantPrimaryZone' => [ 'summary' => 'Alibaba Cloud CLI', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the tenant. ', 'description' => 'The return result of the request. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ob2mr3oae0****'], ], [ 'name' => 'InstanceId', 'in' => 'formData', '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' => ' ', 'description' => 'You can call this operation to switch the primary zone of the tenant. ', 'type' => 'object', 'properties' => [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], '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' => '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' => 'The return result of the request.', 'description' => 'The return result of the request. ', 'type' => 'object', 'properties' => [ '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' => '*'], ], ], ], ], ], 'ModifyTenantSecurityIpGroup' => [ 'summary' => 'You can call this operation to modify the information on the whitelist group of the tenant.', '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' => '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' => 'The returned result of the request.', 'type' => 'object', 'properties' => [ '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.***.*.*"]'], ], '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', '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' => 'InstanceId', 'in' => 'formData', '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' => 'The ID of the region. ', 'description' => 'Example 1', 'type' => 'object', 'properties' => [ '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' => '*'], ], ], ], ], ], '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' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', '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.', 'description' => ''], ], ], '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'], ], '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' => 'update'], 'parameters' => [ [ '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' => 'User type', 'description' => 'The type of the user account. Valid values: `Normal` and `Admin`.', 'type' => 'string', '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' => 'The list of database accounts in the tenant. ', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'TenantUser' => [ 'title' => 'The name of the account. ', 'description' => 'Information about the database account in the tenant.', 'type' => 'object', 'properties' => [ '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' => '账号具备的数据库权限信息列表。', ], 'UserName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'pay_test', 'title' => ''], 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 't4pnum****', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', 'title' => ''], ], 'example' => '', ], ], ], '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'], ], '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' => 'update'], 'parameters' => [ [ '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 list of database accounts in the tenant. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pay_test'], ], [ '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' => 'ob2mr3oae0****'], ], [ 'name' => 'UserStatus', 'in' => 'formData', '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' => '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' => [ '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' => [ [ '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', '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' => 'The response object.', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ErrorDetail' => [ 'title' => '', 'description' => 'The error details object.', '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: FATAL, ERROR, WARNING, and CRITICAL.', 'type' => 'string', 'example' => 'ERROR'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'A system error occurred.', 'title' => ''], 'ExtraContext' => [ 'description' => 'The data for populating placeholders in the Message.', 'type' => 'object', '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' => 'The data for populating placeholders for the message identified by MessageMcmsKey.', 'type' => 'object', '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' => '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 suggested resolution.', 'type' => 'string', 'example' => 'Contact the administrator. ', 'title' => ''], 'ProposalMcmsKey' => ['description' => 'The key of the proposal.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'ProposalMcmsContext' => [ 'description' => 'The context of the proposal.', 'type' => 'object', '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' => '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\\": \\"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' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the worker instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'g_abcdefj***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', 'description' => 'The API response.', 'type' => 'object', 'properties' => [ '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' => [ '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' => '', ], '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' => '', ], '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' => '', ], '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], '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****', 'title' => ''], ], [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], 'ResumeProject' => [ 'summary' => 'Resumes a data migration or data synchronization task.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of a data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OmsApiReturnResult', 'description' => 'The response object.', '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 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' => ''], ], '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 \\"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' => [], ], 'RetryProjectModifyRecords' => [ 'summary' => 'This API retries a modification by its record ID.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The modification record ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '', ], ], ], '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ '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' => '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' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'l_****'."\n"], ], ], '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 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' => '', ], ], ], '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' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data migration or synchronization task.', 'type' => 'string', 'required' => true, 'example' => 'np_4w3a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ '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.'."\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 \\"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' => [], ], 'StopProjectModifyRecords' => [ 'summary' => 'This API stops a modification operation based on the modification record\'s ID.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the modification record.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '344000005'], ], ], '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' => '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' => '', ], ], ], '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'l_****'], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '', ], ], ], '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' => [ [ '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' => '', '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', 'title' => ''], ], ], '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', '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' => '', ], ], ], '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' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The ID of the data migration or data synchronization project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'np_fe****'], ], [ 'name' => 'CommonTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '', ], ], [ 'name' => 'FullTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The settings for full data transfer.', 'type' => 'object', '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' => ''], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'IncrTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '', ], ], [ 'name' => 'ReverseIncrTransferConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ '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' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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' => '', ], ], ], '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'], ], 'createdAt' => '2024-09-19T11:03:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeRestorableTenants'], ], 'createdAt' => '2024-09-02T02:47:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2024-08-19T06:11:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeTenantMetrics'], ], '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'], ], 'createdAt' => '2024-08-01T13:31:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], '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' => '*'], ], ], ], [ 'apiName' => 'CreateTag', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '*'], ], ], ], [ 'apiName' => 'DescribeSecurityIpGroups', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeSecurityIpGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantUsers', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeProxyService', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeProxyService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeOasTopSQLList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeOasTopSQLList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTagValueName', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTagValueName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSqlAuditStat', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeSqlAuditStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProjectFullVerifyResult', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oceanbase:ListProjectFullVerifyResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeNodeMetrics', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeNodeMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StopProjectModifyRecords', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:StopProjectModifyRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseWorkerInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:ReleaseWorkerInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceTenantModes', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceTenantModes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseProject', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:ReleaseProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDataSource', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParameters', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeParameters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateRdsPostgreSQLDataSource', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateRdsPostgreSQLDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceSpec', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyInstanceSpec', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTenantSecurityIpGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTenantSecurityIpGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceCreatableZone', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceCreatableZone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '*'], ], ], ], [ 'apiName' => 'DescribeOasSlowSQLList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeOasSlowSQLList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProjectModifyRecords', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oceanbase:ListProjectModifyRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'CreateBackupSetDownloadLink', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateBackupSetDownloadLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeOutlineBinding', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeOutlineBinding', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDataBackupSet', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeDataBackupSet', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceSSL', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceSSL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTenantUser', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTenantUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteTag', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSessionList', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeSessionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteSecurityIpGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteSecurityIpGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSecurityIpGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateSecurityIpGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRestorableTenants', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeRestorableTenants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteTenantUsers', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteTenantUsers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTenant', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTenant', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceSummary', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTenantUserDescription', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTenantUserDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTenantSecurityIpGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTenantSecurityIpGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAnomalySQLList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oceanbase:DescribeAnomalySQLList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDatabases', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeDatabases', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '*'], ], ], ], [ 'apiName' => 'DescribeSampleSqlRawTexts', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeSampleSqlRawTexts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceAvailableZones', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceAvailableZones', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantUserRoles', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantUserRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSlowSQLHistoryList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeSlowSQLHistoryList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeOasAnomalySQLList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeOasAnomalySQLList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAvailableMemResource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeAvailableMemResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifySecurityIps', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifySecurityIps', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}/*'], ], ], ], [ '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}/*'], ], ], ], [ 'apiName' => 'DescribeTagValues', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTagValues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTenantPrimaryZone', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTenantPrimaryZone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantEncryption', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantEncryption', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTagName', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTagName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceSecurityConfigs', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceSecurityConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceTags', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantMetrics', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSQLTuningAdvices', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeSQLTuningAdvices', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantSecurityIpGroups', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantSecurityIpGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceTags', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyInstanceTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantSecurityConfigs', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantSecurityConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTenantTags', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeTenantTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '*'], ], ], ], [ 'apiName' => 'DeleteProject', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTenantReadOnlyConnection', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTenantReadOnlyConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParametersHistory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeParametersHistory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteTenants', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oceanbase:DeleteTenants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTenantUserRoles', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:ModifyTenantUserRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSQLPlans', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeSQLPlans', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelProjectModifyRecord', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:CancelProjectModifyRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceTopology', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeInstanceTopology', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTopSQLList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oceanbase:DescribeTopSQLList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRecommendIndex', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeRecommendIndex', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StopProjectsByLabel', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:StopProjectsByLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveStandbyInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:RemoveStandbyInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RetryProjectModifyRecords', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oceanbase:RetryProjectModifyRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSQLDetails', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oceanbase:DescribeSQLDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTagValue', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oceanbase:CreateTagValue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OceanBase', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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' => '*'], ], ], ], ], '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/*'], ], ], ];